diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json index 4d896dc6a..c0d43a3db 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions/api.github.com/api.github.com.2022-11-28.json @@ -2074,263 +2074,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", @@ -2516,186 +2259,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", @@ -9252,6 +8815,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -18013,57 +17579,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "value_type": { - "type": "string", - "example": "single_select", - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property" - }, - "required": { - "type": "boolean", - "description": "Whether the property is required." - }, - "default_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "nullable": true, - "description": "Default value of the property" - }, - "description": { - "type": "string", - "nullable": true, - "description": "Short description of the property" - }, - "allowed_values": { - "type": "array", - "items": { - "type": "string", - "maxLength": 75 - }, - "maxItems": 200, - "nullable": true, - "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": { @@ -18874,7 +18390,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ], "default": "branch" }, @@ -19203,7 +18720,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "enforcement": { @@ -28769,6 +28287,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -65804,6 +65325,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -94447,780 +93971,6 @@ "name" ] }, - "nullable-organization-simple": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ], - "nullable": true - }, - "nullable-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", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], - "nullable": true - }, - "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", - "nullable": true - }, - "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", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "$ref": "#/components/schemas/nullable-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", - "example": "disabled | all" - }, - "group_id": { - "nullable": true, - "type": "string", - "example": "62ab9291-fae2-468e-974b-7e45096d5021" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "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": { - "$ref": "#/components/schemas/nullable-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" - } - ], - "nullable": true - }, - "pending_cancellation_date": { - "type": "string", - "format": "date", - "nullable": true, - "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", - "format": "date-time", - "nullable": true, - "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." - }, - "last_activity_editor": { - "type": "string", - "nullable": true, - "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", - "description": "Usage metrics for Copilot editor code completions in the IDE.", - "nullable": true, - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." - }, - "languages": { - "type": "array", - "description": "Code completion metrics for active languages.", - "items": { - "type": "object", - "description": "Usage metrics for a given language for the given editor for Copilot code completions.", - "properties": { - "name": { - "type": "string", - "description": "Name of the language used for Copilot code completion suggestions." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." - } - } - } - }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot code completion metrics for active editors.", - "additionalProperties": true, - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the 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", - "nullable": true, - "description": "The training date for the custom model." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." - }, - "languages": { - "type": "array", - "description": "Code completion metrics for active languages, for the given editor.", - "items": { - "type": "object", - "description": "Usage metrics for a given language for the given editor for Copilot code completions.", - "properties": { - "name": { - "type": "string", - "description": "Name of the language used for Copilot code completion suggestions, for the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." - }, - "total_code_suggestions": { - "type": "integer", - "description": "The number of Copilot code suggestions generated for the given editor, for the given language." - }, - "total_code_acceptances": { - "type": "integer", - "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." - }, - "total_code_lines_suggested": { - "type": "integer", - "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." - }, - "total_code_lines_accepted": { - "type": "integer", - "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." - } - } - } - } - } - } - } - } - } - } - } - }, - "copilot-ide-chat": { - "type": "object", - "description": "Usage metrics for Copilot Chat in the IDE.", - "nullable": true, - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat in the IDE." - }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot Chat metrics, for active editors.", - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the specified editor." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the 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", - "nullable": true, - "description": "The training date for the custom model." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the given editor and model." - }, - "total_chats": { - "type": "integer", - "description": "The total number of chats initiated by users in the given editor and model." - }, - "total_chat_insertion_events": { - "type": "integer", - "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." - }, - "total_chat_copy_events": { - "type": "integer", - "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." - } - } - } - } - } - } - } - } - }, - "copilot-dotcom-chat": { - "type": "object", - "description": "Usage metrics for Copilot Chat in github.com", - "nullable": true, - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once." - }, - "models": { - "type": "array", - "description": "List of model metrics for a custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the 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", - "description": "The training date for the custom model (if applicable).", - "nullable": true - }, - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." - }, - "total_chats": { - "type": "integer", - "description": "Total number of chats initiated by users on github.com." - } - } - } - } - } - }, - "copilot-dotcom-pull-requests": { - "type": "object", - "description": "Usage metrics for Copilot for pull requests.", - "nullable": true, - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." - }, - "repositories": { - "type": "array", - "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Repository name" - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the 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", - "nullable": true, - "description": "The training date for the custom model." - }, - "total_pr_summaries_created": { - "type": "integer", - "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." - } - } - } - } - } - } - } - } - }, - "copilot-usage-metrics-day": { - "title": "Copilot Usage Metrics", - "description": "Copilot usage metrics for a given day.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date", - "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." - }, - "total_active_users": { - "type": "integer", - "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." - }, - "total_engaged_users": { - "type": "integer", - "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." - }, - "copilot_ide_code_completions": { - "$ref": "#/components/schemas/copilot-ide-code-completions" - }, - "copilot_ide_chat": { - "$ref": "#/components/schemas/copilot-ide-chat" - }, - "copilot_dotcom_chat": { - "$ref": "#/components/schemas/copilot-dotcom-chat" - }, - "copilot_dotcom_pull_requests": { - "$ref": "#/components/schemas/copilot-dotcom-pull-requests" - } - }, - "required": [ - "date" - ], - "additionalProperties": true - }, - "copilot-usage-metrics": { - "title": "Copilot Usage Metrics", - "description": "Summary of Copilot usage.", - "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", - "description": "Breakdown of Copilot code completions usage by language and editor", - "nullable": true, - "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.", @@ -96042,6 +94792,11 @@ "push_protection_bypass_request_reviewer": { "$ref": "#/components/schemas/nullable-simple-user" }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -100935,6 +99690,780 @@ ], "additionalProperties": true }, + "nullable-organization-simple": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ], + "nullable": true + }, + "nullable-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", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true + }, + "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", + "nullable": true + }, + "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", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "$ref": "#/components/schemas/nullable-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", + "example": "disabled | all" + }, + "group_id": { + "nullable": true, + "type": "string", + "example": "62ab9291-fae2-468e-974b-7e45096d5021" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "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": { + "$ref": "#/components/schemas/nullable-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" + } + ], + "nullable": true + }, + "pending_cancellation_date": { + "type": "string", + "format": "date", + "nullable": true, + "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", + "format": "date-time", + "nullable": true, + "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." + }, + "last_activity_editor": { + "type": "string", + "nullable": true, + "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", + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "nullable": true, + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the 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", + "nullable": true, + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } + }, + "copilot-ide-chat": { + "type": "object", + "description": "Usage metrics for Copilot Chat in the IDE.", + "nullable": true, + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the 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", + "nullable": true, + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot-dotcom-chat": { + "type": "object", + "description": "Usage metrics for Copilot Chat in github.com", + "nullable": true, + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the 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", + "description": "The training date for the custom model (if applicable).", + "nullable": true + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot-dotcom-pull-requests": { + "type": "object", + "description": "Usage metrics for Copilot for pull requests.", + "nullable": true, + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the 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", + "nullable": true, + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." + } + } + } + } + } + } + } + } + }, + "copilot-usage-metrics-day": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "$ref": "#/components/schemas/copilot-ide-code-completions" + }, + "copilot_ide_chat": { + "$ref": "#/components/schemas/copilot-ide-chat" + }, + "copilot_dotcom_chat": { + "$ref": "#/components/schemas/copilot-dotcom-chat" + }, + "copilot_dotcom_pull_requests": { + "$ref": "#/components/schemas/copilot-dotcom-pull-requests" + } + }, + "required": [ + "date" + ], + "additionalProperties": true + }, + "copilot-usage-metrics": { + "title": "Copilot Usage Metrics", + "description": "Summary of Copilot usage.", + "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", + "description": "Breakdown of Copilot code completions usage by language and editor", + "nullable": true, + "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.", @@ -102900,6 +102429,61 @@ "value_type" ] }, + "custom-property-set-payload": { + "title": "Custom Property Set Payload", + "description": "Custom property set payload", + "type": "object", + "properties": { + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "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", @@ -104299,7 +103883,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", @@ -104586,6 +104170,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." @@ -105281,7 +104872,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -105289,7 +104881,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -107523,6 +107116,9 @@ }, "dependency_snapshots": { "$ref": "#/components/schemas/rate-limit" + }, + "code_scanning_autofix": { + "$ref": "#/components/schemas/rate-limit" } }, "required": [ @@ -120123,6 +119719,11 @@ "push_protection_bypass_request_reviewer": { "$ref": "#/components/schemas/nullable-simple-user" }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -136642,6 +136243,11 @@ "push_protection_bypass_request_reviewer": { "$ref": "#/components/schemas/nullable-simple-user" }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -265598,322 +265204,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": [ { @@ -266445,6 +265735,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", @@ -266536,6 +265827,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, @@ -266545,90 +265837,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": [ { @@ -270359,6 +269567,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, @@ -274203,6 +273727,12 @@ "used": 0, "remaining": 10, "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 } }, "rate": { @@ -286963,6 +286493,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", @@ -286987,6 +286518,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, @@ -287014,6 +286546,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, @@ -287059,6 +286592,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", @@ -294028,24 +293562,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.", @@ -294499,6 +294015,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.", @@ -295498,26 +295023,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": { @@ -295597,6 +295102,16 @@ } } }, + "internal_error": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, "conflict": { "description": "Conflict", "content": { @@ -295698,6 +295213,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/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml index d4994a94c..c9c379597 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions/api.github.com/api.github.com.2022-11-28.yaml @@ -1427,225 +1427,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 @@ -1757,163 +1538,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 @@ -6742,6 +6366,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" @@ -13074,44 +12700,7 @@ paths: content: application/json: schema: - type: object - properties: - value_type: - type: string - example: single_select - enum: - - string - - single_select - - multi_select - - true_false - description: The type of the value for the property - required: - type: boolean - description: Whether the property is required. - default_value: - oneOf: - - type: string - - type: array - items: - type: string - nullable: true - description: Default value of the property - description: - type: string - nullable: true - description: Short description of the property - allowed_values: - type: array - items: - type: string - maxLength: 75 - maxItems: 200 - nullable: true - 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: @@ -13746,6 +13335,7 @@ paths: - branch - tag - push + - repository default: branch enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" @@ -13962,6 +13552,7 @@ paths: - branch - tag - push + - repository enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" bypass_actors: @@ -20814,6 +20405,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" @@ -47766,6 +47359,8 @@ paths: "$ref": "#/components/schemas/sigstore-bundle-0" repository_id: type: integer + bundle_url: + type: string examples: default: value: @@ -68526,671 +68121,6 @@ components: - html_url - key - name - nullable-organization-simple: - title: Organization Simple - description: A GitHub organization. - type: object - properties: - login: - type: string - example: github - id: - type: integer - example: 1 - node_id: - type: string - example: MDEyOk9yZ2FuaXphdGlvbjE= - url: - type: string - format: uri - example: https://api.github.com/orgs/github - repos_url: - type: string - format: uri - example: https://api.github.com/orgs/github/repos - events_url: - type: string - format: uri - example: https://api.github.com/orgs/github/events - hooks_url: - type: string - example: https://api.github.com/orgs/github/hooks - issues_url: - type: string - example: https://api.github.com/orgs/github/issues - members_url: - type: string - example: https://api.github.com/orgs/github/members{/member} - public_members_url: - type: string - example: https://api.github.com/orgs/github/public_members{/member} - avatar_url: - type: string - example: https://github.com/images/error/octocat_happy.gif - description: - type: string - example: A great organization - nullable: true - required: - - login - - url - - id - - node_id - - repos_url - - events_url - - hooks_url - - issues_url - - members_url - - public_members_url - - avatar_url - - description - nullable: true - nullable-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 - example: 1 - node_id: - type: string - example: MDQ6VGVhbTE= - url: - description: URL for the team - type: string - format: uri - example: https://api.github.com/organizations/1/team/1 - members_url: - type: string - example: https://api.github.com/organizations/1/team/1/members{/member} - name: - description: Name of the team - type: string - example: Justice League - description: - description: Description of the team - type: string - nullable: true - example: A great team. - permission: - description: Permission that the team will have for its repositories - type: string - example: admin - privacy: - description: The level of privacy this team should have - type: string - example: closed - notification_setting: - description: The notification setting the team has set - type: string - example: notifications_enabled - html_url: - type: string - format: uri - example: https://github.com/orgs/rails/teams/core - repositories_url: - type: string - format: uri - example: https://api.github.com/organizations/1/team/1/repos - slug: - type: string - example: justice-league - ldap_dn: - description: Distinguished Name (DN) that team maps to within LDAP environment - example: uid=example,ou=users,dc=github,dc=com - type: string - required: - - id - - node_id - - url - - members_url - - name - - description - - permission - - html_url - - repositories_url - - slug - nullable: true - 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 - nullable: true - 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 - example: https://github.com/orgs/rails/teams/core - members_url: - type: string - repositories_url: - type: string - format: uri - parent: - "$ref": "#/components/schemas/nullable-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 - example: disabled | all - group_id: - nullable: true - type: string - example: 62ab9291-fae2-468e-974b-7e45096d5021 - html_url: - type: string - format: uri - example: 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: - "$ref": "#/components/schemas/nullable-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" - nullable: true - pending_cancellation_date: - type: string - format: date - nullable: true - 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 - format: date-time - nullable: true - description: Timestamp of user's last GitHub Copilot activity, in ISO 8601 - format. - last_activity_editor: - type: string - nullable: true - 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 - description: Usage metrics for Copilot editor code completions in the IDE. - nullable: true - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: Number of users who accepted at least one Copilot code suggestion, - across all active editors. Includes both full and partial acceptances. - languages: - type: array - description: Code completion metrics for active languages. - items: - type: object - description: Usage metrics for a given language for the given editor for - Copilot code completions. - properties: - name: - type: string - description: Name of the language used for Copilot code completion - suggestions. - total_engaged_users: - type: integer - description: Number of users who accepted at least one Copilot code - completion suggestion for the given language. Includes both full - and partial acceptances. - editors: - type: array - items: - type: object - description: Copilot code completion metrics for active editors. - additionalProperties: true - properties: - name: - type: string - description: Name of the given editor. - total_engaged_users: - type: integer - description: Number of users who accepted at least one Copilot code - completion suggestion for the given editor. Includes both full and - partial acceptances. - models: - type: array - description: List of model metrics for custom models and the default - model. - items: - type: object - properties: - name: - type: string - description: Name of the 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 - nullable: true - description: The training date for the custom model. - total_engaged_users: - type: integer - description: Number of users who accepted at least one Copilot - code completion suggestion for the given editor, for the given - language and model. Includes both full and partial acceptances. - languages: - type: array - description: Code completion metrics for active languages, for - the given editor. - items: - type: object - description: Usage metrics for a given language for the given - editor for Copilot code completions. - properties: - name: - type: string - description: Name of the language used for Copilot code - completion suggestions, for the given editor. - total_engaged_users: - type: integer - description: Number of users who accepted at least one - Copilot code completion suggestion for the given editor, - for the given language. Includes both full and partial - acceptances. - total_code_suggestions: - type: integer - description: The number of Copilot code suggestions generated - for the given editor, for the given language. - total_code_acceptances: - type: integer - description: The number of Copilot code suggestions accepted - for the given editor, for the given language. Includes - both full and partial acceptances. - total_code_lines_suggested: - type: integer - description: The number of lines of code suggested by - Copilot code completions for the given editor, for the - given language. - total_code_lines_accepted: - type: integer - description: The number of lines of code accepted from - Copilot code suggestions for the given editor, for the - given language. - copilot-ide-chat: - type: object - description: Usage metrics for Copilot Chat in the IDE. - nullable: true - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: Total number of users who prompted Copilot Chat in the IDE. - editors: - type: array - items: - type: object - description: Copilot Chat metrics, for active editors. - properties: - name: - type: string - description: Name of the given editor. - total_engaged_users: - type: integer - description: The number of users who prompted Copilot Chat in the - specified editor. - models: - type: array - description: List of model metrics for custom models and the default - model. - items: - type: object - properties: - name: - type: string - description: Name of the 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 - nullable: true - description: The training date for the custom model. - total_engaged_users: - type: integer - description: The number of users who prompted Copilot Chat in - the given editor and model. - total_chats: - type: integer - description: The total number of chats initiated by users in - the given editor and model. - total_chat_insertion_events: - type: integer - description: The number of times users accepted a code suggestion - from Copilot Chat using the 'Insert Code' UI element, for - the given editor. - total_chat_copy_events: - type: integer - description: The number of times users copied a code suggestion - from Copilot Chat using the keyboard, or the 'Copy' UI element, - for the given editor. - copilot-dotcom-chat: - type: object - description: Usage metrics for Copilot Chat in github.com - nullable: true - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: Total number of users who prompted Copilot Chat on github.com - at least once. - models: - type: array - description: List of model metrics for a custom models and the default model. - items: - type: object - properties: - name: - type: string - description: Name of the 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 - description: The training date for the custom model (if applicable). - nullable: true - total_engaged_users: - type: integer - description: Total number of users who prompted Copilot Chat on github.com - at least once for each model. - total_chats: - type: integer - description: Total number of chats initiated by users on github.com. - copilot-dotcom-pull-requests: - type: object - description: Usage metrics for Copilot for pull requests. - nullable: true - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: The number of users who used Copilot for Pull Requests on github.com - to generate a pull request summary at least once. - repositories: - type: array - description: Repositories in which users used Copilot for Pull Requests - to generate pull request summaries - items: - type: object - properties: - name: - type: string - description: Repository name - total_engaged_users: - type: integer - description: The number of users who generated pull request summaries - using Copilot for Pull Requests in the given repository. - models: - type: array - description: List of model metrics for custom models and the default - model. - items: - type: object - properties: - name: - type: string - description: Name of the 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 - nullable: true - description: The training date for the custom model. - total_pr_summaries_created: - type: integer - description: The number of pull request summaries generated - using Copilot for Pull Requests in the given repository. - total_engaged_users: - type: integer - description: The number of users who generated pull request - summaries using Copilot for Pull Requests in the given repository - and model. - copilot-usage-metrics-day: - title: Copilot Usage Metrics - description: Copilot usage metrics for a given day. - type: object - properties: - date: - type: string - format: date - description: The date for which the usage metrics are aggregated, in `YYYY-MM-DD` - format. - total_active_users: - type: integer - description: The total number of Copilot users with activity belonging to - any Copilot feature, globally, for the given day. Includes passive activity - such as receiving a code suggestion, as well as engagement activity such - as accepting a code suggestion or prompting chat. Does not include authentication - events. Is not limited to the individual features detailed on the endpoint. - total_engaged_users: - type: integer - description: The total number of Copilot users who engaged with any Copilot - feature, for the given day. Examples include but are not limited to accepting - a code suggestion, prompting Copilot chat, or triggering a PR Summary. - Does not include authentication events. Is not limited to the individual - features detailed on the endpoint. - copilot_ide_code_completions: - "$ref": "#/components/schemas/copilot-ide-code-completions" - copilot_ide_chat: - "$ref": "#/components/schemas/copilot-ide-chat" - copilot_dotcom_chat: - "$ref": "#/components/schemas/copilot-dotcom-chat" - copilot_dotcom_pull_requests: - "$ref": "#/components/schemas/copilot-dotcom-pull-requests" - required: - - date - additionalProperties: true - copilot-usage-metrics: - title: Copilot Usage Metrics - description: Summary of Copilot usage. - 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 - description: Breakdown of Copilot code completions usage by language and - editor - nullable: true - 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. @@ -69890,6 +68820,10 @@ components: nullable: true push_protection_bypass_request_reviewer: "$ref": "#/components/schemas/nullable-simple-user" + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection bypass. + nullable: true push_protection_bypass_request_comment: type: string description: An optional comment when requesting a push protection bypass. @@ -73747,6 +72681,671 @@ components: - public_code_suggestions - seat_management_setting additionalProperties: true + nullable-organization-simple: + title: Organization Simple + description: A GitHub organization. + type: object + properties: + login: + type: string + example: github + id: + type: integer + example: 1 + node_id: + type: string + example: MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + example: https://api.github.com/orgs/github + repos_url: + type: string + format: uri + example: https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + example: https://api.github.com/orgs/github/events + hooks_url: + type: string + example: https://api.github.com/orgs/github/hooks + issues_url: + type: string + example: https://api.github.com/orgs/github/issues + members_url: + type: string + example: https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + example: https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + example: https://github.com/images/error/octocat_happy.gif + description: + type: string + example: A great organization + nullable: true + required: + - login + - url + - id + - node_id + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url + - description + nullable: true + nullable-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 + example: 1 + node_id: + type: string + example: MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + example: https://api.github.com/organizations/1/team/1 + members_url: + type: string + example: https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + example: Justice League + description: + description: Description of the team + type: string + nullable: true + example: A great team. + permission: + description: Permission that the team will have for its repositories + type: string + example: admin + privacy: + description: The level of privacy this team should have + type: string + example: closed + notification_setting: + description: The notification setting the team has set + type: string + example: notifications_enabled + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/1/repos + slug: + type: string + example: justice-league + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + example: uid=example,ou=users,dc=github,dc=com + type: string + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + nullable: true + 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 + nullable: true + 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 + example: https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + parent: + "$ref": "#/components/schemas/nullable-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 + example: disabled | all + group_id: + nullable: true + type: string + example: 62ab9291-fae2-468e-974b-7e45096d5021 + html_url: + type: string + format: uri + example: 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: + "$ref": "#/components/schemas/nullable-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" + nullable: true + pending_cancellation_date: + type: string + format: date + nullable: true + 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 + format: date-time + nullable: true + description: Timestamp of user's last GitHub Copilot activity, in ISO 8601 + format. + last_activity_editor: + type: string + nullable: true + 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 + description: Usage metrics for Copilot editor code completions in the IDE. + nullable: true + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code suggestion, + across all active editors. Includes both full and partial acceptances. + languages: + type: array + description: Code completion metrics for active languages. + items: + type: object + description: Usage metrics for a given language for the given editor for + Copilot code completions. + properties: + name: + type: string + description: Name of the language used for Copilot code completion + suggestions. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code + completion suggestion for the given language. Includes both full + and partial acceptances. + editors: + type: array + items: + type: object + description: Copilot code completion metrics for active editors. + additionalProperties: true + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code + completion suggestion for the given editor. Includes both full and + partial acceptances. + models: + type: array + description: List of model metrics for custom models and the default + model. + items: + type: object + properties: + name: + type: string + description: Name of the 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 + nullable: true + description: The training date for the custom model. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot + code completion suggestion for the given editor, for the given + language and model. Includes both full and partial acceptances. + languages: + type: array + description: Code completion metrics for active languages, for + the given editor. + items: + type: object + description: Usage metrics for a given language for the given + editor for Copilot code completions. + properties: + name: + type: string + description: Name of the language used for Copilot code + completion suggestions, for the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted at least one + Copilot code completion suggestion for the given editor, + for the given language. Includes both full and partial + acceptances. + total_code_suggestions: + type: integer + description: The number of Copilot code suggestions generated + for the given editor, for the given language. + total_code_acceptances: + type: integer + description: The number of Copilot code suggestions accepted + for the given editor, for the given language. Includes + both full and partial acceptances. + total_code_lines_suggested: + type: integer + description: The number of lines of code suggested by + Copilot code completions for the given editor, for the + given language. + total_code_lines_accepted: + type: integer + description: The number of lines of code accepted from + Copilot code suggestions for the given editor, for the + given language. + copilot-ide-chat: + type: object + description: Usage metrics for Copilot Chat in the IDE. + nullable: true + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat in the IDE. + editors: + type: array + items: + type: object + description: Copilot Chat metrics, for active editors. + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: The number of users who prompted Copilot Chat in the + specified editor. + models: + type: array + description: List of model metrics for custom models and the default + model. + items: + type: object + properties: + name: + type: string + description: Name of the 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 + nullable: true + description: The training date for the custom model. + total_engaged_users: + type: integer + description: The number of users who prompted Copilot Chat in + the given editor and model. + total_chats: + type: integer + description: The total number of chats initiated by users in + the given editor and model. + total_chat_insertion_events: + type: integer + description: The number of times users accepted a code suggestion + from Copilot Chat using the 'Insert Code' UI element, for + the given editor. + total_chat_copy_events: + type: integer + description: The number of times users copied a code suggestion + from Copilot Chat using the keyboard, or the 'Copy' UI element, + for the given editor. + copilot-dotcom-chat: + type: object + description: Usage metrics for Copilot Chat in github.com + nullable: true + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat on github.com + at least once. + models: + type: array + description: List of model metrics for a custom models and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the 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 + description: The training date for the custom model (if applicable). + nullable: true + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat on github.com + at least once for each model. + total_chats: + type: integer + description: Total number of chats initiated by users on github.com. + copilot-dotcom-pull-requests: + type: object + description: Usage metrics for Copilot for pull requests. + nullable: true + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: The number of users who used Copilot for Pull Requests on github.com + to generate a pull request summary at least once. + repositories: + type: array + description: Repositories in which users used Copilot for Pull Requests + to generate pull request summaries + items: + type: object + properties: + name: + type: string + description: Repository name + total_engaged_users: + type: integer + description: The number of users who generated pull request summaries + using Copilot for Pull Requests in the given repository. + models: + type: array + description: List of model metrics for custom models and the default + model. + items: + type: object + properties: + name: + type: string + description: Name of the 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 + nullable: true + description: The training date for the custom model. + total_pr_summaries_created: + type: integer + description: The number of pull request summaries generated + using Copilot for Pull Requests in the given repository. + total_engaged_users: + type: integer + description: The number of users who generated pull request + summaries using Copilot for Pull Requests in the given repository + and model. + copilot-usage-metrics-day: + title: Copilot Usage Metrics + description: Copilot usage metrics for a given day. + type: object + properties: + date: + type: string + format: date + description: The date for which the usage metrics are aggregated, in `YYYY-MM-DD` + format. + total_active_users: + type: integer + description: The total number of Copilot users with activity belonging to + any Copilot feature, globally, for the given day. Includes passive activity + such as receiving a code suggestion, as well as engagement activity such + as accepting a code suggestion or prompting chat. Does not include authentication + events. Is not limited to the individual features detailed on the endpoint. + total_engaged_users: + type: integer + description: The total number of Copilot users who engaged with any Copilot + feature, for the given day. Examples include but are not limited to accepting + a code suggestion, prompting Copilot chat, or triggering a PR Summary. + Does not include authentication events. Is not limited to the individual + features detailed on the endpoint. + copilot_ide_code_completions: + "$ref": "#/components/schemas/copilot-ide-code-completions" + copilot_ide_chat: + "$ref": "#/components/schemas/copilot-ide-chat" + copilot_dotcom_chat: + "$ref": "#/components/schemas/copilot-dotcom-chat" + copilot_dotcom_pull_requests: + "$ref": "#/components/schemas/copilot-dotcom-pull-requests" + required: + - date + additionalProperties: true + copilot-usage-metrics: + title: Copilot Usage Metrics + description: Summary of Copilot usage. + 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 + description: Breakdown of Copilot code completions usage by language and + editor + nullable: true + 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. @@ -75288,6 +74887,47 @@ 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 + example: single_select + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + nullable: true + description: Default value of the property + description: + type: string + nullable: true + description: Short description of the property + allowed_values: + type: array + items: + type: string + maxLength: 75 + maxItems: 200 + nullable: true + 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 @@ -76447,6 +76087,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 @@ -76664,6 +76305,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 @@ -77169,12 +76817,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 @@ -78933,6 +78583,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 @@ -88485,6 +88137,10 @@ components: nullable: true push_protection_bypass_request_reviewer: "$ref": "#/components/schemas/nullable-simple-user" + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection bypass. + nullable: true push_protection_bypass_request_comment: type: string description: An optional comment when requesting a push protection bypass. @@ -101135,6 +100791,10 @@ components: nullable: true push_protection_bypass_request_reviewer: "$ref": "#/components/schemas/nullable-simple-user" + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection bypass. + nullable: true push_protection_bypass_request_comment: type: string description: An optional comment when requesting a push protection bypass. @@ -198825,236 +198485,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 @@ -199503,6 +198933,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 @@ -199590,76 +199021,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' @@ -202895,6 +202263,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 @@ -206227,6 +205825,11 @@ components: used: 0 remaining: 10 reset: 1691591091 + code_scanning_autofix: + limit: 10 + used: 0 + remaining: 10 + reset: 1691591091 rate: limit: 5000 used: 1 @@ -217173,6 +216776,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 @@ -217195,6 +216799,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: @@ -217219,6 +216824,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: @@ -217261,6 +216867,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 @@ -223326,20 +222933,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. @@ -223721,6 +223314,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. @@ -224559,19 +224159,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: @@ -224621,6 +224208,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: @@ -224685,6 +224278,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/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index 4d896dc6a..c0d43a3db 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -2074,263 +2074,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", @@ -2516,186 +2259,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", @@ -9252,6 +8815,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -18013,57 +17579,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "value_type": { - "type": "string", - "example": "single_select", - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property" - }, - "required": { - "type": "boolean", - "description": "Whether the property is required." - }, - "default_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "nullable": true, - "description": "Default value of the property" - }, - "description": { - "type": "string", - "nullable": true, - "description": "Short description of the property" - }, - "allowed_values": { - "type": "array", - "items": { - "type": "string", - "maxLength": 75 - }, - "maxItems": 200, - "nullable": true, - "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": { @@ -18874,7 +18390,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ], "default": "branch" }, @@ -19203,7 +18720,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "enforcement": { @@ -28769,6 +28287,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -65804,6 +65325,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -94447,780 +93971,6 @@ "name" ] }, - "nullable-organization-simple": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ], - "nullable": true - }, - "nullable-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", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], - "nullable": true - }, - "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", - "nullable": true - }, - "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", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "$ref": "#/components/schemas/nullable-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", - "example": "disabled | all" - }, - "group_id": { - "nullable": true, - "type": "string", - "example": "62ab9291-fae2-468e-974b-7e45096d5021" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "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": { - "$ref": "#/components/schemas/nullable-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" - } - ], - "nullable": true - }, - "pending_cancellation_date": { - "type": "string", - "format": "date", - "nullable": true, - "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", - "format": "date-time", - "nullable": true, - "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." - }, - "last_activity_editor": { - "type": "string", - "nullable": true, - "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", - "description": "Usage metrics for Copilot editor code completions in the IDE.", - "nullable": true, - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." - }, - "languages": { - "type": "array", - "description": "Code completion metrics for active languages.", - "items": { - "type": "object", - "description": "Usage metrics for a given language for the given editor for Copilot code completions.", - "properties": { - "name": { - "type": "string", - "description": "Name of the language used for Copilot code completion suggestions." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." - } - } - } - }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot code completion metrics for active editors.", - "additionalProperties": true, - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the 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", - "nullable": true, - "description": "The training date for the custom model." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." - }, - "languages": { - "type": "array", - "description": "Code completion metrics for active languages, for the given editor.", - "items": { - "type": "object", - "description": "Usage metrics for a given language for the given editor for Copilot code completions.", - "properties": { - "name": { - "type": "string", - "description": "Name of the language used for Copilot code completion suggestions, for the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." - }, - "total_code_suggestions": { - "type": "integer", - "description": "The number of Copilot code suggestions generated for the given editor, for the given language." - }, - "total_code_acceptances": { - "type": "integer", - "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." - }, - "total_code_lines_suggested": { - "type": "integer", - "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." - }, - "total_code_lines_accepted": { - "type": "integer", - "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." - } - } - } - } - } - } - } - } - } - } - } - }, - "copilot-ide-chat": { - "type": "object", - "description": "Usage metrics for Copilot Chat in the IDE.", - "nullable": true, - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat in the IDE." - }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot Chat metrics, for active editors.", - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the specified editor." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the 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", - "nullable": true, - "description": "The training date for the custom model." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the given editor and model." - }, - "total_chats": { - "type": "integer", - "description": "The total number of chats initiated by users in the given editor and model." - }, - "total_chat_insertion_events": { - "type": "integer", - "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." - }, - "total_chat_copy_events": { - "type": "integer", - "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." - } - } - } - } - } - } - } - } - }, - "copilot-dotcom-chat": { - "type": "object", - "description": "Usage metrics for Copilot Chat in github.com", - "nullable": true, - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once." - }, - "models": { - "type": "array", - "description": "List of model metrics for a custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the 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", - "description": "The training date for the custom model (if applicable).", - "nullable": true - }, - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." - }, - "total_chats": { - "type": "integer", - "description": "Total number of chats initiated by users on github.com." - } - } - } - } - } - }, - "copilot-dotcom-pull-requests": { - "type": "object", - "description": "Usage metrics for Copilot for pull requests.", - "nullable": true, - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." - }, - "repositories": { - "type": "array", - "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Repository name" - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the 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", - "nullable": true, - "description": "The training date for the custom model." - }, - "total_pr_summaries_created": { - "type": "integer", - "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." - } - } - } - } - } - } - } - } - }, - "copilot-usage-metrics-day": { - "title": "Copilot Usage Metrics", - "description": "Copilot usage metrics for a given day.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date", - "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." - }, - "total_active_users": { - "type": "integer", - "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." - }, - "total_engaged_users": { - "type": "integer", - "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." - }, - "copilot_ide_code_completions": { - "$ref": "#/components/schemas/copilot-ide-code-completions" - }, - "copilot_ide_chat": { - "$ref": "#/components/schemas/copilot-ide-chat" - }, - "copilot_dotcom_chat": { - "$ref": "#/components/schemas/copilot-dotcom-chat" - }, - "copilot_dotcom_pull_requests": { - "$ref": "#/components/schemas/copilot-dotcom-pull-requests" - } - }, - "required": [ - "date" - ], - "additionalProperties": true - }, - "copilot-usage-metrics": { - "title": "Copilot Usage Metrics", - "description": "Summary of Copilot usage.", - "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", - "description": "Breakdown of Copilot code completions usage by language and editor", - "nullable": true, - "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.", @@ -96042,6 +94792,11 @@ "push_protection_bypass_request_reviewer": { "$ref": "#/components/schemas/nullable-simple-user" }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -100935,6 +99690,780 @@ ], "additionalProperties": true }, + "nullable-organization-simple": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ], + "nullable": true + }, + "nullable-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", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true + }, + "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", + "nullable": true + }, + "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", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "$ref": "#/components/schemas/nullable-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", + "example": "disabled | all" + }, + "group_id": { + "nullable": true, + "type": "string", + "example": "62ab9291-fae2-468e-974b-7e45096d5021" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "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": { + "$ref": "#/components/schemas/nullable-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" + } + ], + "nullable": true + }, + "pending_cancellation_date": { + "type": "string", + "format": "date", + "nullable": true, + "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", + "format": "date-time", + "nullable": true, + "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." + }, + "last_activity_editor": { + "type": "string", + "nullable": true, + "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", + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "nullable": true, + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the 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", + "nullable": true, + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } + }, + "copilot-ide-chat": { + "type": "object", + "description": "Usage metrics for Copilot Chat in the IDE.", + "nullable": true, + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the 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", + "nullable": true, + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot-dotcom-chat": { + "type": "object", + "description": "Usage metrics for Copilot Chat in github.com", + "nullable": true, + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the 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", + "description": "The training date for the custom model (if applicable).", + "nullable": true + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot-dotcom-pull-requests": { + "type": "object", + "description": "Usage metrics for Copilot for pull requests.", + "nullable": true, + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the 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", + "nullable": true, + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." + } + } + } + } + } + } + } + } + }, + "copilot-usage-metrics-day": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "$ref": "#/components/schemas/copilot-ide-code-completions" + }, + "copilot_ide_chat": { + "$ref": "#/components/schemas/copilot-ide-chat" + }, + "copilot_dotcom_chat": { + "$ref": "#/components/schemas/copilot-dotcom-chat" + }, + "copilot_dotcom_pull_requests": { + "$ref": "#/components/schemas/copilot-dotcom-pull-requests" + } + }, + "required": [ + "date" + ], + "additionalProperties": true + }, + "copilot-usage-metrics": { + "title": "Copilot Usage Metrics", + "description": "Summary of Copilot usage.", + "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", + "description": "Breakdown of Copilot code completions usage by language and editor", + "nullable": true, + "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.", @@ -102900,6 +102429,61 @@ "value_type" ] }, + "custom-property-set-payload": { + "title": "Custom Property Set Payload", + "description": "Custom property set payload", + "type": "object", + "properties": { + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "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", @@ -104299,7 +103883,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", @@ -104586,6 +104170,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." @@ -105281,7 +104872,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -105289,7 +104881,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -107523,6 +107116,9 @@ }, "dependency_snapshots": { "$ref": "#/components/schemas/rate-limit" + }, + "code_scanning_autofix": { + "$ref": "#/components/schemas/rate-limit" } }, "required": [ @@ -120123,6 +119719,11 @@ "push_protection_bypass_request_reviewer": { "$ref": "#/components/schemas/nullable-simple-user" }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -136642,6 +136243,11 @@ "push_protection_bypass_request_reviewer": { "$ref": "#/components/schemas/nullable-simple-user" }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -265598,322 +265204,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": [ { @@ -266445,6 +265735,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", @@ -266536,6 +265827,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, @@ -266545,90 +265837,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": [ { @@ -270359,6 +269567,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, @@ -274203,6 +273727,12 @@ "used": 0, "remaining": 10, "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 } }, "rate": { @@ -286963,6 +286493,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", @@ -286987,6 +286518,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, @@ -287014,6 +286546,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, @@ -287059,6 +286592,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", @@ -294028,24 +293562,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.", @@ -294499,6 +294015,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.", @@ -295498,26 +295023,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": { @@ -295597,6 +295102,16 @@ } } }, + "internal_error": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, "conflict": { "description": "Conflict", "content": { @@ -295698,6 +295213,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/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index d4994a94c..c9c379597 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -1427,225 +1427,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 @@ -1757,163 +1538,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 @@ -6742,6 +6366,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" @@ -13074,44 +12700,7 @@ paths: content: application/json: schema: - type: object - properties: - value_type: - type: string - example: single_select - enum: - - string - - single_select - - multi_select - - true_false - description: The type of the value for the property - required: - type: boolean - description: Whether the property is required. - default_value: - oneOf: - - type: string - - type: array - items: - type: string - nullable: true - description: Default value of the property - description: - type: string - nullable: true - description: Short description of the property - allowed_values: - type: array - items: - type: string - maxLength: 75 - maxItems: 200 - nullable: true - 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: @@ -13746,6 +13335,7 @@ paths: - branch - tag - push + - repository default: branch enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" @@ -13962,6 +13552,7 @@ paths: - branch - tag - push + - repository enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" bypass_actors: @@ -20814,6 +20405,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" @@ -47766,6 +47359,8 @@ paths: "$ref": "#/components/schemas/sigstore-bundle-0" repository_id: type: integer + bundle_url: + type: string examples: default: value: @@ -68526,671 +68121,6 @@ components: - html_url - key - name - nullable-organization-simple: - title: Organization Simple - description: A GitHub organization. - type: object - properties: - login: - type: string - example: github - id: - type: integer - example: 1 - node_id: - type: string - example: MDEyOk9yZ2FuaXphdGlvbjE= - url: - type: string - format: uri - example: https://api.github.com/orgs/github - repos_url: - type: string - format: uri - example: https://api.github.com/orgs/github/repos - events_url: - type: string - format: uri - example: https://api.github.com/orgs/github/events - hooks_url: - type: string - example: https://api.github.com/orgs/github/hooks - issues_url: - type: string - example: https://api.github.com/orgs/github/issues - members_url: - type: string - example: https://api.github.com/orgs/github/members{/member} - public_members_url: - type: string - example: https://api.github.com/orgs/github/public_members{/member} - avatar_url: - type: string - example: https://github.com/images/error/octocat_happy.gif - description: - type: string - example: A great organization - nullable: true - required: - - login - - url - - id - - node_id - - repos_url - - events_url - - hooks_url - - issues_url - - members_url - - public_members_url - - avatar_url - - description - nullable: true - nullable-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 - example: 1 - node_id: - type: string - example: MDQ6VGVhbTE= - url: - description: URL for the team - type: string - format: uri - example: https://api.github.com/organizations/1/team/1 - members_url: - type: string - example: https://api.github.com/organizations/1/team/1/members{/member} - name: - description: Name of the team - type: string - example: Justice League - description: - description: Description of the team - type: string - nullable: true - example: A great team. - permission: - description: Permission that the team will have for its repositories - type: string - example: admin - privacy: - description: The level of privacy this team should have - type: string - example: closed - notification_setting: - description: The notification setting the team has set - type: string - example: notifications_enabled - html_url: - type: string - format: uri - example: https://github.com/orgs/rails/teams/core - repositories_url: - type: string - format: uri - example: https://api.github.com/organizations/1/team/1/repos - slug: - type: string - example: justice-league - ldap_dn: - description: Distinguished Name (DN) that team maps to within LDAP environment - example: uid=example,ou=users,dc=github,dc=com - type: string - required: - - id - - node_id - - url - - members_url - - name - - description - - permission - - html_url - - repositories_url - - slug - nullable: true - 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 - nullable: true - 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 - example: https://github.com/orgs/rails/teams/core - members_url: - type: string - repositories_url: - type: string - format: uri - parent: - "$ref": "#/components/schemas/nullable-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 - example: disabled | all - group_id: - nullable: true - type: string - example: 62ab9291-fae2-468e-974b-7e45096d5021 - html_url: - type: string - format: uri - example: 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: - "$ref": "#/components/schemas/nullable-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" - nullable: true - pending_cancellation_date: - type: string - format: date - nullable: true - 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 - format: date-time - nullable: true - description: Timestamp of user's last GitHub Copilot activity, in ISO 8601 - format. - last_activity_editor: - type: string - nullable: true - 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 - description: Usage metrics for Copilot editor code completions in the IDE. - nullable: true - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: Number of users who accepted at least one Copilot code suggestion, - across all active editors. Includes both full and partial acceptances. - languages: - type: array - description: Code completion metrics for active languages. - items: - type: object - description: Usage metrics for a given language for the given editor for - Copilot code completions. - properties: - name: - type: string - description: Name of the language used for Copilot code completion - suggestions. - total_engaged_users: - type: integer - description: Number of users who accepted at least one Copilot code - completion suggestion for the given language. Includes both full - and partial acceptances. - editors: - type: array - items: - type: object - description: Copilot code completion metrics for active editors. - additionalProperties: true - properties: - name: - type: string - description: Name of the given editor. - total_engaged_users: - type: integer - description: Number of users who accepted at least one Copilot code - completion suggestion for the given editor. Includes both full and - partial acceptances. - models: - type: array - description: List of model metrics for custom models and the default - model. - items: - type: object - properties: - name: - type: string - description: Name of the 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 - nullable: true - description: The training date for the custom model. - total_engaged_users: - type: integer - description: Number of users who accepted at least one Copilot - code completion suggestion for the given editor, for the given - language and model. Includes both full and partial acceptances. - languages: - type: array - description: Code completion metrics for active languages, for - the given editor. - items: - type: object - description: Usage metrics for a given language for the given - editor for Copilot code completions. - properties: - name: - type: string - description: Name of the language used for Copilot code - completion suggestions, for the given editor. - total_engaged_users: - type: integer - description: Number of users who accepted at least one - Copilot code completion suggestion for the given editor, - for the given language. Includes both full and partial - acceptances. - total_code_suggestions: - type: integer - description: The number of Copilot code suggestions generated - for the given editor, for the given language. - total_code_acceptances: - type: integer - description: The number of Copilot code suggestions accepted - for the given editor, for the given language. Includes - both full and partial acceptances. - total_code_lines_suggested: - type: integer - description: The number of lines of code suggested by - Copilot code completions for the given editor, for the - given language. - total_code_lines_accepted: - type: integer - description: The number of lines of code accepted from - Copilot code suggestions for the given editor, for the - given language. - copilot-ide-chat: - type: object - description: Usage metrics for Copilot Chat in the IDE. - nullable: true - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: Total number of users who prompted Copilot Chat in the IDE. - editors: - type: array - items: - type: object - description: Copilot Chat metrics, for active editors. - properties: - name: - type: string - description: Name of the given editor. - total_engaged_users: - type: integer - description: The number of users who prompted Copilot Chat in the - specified editor. - models: - type: array - description: List of model metrics for custom models and the default - model. - items: - type: object - properties: - name: - type: string - description: Name of the 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 - nullable: true - description: The training date for the custom model. - total_engaged_users: - type: integer - description: The number of users who prompted Copilot Chat in - the given editor and model. - total_chats: - type: integer - description: The total number of chats initiated by users in - the given editor and model. - total_chat_insertion_events: - type: integer - description: The number of times users accepted a code suggestion - from Copilot Chat using the 'Insert Code' UI element, for - the given editor. - total_chat_copy_events: - type: integer - description: The number of times users copied a code suggestion - from Copilot Chat using the keyboard, or the 'Copy' UI element, - for the given editor. - copilot-dotcom-chat: - type: object - description: Usage metrics for Copilot Chat in github.com - nullable: true - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: Total number of users who prompted Copilot Chat on github.com - at least once. - models: - type: array - description: List of model metrics for a custom models and the default model. - items: - type: object - properties: - name: - type: string - description: Name of the 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 - description: The training date for the custom model (if applicable). - nullable: true - total_engaged_users: - type: integer - description: Total number of users who prompted Copilot Chat on github.com - at least once for each model. - total_chats: - type: integer - description: Total number of chats initiated by users on github.com. - copilot-dotcom-pull-requests: - type: object - description: Usage metrics for Copilot for pull requests. - nullable: true - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: The number of users who used Copilot for Pull Requests on github.com - to generate a pull request summary at least once. - repositories: - type: array - description: Repositories in which users used Copilot for Pull Requests - to generate pull request summaries - items: - type: object - properties: - name: - type: string - description: Repository name - total_engaged_users: - type: integer - description: The number of users who generated pull request summaries - using Copilot for Pull Requests in the given repository. - models: - type: array - description: List of model metrics for custom models and the default - model. - items: - type: object - properties: - name: - type: string - description: Name of the 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 - nullable: true - description: The training date for the custom model. - total_pr_summaries_created: - type: integer - description: The number of pull request summaries generated - using Copilot for Pull Requests in the given repository. - total_engaged_users: - type: integer - description: The number of users who generated pull request - summaries using Copilot for Pull Requests in the given repository - and model. - copilot-usage-metrics-day: - title: Copilot Usage Metrics - description: Copilot usage metrics for a given day. - type: object - properties: - date: - type: string - format: date - description: The date for which the usage metrics are aggregated, in `YYYY-MM-DD` - format. - total_active_users: - type: integer - description: The total number of Copilot users with activity belonging to - any Copilot feature, globally, for the given day. Includes passive activity - such as receiving a code suggestion, as well as engagement activity such - as accepting a code suggestion or prompting chat. Does not include authentication - events. Is not limited to the individual features detailed on the endpoint. - total_engaged_users: - type: integer - description: The total number of Copilot users who engaged with any Copilot - feature, for the given day. Examples include but are not limited to accepting - a code suggestion, prompting Copilot chat, or triggering a PR Summary. - Does not include authentication events. Is not limited to the individual - features detailed on the endpoint. - copilot_ide_code_completions: - "$ref": "#/components/schemas/copilot-ide-code-completions" - copilot_ide_chat: - "$ref": "#/components/schemas/copilot-ide-chat" - copilot_dotcom_chat: - "$ref": "#/components/schemas/copilot-dotcom-chat" - copilot_dotcom_pull_requests: - "$ref": "#/components/schemas/copilot-dotcom-pull-requests" - required: - - date - additionalProperties: true - copilot-usage-metrics: - title: Copilot Usage Metrics - description: Summary of Copilot usage. - 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 - description: Breakdown of Copilot code completions usage by language and - editor - nullable: true - 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. @@ -69890,6 +68820,10 @@ components: nullable: true push_protection_bypass_request_reviewer: "$ref": "#/components/schemas/nullable-simple-user" + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection bypass. + nullable: true push_protection_bypass_request_comment: type: string description: An optional comment when requesting a push protection bypass. @@ -73747,6 +72681,671 @@ components: - public_code_suggestions - seat_management_setting additionalProperties: true + nullable-organization-simple: + title: Organization Simple + description: A GitHub organization. + type: object + properties: + login: + type: string + example: github + id: + type: integer + example: 1 + node_id: + type: string + example: MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + example: https://api.github.com/orgs/github + repos_url: + type: string + format: uri + example: https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + example: https://api.github.com/orgs/github/events + hooks_url: + type: string + example: https://api.github.com/orgs/github/hooks + issues_url: + type: string + example: https://api.github.com/orgs/github/issues + members_url: + type: string + example: https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + example: https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + example: https://github.com/images/error/octocat_happy.gif + description: + type: string + example: A great organization + nullable: true + required: + - login + - url + - id + - node_id + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url + - description + nullable: true + nullable-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 + example: 1 + node_id: + type: string + example: MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + example: https://api.github.com/organizations/1/team/1 + members_url: + type: string + example: https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + example: Justice League + description: + description: Description of the team + type: string + nullable: true + example: A great team. + permission: + description: Permission that the team will have for its repositories + type: string + example: admin + privacy: + description: The level of privacy this team should have + type: string + example: closed + notification_setting: + description: The notification setting the team has set + type: string + example: notifications_enabled + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/1/repos + slug: + type: string + example: justice-league + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + example: uid=example,ou=users,dc=github,dc=com + type: string + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + nullable: true + 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 + nullable: true + 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 + example: https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + parent: + "$ref": "#/components/schemas/nullable-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 + example: disabled | all + group_id: + nullable: true + type: string + example: 62ab9291-fae2-468e-974b-7e45096d5021 + html_url: + type: string + format: uri + example: 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: + "$ref": "#/components/schemas/nullable-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" + nullable: true + pending_cancellation_date: + type: string + format: date + nullable: true + 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 + format: date-time + nullable: true + description: Timestamp of user's last GitHub Copilot activity, in ISO 8601 + format. + last_activity_editor: + type: string + nullable: true + 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 + description: Usage metrics for Copilot editor code completions in the IDE. + nullable: true + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code suggestion, + across all active editors. Includes both full and partial acceptances. + languages: + type: array + description: Code completion metrics for active languages. + items: + type: object + description: Usage metrics for a given language for the given editor for + Copilot code completions. + properties: + name: + type: string + description: Name of the language used for Copilot code completion + suggestions. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code + completion suggestion for the given language. Includes both full + and partial acceptances. + editors: + type: array + items: + type: object + description: Copilot code completion metrics for active editors. + additionalProperties: true + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code + completion suggestion for the given editor. Includes both full and + partial acceptances. + models: + type: array + description: List of model metrics for custom models and the default + model. + items: + type: object + properties: + name: + type: string + description: Name of the 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 + nullable: true + description: The training date for the custom model. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot + code completion suggestion for the given editor, for the given + language and model. Includes both full and partial acceptances. + languages: + type: array + description: Code completion metrics for active languages, for + the given editor. + items: + type: object + description: Usage metrics for a given language for the given + editor for Copilot code completions. + properties: + name: + type: string + description: Name of the language used for Copilot code + completion suggestions, for the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted at least one + Copilot code completion suggestion for the given editor, + for the given language. Includes both full and partial + acceptances. + total_code_suggestions: + type: integer + description: The number of Copilot code suggestions generated + for the given editor, for the given language. + total_code_acceptances: + type: integer + description: The number of Copilot code suggestions accepted + for the given editor, for the given language. Includes + both full and partial acceptances. + total_code_lines_suggested: + type: integer + description: The number of lines of code suggested by + Copilot code completions for the given editor, for the + given language. + total_code_lines_accepted: + type: integer + description: The number of lines of code accepted from + Copilot code suggestions for the given editor, for the + given language. + copilot-ide-chat: + type: object + description: Usage metrics for Copilot Chat in the IDE. + nullable: true + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat in the IDE. + editors: + type: array + items: + type: object + description: Copilot Chat metrics, for active editors. + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: The number of users who prompted Copilot Chat in the + specified editor. + models: + type: array + description: List of model metrics for custom models and the default + model. + items: + type: object + properties: + name: + type: string + description: Name of the 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 + nullable: true + description: The training date for the custom model. + total_engaged_users: + type: integer + description: The number of users who prompted Copilot Chat in + the given editor and model. + total_chats: + type: integer + description: The total number of chats initiated by users in + the given editor and model. + total_chat_insertion_events: + type: integer + description: The number of times users accepted a code suggestion + from Copilot Chat using the 'Insert Code' UI element, for + the given editor. + total_chat_copy_events: + type: integer + description: The number of times users copied a code suggestion + from Copilot Chat using the keyboard, or the 'Copy' UI element, + for the given editor. + copilot-dotcom-chat: + type: object + description: Usage metrics for Copilot Chat in github.com + nullable: true + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat on github.com + at least once. + models: + type: array + description: List of model metrics for a custom models and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the 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 + description: The training date for the custom model (if applicable). + nullable: true + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat on github.com + at least once for each model. + total_chats: + type: integer + description: Total number of chats initiated by users on github.com. + copilot-dotcom-pull-requests: + type: object + description: Usage metrics for Copilot for pull requests. + nullable: true + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: The number of users who used Copilot for Pull Requests on github.com + to generate a pull request summary at least once. + repositories: + type: array + description: Repositories in which users used Copilot for Pull Requests + to generate pull request summaries + items: + type: object + properties: + name: + type: string + description: Repository name + total_engaged_users: + type: integer + description: The number of users who generated pull request summaries + using Copilot for Pull Requests in the given repository. + models: + type: array + description: List of model metrics for custom models and the default + model. + items: + type: object + properties: + name: + type: string + description: Name of the 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 + nullable: true + description: The training date for the custom model. + total_pr_summaries_created: + type: integer + description: The number of pull request summaries generated + using Copilot for Pull Requests in the given repository. + total_engaged_users: + type: integer + description: The number of users who generated pull request + summaries using Copilot for Pull Requests in the given repository + and model. + copilot-usage-metrics-day: + title: Copilot Usage Metrics + description: Copilot usage metrics for a given day. + type: object + properties: + date: + type: string + format: date + description: The date for which the usage metrics are aggregated, in `YYYY-MM-DD` + format. + total_active_users: + type: integer + description: The total number of Copilot users with activity belonging to + any Copilot feature, globally, for the given day. Includes passive activity + such as receiving a code suggestion, as well as engagement activity such + as accepting a code suggestion or prompting chat. Does not include authentication + events. Is not limited to the individual features detailed on the endpoint. + total_engaged_users: + type: integer + description: The total number of Copilot users who engaged with any Copilot + feature, for the given day. Examples include but are not limited to accepting + a code suggestion, prompting Copilot chat, or triggering a PR Summary. + Does not include authentication events. Is not limited to the individual + features detailed on the endpoint. + copilot_ide_code_completions: + "$ref": "#/components/schemas/copilot-ide-code-completions" + copilot_ide_chat: + "$ref": "#/components/schemas/copilot-ide-chat" + copilot_dotcom_chat: + "$ref": "#/components/schemas/copilot-dotcom-chat" + copilot_dotcom_pull_requests: + "$ref": "#/components/schemas/copilot-dotcom-pull-requests" + required: + - date + additionalProperties: true + copilot-usage-metrics: + title: Copilot Usage Metrics + description: Summary of Copilot usage. + 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 + description: Breakdown of Copilot code completions usage by language and + editor + nullable: true + 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. @@ -75288,6 +74887,47 @@ 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 + example: single_select + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + nullable: true + description: Default value of the property + description: + type: string + nullable: true + description: Short description of the property + allowed_values: + type: array + items: + type: string + maxLength: 75 + maxItems: 200 + nullable: true + 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 @@ -76447,6 +76087,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 @@ -76664,6 +76305,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 @@ -77169,12 +76817,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 @@ -78933,6 +78583,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 @@ -88485,6 +88137,10 @@ components: nullable: true push_protection_bypass_request_reviewer: "$ref": "#/components/schemas/nullable-simple-user" + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection bypass. + nullable: true push_protection_bypass_request_comment: type: string description: An optional comment when requesting a push protection bypass. @@ -101135,6 +100791,10 @@ components: nullable: true push_protection_bypass_request_reviewer: "$ref": "#/components/schemas/nullable-simple-user" + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection bypass. + nullable: true push_protection_bypass_request_comment: type: string description: An optional comment when requesting a push protection bypass. @@ -198825,236 +198485,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 @@ -199503,6 +198933,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 @@ -199590,76 +199021,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' @@ -202895,6 +202263,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 @@ -206227,6 +205825,11 @@ components: used: 0 remaining: 10 reset: 1691591091 + code_scanning_autofix: + limit: 10 + used: 0 + remaining: 10 + reset: 1691591091 rate: limit: 5000 used: 1 @@ -217173,6 +216776,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 @@ -217195,6 +216799,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: @@ -217219,6 +216824,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: @@ -217261,6 +216867,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 @@ -223326,20 +222933,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. @@ -223721,6 +223314,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. @@ -224559,19 +224159,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: @@ -224621,6 +224208,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: @@ -224685,6 +224278,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/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 1bc6929d2..f79bad2a5 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -15926,1747 +15926,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": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ], - "nullable": true - }, - "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", - "nullable": true - }, - "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", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "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", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], - "nullable": true - } - }, - "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", - "example": "disabled | all" - }, - "group_id": { - "nullable": true, - "type": "string", - "example": "62ab9291-fae2-468e-974b-7e45096d5021" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "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" - ] - } - ], - "nullable": true - }, - "pending_cancellation_date": { - "type": "string", - "format": "date", - "nullable": true, - "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", - "format": "date-time", - "nullable": true, - "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." - }, - "last_activity_editor": { - "type": "string", - "nullable": true, - "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", - "description": "Usage metrics for Copilot editor code completions in the IDE.", - "nullable": true, - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." - }, - "languages": { - "type": "array", - "description": "Code completion metrics for active languages.", - "items": { - "type": "object", - "description": "Usage metrics for a given language for the given editor for Copilot code completions.", - "properties": { - "name": { - "type": "string", - "description": "Name of the language used for Copilot code completion suggestions." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." - } - } - } - }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot code completion metrics for active editors.", - "additionalProperties": true, - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the 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", - "nullable": true, - "description": "The training date for the custom model." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." - }, - "languages": { - "type": "array", - "description": "Code completion metrics for active languages, for the given editor.", - "items": { - "type": "object", - "description": "Usage metrics for a given language for the given editor for Copilot code completions.", - "properties": { - "name": { - "type": "string", - "description": "Name of the language used for Copilot code completion suggestions, for the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." - }, - "total_code_suggestions": { - "type": "integer", - "description": "The number of Copilot code suggestions generated for the given editor, for the given language." - }, - "total_code_acceptances": { - "type": "integer", - "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." - }, - "total_code_lines_suggested": { - "type": "integer", - "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." - }, - "total_code_lines_accepted": { - "type": "integer", - "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." - } - } - } - } - } - } - } - } - } - } - } - }, - "copilot_ide_chat": { - "type": "object", - "description": "Usage metrics for Copilot Chat in the IDE.", - "nullable": true, - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat in the IDE." - }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot Chat metrics, for active editors.", - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the specified editor." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the 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", - "nullable": true, - "description": "The training date for the custom model." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the given editor and model." - }, - "total_chats": { - "type": "integer", - "description": "The total number of chats initiated by users in the given editor and model." - }, - "total_chat_insertion_events": { - "type": "integer", - "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." - }, - "total_chat_copy_events": { - "type": "integer", - "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." - } - } - } - } - } - } - } - } - }, - "copilot_dotcom_chat": { - "type": "object", - "description": "Usage metrics for Copilot Chat in github.com", - "nullable": true, - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once." - }, - "models": { - "type": "array", - "description": "List of model metrics for a custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the 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", - "description": "The training date for the custom model (if applicable).", - "nullable": true - }, - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." - }, - "total_chats": { - "type": "integer", - "description": "Total number of chats initiated by users on github.com." - } - } - } - } - } - }, - "copilot_dotcom_pull_requests": { - "type": "object", - "description": "Usage metrics for Copilot for pull requests.", - "nullable": true, - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." - }, - "repositories": { - "type": "array", - "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Repository name" - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the 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", - "nullable": true, - "description": "The training date for the custom model." - }, - "total_pr_summaries_created": { - "type": "integer", - "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." - } - } - } - } - } - } - } - } - } - }, - "required": [ - "date" - ], - "additionalProperties": true - } - }, - "examples": { - "default": { - "value": [ - { - "date": "2024-06-24", - "total_active_users": 24, - "total_engaged_users": 20, - "copilot_ide_code_completions": { - "total_engaged_users": 20, - "languages": [ - { - "name": "python", - "total_engaged_users": 10 - }, - { - "name": "ruby", - "total_engaged_users": 10 - } - ], - "editors": [ - { - "name": "vscode", - "total_engaged_users": 13, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 13, - "languages": [ - { - "name": "python", - "total_engaged_users": 6, - "total_code_suggestions": 249, - "total_code_acceptances": 123, - "total_code_lines_suggested": 225, - "total_code_lines_accepted": 135 - }, - { - "name": "ruby", - "total_engaged_users": 7, - "total_code_suggestions": 496, - "total_code_acceptances": 253, - "total_code_lines_suggested": 520, - "total_code_lines_accepted": 270 - } - ] - } - ] - }, - { - "name": "neovim", - "total_engaged_users": 7, - "models": [ - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "languages": [ - { - "name": "typescript", - "total_engaged_users": 3, - "total_code_suggestions": 112, - "total_code_acceptances": 56, - "total_code_lines_suggested": 143, - "total_code_lines_accepted": 61 - }, - { - "name": "go", - "total_engaged_users": 4, - "total_code_suggestions": 132, - "total_code_acceptances": 67, - "total_code_lines_suggested": 154, - "total_code_lines_accepted": 72 - } - ] - } - ] - } - ] - }, - "copilot_ide_chat": { - "total_engaged_users": 13, - "editors": [ - { - "name": "vscode", - "total_engaged_users": 13, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 12, - "total_chats": 45, - "total_chat_insertion_events": 12, - "total_chat_copy_events": 16 - }, - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "total_engaged_users": 1, - "total_chats": 10, - "total_chat_insertion_events": 11, - "total_chat_copy_events": 3 - } - ] - } - ] - }, - "copilot_dotcom_chat": { - "total_engaged_users": 14, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 14, - "total_chats": 38 - } - ] - }, - "copilot_dotcom_pull_requests": { - "total_engaged_users": 12, - "repositories": [ - { - "name": "demo/repo1", - "total_engaged_users": 8, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_pr_summaries_created": 6, - "total_engaged_users": 8 - } - ] - }, - { - "name": "demo/repo2", - "total_engaged_users": 4, - "models": [ - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "total_pr_summaries_created": 10, - "total_engaged_users": 4 - } - ] - } - ] - } - } - ] - } - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-metrics" - } - } - }, - "/enterprises/{enterprise}/copilot/usage": { - "get": { - "summary": "Get a summary of Copilot usage for enterprise members", - "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", - "description": "Breakdown of Copilot code completions usage by language and editor", - "nullable": true, - "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", @@ -20400,6 +18659,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -20582,6 +18846,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", @@ -20673,6 +18938,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, @@ -20750,1022 +19016,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", - "description": "Usage metrics for Copilot editor code completions in the IDE.", - "nullable": true, - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." - }, - "languages": { - "type": "array", - "description": "Code completion metrics for active languages.", - "items": { - "type": "object", - "description": "Usage metrics for a given language for the given editor for Copilot code completions.", - "properties": { - "name": { - "type": "string", - "description": "Name of the language used for Copilot code completion suggestions." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." - } - } - } - }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot code completion metrics for active editors.", - "additionalProperties": true, - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the 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", - "nullable": true, - "description": "The training date for the custom model." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." - }, - "languages": { - "type": "array", - "description": "Code completion metrics for active languages, for the given editor.", - "items": { - "type": "object", - "description": "Usage metrics for a given language for the given editor for Copilot code completions.", - "properties": { - "name": { - "type": "string", - "description": "Name of the language used for Copilot code completion suggestions, for the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." - }, - "total_code_suggestions": { - "type": "integer", - "description": "The number of Copilot code suggestions generated for the given editor, for the given language." - }, - "total_code_acceptances": { - "type": "integer", - "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." - }, - "total_code_lines_suggested": { - "type": "integer", - "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." - }, - "total_code_lines_accepted": { - "type": "integer", - "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." - } - } - } - } - } - } - } - } - } - } - } - }, - "copilot_ide_chat": { - "type": "object", - "description": "Usage metrics for Copilot Chat in the IDE.", - "nullable": true, - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat in the IDE." - }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot Chat metrics, for active editors.", - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the specified editor." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the 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", - "nullable": true, - "description": "The training date for the custom model." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the given editor and model." - }, - "total_chats": { - "type": "integer", - "description": "The total number of chats initiated by users in the given editor and model." - }, - "total_chat_insertion_events": { - "type": "integer", - "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." - }, - "total_chat_copy_events": { - "type": "integer", - "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." - } - } - } - } - } - } - } - } - }, - "copilot_dotcom_chat": { - "type": "object", - "description": "Usage metrics for Copilot Chat in github.com", - "nullable": true, - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once." - }, - "models": { - "type": "array", - "description": "List of model metrics for a custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the 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", - "description": "The training date for the custom model (if applicable).", - "nullable": true - }, - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." - }, - "total_chats": { - "type": "integer", - "description": "Total number of chats initiated by users on github.com." - } - } - } - } - } - }, - "copilot_dotcom_pull_requests": { - "type": "object", - "description": "Usage metrics for Copilot for pull requests.", - "nullable": true, - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." - }, - "repositories": { - "type": "array", - "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Repository name" - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the 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", - "nullable": true, - "description": "The training date for the custom model." - }, - "total_pr_summaries_created": { - "type": "integer", - "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." - } - } - } - } - } - } - } - } - } - }, - "required": [ - "date" - ], - "additionalProperties": true - } - }, - "examples": { - "default": { - "value": [ - { - "date": "2024-06-24", - "total_active_users": 24, - "total_engaged_users": 20, - "copilot_ide_code_completions": { - "total_engaged_users": 20, - "languages": [ - { - "name": "python", - "total_engaged_users": 10 - }, - { - "name": "ruby", - "total_engaged_users": 10 - } - ], - "editors": [ - { - "name": "vscode", - "total_engaged_users": 13, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 13, - "languages": [ - { - "name": "python", - "total_engaged_users": 6, - "total_code_suggestions": 249, - "total_code_acceptances": 123, - "total_code_lines_suggested": 225, - "total_code_lines_accepted": 135 - }, - { - "name": "ruby", - "total_engaged_users": 7, - "total_code_suggestions": 496, - "total_code_acceptances": 253, - "total_code_lines_suggested": 520, - "total_code_lines_accepted": 270 - } - ] - } - ] - }, - { - "name": "neovim", - "total_engaged_users": 7, - "models": [ - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "languages": [ - { - "name": "typescript", - "total_engaged_users": 3, - "total_code_suggestions": 112, - "total_code_acceptances": 56, - "total_code_lines_suggested": 143, - "total_code_lines_accepted": 61 - }, - { - "name": "go", - "total_engaged_users": 4, - "total_code_suggestions": 132, - "total_code_acceptances": 67, - "total_code_lines_suggested": 154, - "total_code_lines_accepted": 72 - } - ] - } - ] - } - ] - }, - "copilot_ide_chat": { - "total_engaged_users": 13, - "editors": [ - { - "name": "vscode", - "total_engaged_users": 13, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 12, - "total_chats": 45, - "total_chat_insertion_events": 12, - "total_chat_copy_events": 16 - }, - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "total_engaged_users": 1, - "total_chats": 10, - "total_chat_insertion_events": 11, - "total_chat_copy_events": 3 - } - ] - } - ] - }, - "copilot_dotcom_chat": { - "total_engaged_users": 14, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 14, - "total_chats": 38 - } - ] - }, - "copilot_dotcom_pull_requests": { - "total_engaged_users": 12, - "repositories": [ - { - "name": "demo/repo1", - "total_engaged_users": 8, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_pr_summaries_created": 6, - "total_engaged_users": 8 - } - ] - }, - { - "name": "demo/repo2", - "total_engaged_users": 4, - "models": [ - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "total_pr_summaries_created": 10, - "total_engaged_users": 4 - } - ] - } - ] - } - } - ] - } - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-metrics" - } - } - }, - "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { - "get": { - "summary": "Get a summary of Copilot usage for an enterprise team", - "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", - "description": "Breakdown of Copilot code completions usage by language and editor", - "nullable": true, - "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", @@ -60247,6 +57497,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -111064,6 +108317,8 @@ "content": { "application/json": { "schema": { + "title": "Custom Property Set Payload", + "description": "Custom property set payload", "type": "object", "properties": { "value_type": { @@ -117132,7 +114387,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -117140,7 +114396,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -117263,7 +114520,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", @@ -117730,6 +114987,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." @@ -118474,7 +115738,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ], "default": "branch" }, @@ -118529,7 +115794,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", @@ -118995,6 +116260,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." @@ -119668,7 +116940,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -119676,7 +116949,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -119799,7 +117073,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", @@ -120266,6 +117540,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." @@ -121580,7 +118861,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -121588,7 +118870,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -121711,7 +118994,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", @@ -122178,6 +119461,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." @@ -122948,7 +120238,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "enforcement": { @@ -123002,7 +120293,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", @@ -123468,6 +120759,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." @@ -124137,7 +121435,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -124145,7 +121444,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -124268,7 +121568,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", @@ -124735,6 +122035,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." @@ -126449,135 +123756,140 @@ ], "nullable": true }, - "push_protection_bypassed_at": { + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypass_request_reviewer_comment": { "type": "string", - "format": "date-time", - "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true - }, - "push_protection_bypass_request_reviewer": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], + "description": "An optional comment when reviewing a push protection bypass.", "nullable": true }, "push_protection_bypass_request_comment": { @@ -126762,6 +124074,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", @@ -126853,6 +124166,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, @@ -147999,6 +145313,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": [ @@ -148099,6 +145437,12 @@ "used": 0, "remaining": 10, "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 } }, "rate": { @@ -178141,6 +175485,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -390305,6 +387652,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." @@ -391175,7 +388529,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -391183,7 +388538,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -391306,7 +388662,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", @@ -391773,6 +389129,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." @@ -392829,6 +390192,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." @@ -393492,7 +390862,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -393500,7 +390871,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -393623,7 +390995,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", @@ -394090,6 +391462,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." @@ -395423,7 +392802,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -395431,7 +392811,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -395554,7 +392935,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", @@ -396021,6 +393402,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." @@ -397092,6 +394480,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." @@ -397751,7 +395146,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -397759,7 +395155,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -397882,7 +395279,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", @@ -398349,6 +395746,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." @@ -399788,6 +397192,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -399898,6 +397307,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", @@ -399922,6 +397332,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, @@ -400482,6 +397893,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -400533,6 +397949,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, @@ -401140,6 +398557,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -401210,6 +398632,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", @@ -498649,6 +496072,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -1022119,7 +1019545,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -1022127,7 +1019554,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -1022250,7 +1019678,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", @@ -1022717,6 +1020145,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." @@ -1024950,7 +1022385,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -1024958,7 +1022394,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -1025081,7 +1022518,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", @@ -1025548,6 +1022985,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." @@ -1027781,7 +1025225,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -1027789,7 +1025234,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -1027912,7 +1025358,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", @@ -1028379,6 +1025825,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." @@ -1029363,6 +1026816,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." @@ -1030175,6 +1027635,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." @@ -1030990,6 +1028457,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." @@ -1042833,6 +1040307,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -1044931,6 +1042410,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -1047445,6 +1044929,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -1049543,6 +1047032,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -1051641,6 +1049135,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -1053739,6 +1051238,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index 9a366ad7d..5df73191b 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -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 - - &43 + - &40 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 - - &44 + - &41 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 - - &42 + - &39 name: direction description: The direction to sort the results by. in: query @@ -667,7 +667,7 @@ paths: required: - vector_string - score - cvss_severities: &46 + cvss_severities: &43 type: object nullable: true properties: @@ -838,7 +838,7 @@ paths: - subscriptions_url - type - url - type: &238 + type: &232 type: string description: The type of credit the user is receiving. enum: @@ -971,7 +971,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &98 + schema: &91 title: Validation Error Simple description: Validation Error Simple type: object @@ -1004,7 +1004,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &551 + - &550 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1122,7 +1122,7 @@ paths: GitHub. type: object nullable: true - properties: &59 + properties: &54 id: description: Unique identifier of the GitHub app example: 37 @@ -1211,7 +1211,7 @@ paths: type: string example: '"-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n"' - required: &60 + required: &55 - id - node_id - owner @@ -1516,7 +1516,7 @@ paths: schema: type: integer default: 30 - - &159 + - &152 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 @@ -1532,7 +1532,7 @@ paths: application/json: schema: type: array - items: &160 + items: &153 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1609,7 +1609,7 @@ paths: - installation_id - repository_id examples: - default: &161 + default: &154 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1668,7 +1668,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &97 + schema: &90 title: Validation Error description: Validation Error type: object @@ -1737,7 +1737,7 @@ paths: description: Response content: application/json: - schema: &162 + schema: &155 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1851,7 +1851,7 @@ paths: - request - response examples: - default: &163 + default: &156 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1911,7 +1911,7 @@ paths: parameters: - *17 responses: - '202': &99 + '202': &92 description: Accepted content: application/json: @@ -2106,7 +2106,7 @@ paths: parameters: - *18 - *20 - - &65 + - &60 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) @@ -2639,7 +2639,7 @@ paths: suspended_at: suspended_by: headers: - Link: &39 + Link: &51 example: ; rel="next", ; rel="last" schema: @@ -2828,11 +2828,11 @@ paths: - selected repositories: type: array - items: &58 + items: &53 title: Repository description: A repository on GitHub. type: object - properties: &218 + properties: &212 id: description: Unique identifier of the repository example: 42 @@ -2852,7 +2852,7 @@ paths: title: License Simple description: License Simple type: object - properties: &76 + properties: &71 key: type: string example: mit @@ -2874,7 +2874,7 @@ paths: html_url: type: string format: uri - required: &77 + required: &72 - key - name - url @@ -3261,7 +3261,7 @@ paths: type: boolean description: Whether anonymous git access is enabled for this repository - required: &219 + required: &213 - archive_url - assignees_url - blobs_url @@ -6903,1138 +6903,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: - - &40 - 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 - - *20 - - 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: &140 - title: Copilot Business Seat Detail - description: Information about a Copilot Business seat assignment - for a user, team, or organization. - type: object - properties: - assignee: *19 - organization: - title: Organization Simple - description: A GitHub organization. - type: object - properties: &92 - login: - type: string - example: github - id: - type: integer - example: 1 - node_id: - type: string - example: MDEyOk9yZ2FuaXphdGlvbjE= - url: - type: string - format: uri - example: https://api.github.com/orgs/github - repos_url: - type: string - format: uri - example: https://api.github.com/orgs/github/repos - events_url: - type: string - format: uri - example: https://api.github.com/orgs/github/events - hooks_url: - type: string - example: https://api.github.com/orgs/github/hooks - issues_url: - type: string - example: https://api.github.com/orgs/github/issues - members_url: - type: string - example: https://api.github.com/orgs/github/members{/member} - public_members_url: - type: string - example: https://api.github.com/orgs/github/public_members{/member} - avatar_url: - type: string - example: https://github.com/images/error/octocat_happy.gif - description: - type: string - example: A great organization - nullable: true - required: &93 - - login - - url - - id - - node_id - - repos_url - - events_url - - hooks_url - - issues_url - - members_url - - public_members_url - - avatar_url - - description - nullable: true - assigning_team: - description: The team through which the assignee is granted - access to GitHub Copilot, if applicable. - oneOf: - - &181 - 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 - nullable: true - 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 - example: https://github.com/orgs/rails/teams/core - members_url: - type: string - repositories_url: - type: string - format: uri - parent: - title: Team Simple - description: Groups of organization members that gives - permissions on specified repositories. - type: object - properties: &196 - id: - description: Unique identifier of the team - type: integer - example: 1 - node_id: - type: string - example: MDQ6VGVhbTE= - url: - description: URL for the team - type: string - format: uri - example: https://api.github.com/organizations/1/team/1 - members_url: - type: string - example: https://api.github.com/organizations/1/team/1/members{/member} - name: - description: Name of the team - type: string - example: Justice League - description: - description: Description of the team - type: string - nullable: true - example: A great team. - permission: - description: Permission that the team will have - for its repositories - type: string - example: admin - privacy: - description: The level of privacy this team should - have - type: string - example: closed - notification_setting: - description: The notification setting the team - has set - type: string - example: notifications_enabled - html_url: - type: string - format: uri - example: https://github.com/orgs/rails/teams/core - repositories_url: - type: string - format: uri - example: https://api.github.com/organizations/1/team/1/repos - slug: - type: string - example: justice-league - ldap_dn: - description: Distinguished Name (DN) that team - maps to within LDAP environment - example: uid=example,ou=users,dc=github,dc=com - type: string - required: &197 - - id - - node_id - - url - - members_url - - name - - description - - permission - - html_url - - repositories_url - - slug - nullable: true - 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 - example: disabled | all - group_id: - nullable: true - type: string - example: 62ab9291-fae2-468e-974b-7e45096d5021 - html_url: - type: string - format: uri - example: 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 - nullable: true - pending_cancellation_date: - type: string - format: date - nullable: true - 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 - format: date-time - nullable: true - description: Timestamp of user's last GitHub Copilot activity, - in ISO 8601 format. - last_activity_editor: - type: string - nullable: true - 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: &141 - 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: *39 - '500': &41 - description: Internal Error - content: - application/json: - schema: *3 - '401': *25 - '403': *29 - '404': *7 - 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: - - *40 - - name: since - description: Show usage metrics since this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). - Maximum value is 28 days ago. - in: query - required: false - schema: - type: string - - name: until - description: Show usage metrics until this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) - and should not preceed the `since` date if it is passed. - in: query - required: false - schema: - type: string - - *20 - - name: per_page - description: The number of days of metrics to display per page (max 28). For - more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 28 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &53 - title: Copilot Usage Metrics - description: Copilot usage metrics for a given day. - type: object - properties: - date: - type: string - format: date - description: The date for which the usage metrics are aggregated, - in `YYYY-MM-DD` format. - total_active_users: - type: integer - description: The total number of Copilot users with activity - belonging to any Copilot feature, globally, for the given - day. Includes passive activity such as receiving a code suggestion, - as well as engagement activity such as accepting a code suggestion - or prompting chat. Does not include authentication events. - Is not limited to the individual features detailed on the - endpoint. - total_engaged_users: - type: integer - description: The total number of Copilot users who engaged with - any Copilot feature, for the given day. Examples include but - are not limited to accepting a code suggestion, prompting - Copilot chat, or triggering a PR Summary. Does not include - authentication events. Is not limited to the individual features - detailed on the endpoint. - copilot_ide_code_completions: - type: object - description: Usage metrics for Copilot editor code completions - in the IDE. - nullable: true - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: Number of users who accepted at least one Copilot - code suggestion, across all active editors. Includes both - full and partial acceptances. - languages: - type: array - description: Code completion metrics for active languages. - items: - type: object - description: Usage metrics for a given language for the - given editor for Copilot code completions. - properties: - name: - type: string - description: Name of the language used for Copilot - code completion suggestions. - total_engaged_users: - type: integer - description: Number of users who accepted at least - one Copilot code completion suggestion for the given - language. Includes both full and partial acceptances. - editors: - type: array - items: - type: object - description: Copilot code completion metrics for active - editors. - additionalProperties: true - properties: - name: - type: string - description: Name of the given editor. - total_engaged_users: - type: integer - description: Number of users who accepted at least - one Copilot code completion suggestion for the given - editor. Includes both full and partial acceptances. - models: - type: array - description: List of model metrics for custom models - and the default model. - items: - type: object - properties: - name: - type: string - description: Name of the 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 - nullable: true - description: The training date for the custom - model. - total_engaged_users: - type: integer - description: Number of users who accepted at - least one Copilot code completion suggestion - for the given editor, for the given language - and model. Includes both full and partial - acceptances. - languages: - type: array - description: Code completion metrics for active - languages, for the given editor. - items: - type: object - description: Usage metrics for a given language - for the given editor for Copilot code completions. - properties: - name: - type: string - description: Name of the language used - for Copilot code completion suggestions, - for the given editor. - total_engaged_users: - type: integer - description: Number of users who accepted - at least one Copilot code completion - suggestion for the given editor, for - the given language. Includes both full - and partial acceptances. - total_code_suggestions: - type: integer - description: The number of Copilot code - suggestions generated for the given - editor, for the given language. - total_code_acceptances: - type: integer - description: The number of Copilot code - suggestions accepted for the given editor, - for the given language. Includes both - full and partial acceptances. - total_code_lines_suggested: - type: integer - description: The number of lines of code - suggested by Copilot code completions - for the given editor, for the given - language. - total_code_lines_accepted: - type: integer - description: The number of lines of code - accepted from Copilot code suggestions - for the given editor, for the given - language. - copilot_ide_chat: - type: object - description: Usage metrics for Copilot Chat in the IDE. - nullable: true - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: Total number of users who prompted Copilot - Chat in the IDE. - editors: - type: array - items: - type: object - description: Copilot Chat metrics, for active editors. - properties: - name: - type: string - description: Name of the given editor. - total_engaged_users: - type: integer - description: The number of users who prompted Copilot - Chat in the specified editor. - models: - type: array - description: List of model metrics for custom models - and the default model. - items: - type: object - properties: - name: - type: string - description: Name of the 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 - nullable: true - description: The training date for the custom - model. - total_engaged_users: - type: integer - description: The number of users who prompted - Copilot Chat in the given editor and model. - total_chats: - type: integer - description: The total number of chats initiated - by users in the given editor and model. - total_chat_insertion_events: - type: integer - description: The number of times users accepted - a code suggestion from Copilot Chat using - the 'Insert Code' UI element, for the given - editor. - total_chat_copy_events: - type: integer - description: The number of times users copied - a code suggestion from Copilot Chat using - the keyboard, or the 'Copy' UI element, for - the given editor. - copilot_dotcom_chat: - type: object - description: Usage metrics for Copilot Chat in github.com - nullable: true - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: Total number of users who prompted Copilot - Chat on github.com at least once. - models: - type: array - description: List of model metrics for a custom models and - the default model. - items: - type: object - properties: - name: - type: string - description: Name of the 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 - description: The training date for the custom model - (if applicable). - nullable: true - total_engaged_users: - type: integer - description: Total number of users who prompted Copilot - Chat on github.com at least once for each model. - total_chats: - type: integer - description: Total number of chats initiated by users - on github.com. - copilot_dotcom_pull_requests: - type: object - description: Usage metrics for Copilot for pull requests. - nullable: true - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: The number of users who used Copilot for Pull - Requests on github.com to generate a pull request summary - at least once. - repositories: - type: array - description: Repositories in which users used Copilot for - Pull Requests to generate pull request summaries - items: - type: object - properties: - name: - type: string - description: Repository name - total_engaged_users: - type: integer - description: The number of users who generated pull - request summaries using Copilot for Pull Requests - in the given repository. - models: - type: array - description: List of model metrics for custom models - and the default model. - items: - type: object - properties: - name: - type: string - description: Name of the 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 - nullable: true - description: The training date for the custom - model. - total_pr_summaries_created: - type: integer - description: The number of pull request summaries - generated using Copilot for Pull Requests - in the given repository. - total_engaged_users: - type: integer - description: The number of users who generated - pull request summaries using Copilot for Pull - Requests in the given repository and model. - required: - - date - additionalProperties: true - examples: - default: &54 - value: - - date: '2024-06-24' - total_active_users: 24 - total_engaged_users: 20 - copilot_ide_code_completions: - total_engaged_users: 20 - languages: - - name: python - total_engaged_users: 10 - - name: ruby - total_engaged_users: 10 - editors: - - name: vscode - total_engaged_users: 13 - models: - - name: default - is_custom_model: false - custom_model_training_date: - total_engaged_users: 13 - languages: - - name: python - total_engaged_users: 6 - total_code_suggestions: 249 - total_code_acceptances: 123 - total_code_lines_suggested: 225 - total_code_lines_accepted: 135 - - name: ruby - total_engaged_users: 7 - total_code_suggestions: 496 - total_code_acceptances: 253 - total_code_lines_suggested: 520 - total_code_lines_accepted: 270 - - name: neovim - total_engaged_users: 7 - models: - - name: a-custom-model - is_custom_model: true - custom_model_training_date: '2024-02-01' - languages: - - name: typescript - total_engaged_users: 3 - total_code_suggestions: 112 - total_code_acceptances: 56 - total_code_lines_suggested: 143 - total_code_lines_accepted: 61 - - name: go - total_engaged_users: 4 - total_code_suggestions: 132 - total_code_acceptances: 67 - total_code_lines_suggested: 154 - total_code_lines_accepted: 72 - copilot_ide_chat: - total_engaged_users: 13 - editors: - - name: vscode - total_engaged_users: 13 - models: - - name: default - is_custom_model: false - custom_model_training_date: - total_engaged_users: 12 - total_chats: 45 - total_chat_insertion_events: 12 - total_chat_copy_events: 16 - - name: a-custom-model - is_custom_model: true - custom_model_training_date: '2024-02-01' - total_engaged_users: 1 - total_chats: 10 - total_chat_insertion_events: 11 - total_chat_copy_events: 3 - copilot_dotcom_chat: - total_engaged_users: 14 - models: - - name: default - is_custom_model: false - custom_model_training_date: - total_engaged_users: 14 - total_chats: 38 - copilot_dotcom_pull_requests: - total_engaged_users: 12 - repositories: - - name: demo/repo1 - total_engaged_users: 8 - models: - - name: default - is_custom_model: false - custom_model_training_date: - total_pr_summaries_created: 6 - total_engaged_users: 8 - - name: demo/repo2 - total_engaged_users: 4 - models: - - name: a-custom-model - is_custom_model: true - custom_model_training_date: '2024-02-01' - total_pr_summaries_created: 10 - total_engaged_users: 4 - '500': *41 - '403': *29 - '404': *7 - '422': &55 - description: Copilot Usage Merics API setting is disabled at the organization - or enterprise level. - content: - application/json: - schema: *3 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-metrics - "/enterprises/{enterprise}/copilot/usage": - get: - summary: Get a summary of Copilot usage for enterprise members - 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: - - *40 - - name: since - description: Show usage metrics since this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). - Maximum value is 28 days ago. - in: query - required: false - schema: - type: string - - name: until - description: Show usage metrics until this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) - and should not preceed the `since` date if it is passed. - in: query - required: false - schema: - type: string - - *20 - - name: per_page - description: The number of days of metrics to display per page (max 28). For - more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 28 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &56 - 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 - description: Breakdown of Copilot code completions usage by - language and editor - nullable: true - 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': *41 - '401': *25 - '403': *29 - '404': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-usage "/enterprises/{enterprise}/dependabot/alerts": get: summary: List Dependabot alerts for an enterprise @@ -8053,8 +6921,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - - *40 - - &143 + - &45 + 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 + - &136 name: state in: query description: |- @@ -8063,7 +6938,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &144 + - &137 name: severity in: query description: |- @@ -8072,7 +6947,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &145 + - &138 name: ecosystem in: query description: |- @@ -8081,14 +6956,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &146 + - &139 name: package in: query description: A comma-separated list of package names. If specified, only alerts for these packages will be returned. schema: type: string - - &147 + - &140 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -8098,7 +6973,7 @@ paths: enum: - development - runtime - - &148 + - &141 name: sort in: query description: |- @@ -8111,10 +6986,10 @@ paths: - created - updated default: created - - *42 - - *43 - - *44 - - &149 + - *39 + - *40 + - *41 + - &142 name: first description: |- **Deprecated**. The number of results per page (max 100), starting from the first matching result. @@ -8127,7 +7002,7 @@ paths: minimum: 1 maximum: 100 default: 30 - - &150 + - &143 name: last description: |- **Deprecated**. The number of results per page (max 100), starting from the last matching result. @@ -8147,11 +7022,11 @@ paths: application/json: schema: type: array - items: &151 + items: &144 type: object description: A Dependabot alert. properties: - number: &48 + number: &46 type: integer description: The security alert number. readOnly: true @@ -8169,7 +7044,7 @@ paths: description: Details for the vulnerable dependency. readOnly: true properties: - package: &45 + package: &42 type: object description: Details for the vulnerable package. readOnly: true @@ -8200,7 +7075,7 @@ paths: enum: - development - runtime - security_advisory: &402 + security_advisory: &401 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -8230,13 +7105,13 @@ paths: description: Vulnerable version range information for the advisory. readOnly: true - items: &47 + items: &44 type: object description: Details pertaining to one vulnerable version range for the advisory. readOnly: true properties: - package: *45 + package: *42 severity: type: string description: The severity of the vulnerability. @@ -8302,7 +7177,7 @@ paths: - score - vector_string additionalProperties: false - cvss_severities: *46 + cvss_severities: *43 cwes: type: array description: Details for the advisory pertaining to Common @@ -8401,30 +7276,30 @@ paths: - updated_at - withdrawn_at additionalProperties: false - security_vulnerability: *47 - url: &50 + security_vulnerability: *44 + url: &48 type: string description: The REST API URL of the alert resource. format: uri readOnly: true - html_url: &51 + html_url: &49 type: string description: The GitHub URL of the alert resource. format: uri readOnly: true - created_at: &49 + created_at: &47 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: &127 + updated_at: &120 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: &129 + dismissed_at: &122 type: string description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -8454,21 +7329,21 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: &128 + fixed_at: &121 type: string description: 'The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - auto_dismissed_at: &403 + auto_dismissed_at: &402 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - repository: &52 + repository: &50 title: Simple Repository description: A GitHub repository. type: object @@ -8764,7 +7639,7 @@ paths: - repository additionalProperties: false examples: - default: &152 + default: &145 value: - number: 2 state: dismissed @@ -9107,8 +7982,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - - *40 - - &229 + - *45 + - &223 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -9119,7 +7994,7 @@ paths: enum: - open - resolved - - &230 + - &224 name: secret_type in: query description: |- @@ -9129,7 +8004,7 @@ paths: required: false schema: type: string - - &231 + - &225 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -9138,7 +8013,7 @@ paths: required: false schema: type: string - - &232 + - &226 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. @@ -9150,11 +8025,11 @@ paths: - created - updated default: created - - *42 + - *39 - *18 - - *43 - - *44 - - &233 + - *40 + - *41 + - &227 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -9163,7 +8038,7 @@ paths: required: false schema: type: string - - &234 + - &228 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -9172,7 +8047,7 @@ paths: schema: type: boolean default: false - - &235 + - &229 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -9188,11 +8063,11 @@ paths: application/json: schema: type: array - items: &236 + items: &230 type: object properties: - number: *48 - created_at: *49 + number: *46 + created_at: *47 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -9200,21 +8075,21 @@ paths: format: date-time readOnly: true nullable: true - url: *50 - html_url: *51 + url: *48 + html_url: *49 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: &543 + state: &542 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: &544 + resolution: &543 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -9248,7 +8123,7 @@ paths: secret: type: string description: The secret that was detected. - repository: *52 + repository: *50 push_protection_bypassed: type: boolean description: Whether push protection was bypassed for the detected @@ -9274,6 +8149,11 @@ paths: properties: *4 required: *5 nullable: true + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection + bypass. + nullable: true push_protection_bypass_request_comment: type: string description: An optional comment when requesting a push protection @@ -9306,7 +8186,7 @@ paths: repositories in the same organization or enterprise. nullable: true examples: - default: &237 + default: &231 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -9443,6 +8323,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 @@ -9530,6 +8411,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: @@ -9537,9 +8419,9 @@ paths: publicly_leaked: false multi_repo: false headers: - Link: *39 + Link: *51 '404': *7 - '503': &63 + '503': &58 description: Service unavailable content: application/json: @@ -9557,225 +8439,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: - - *40 - - name: team_slug - description: The slug of the enterprise team name. - in: path - required: true - schema: - type: string - - name: since - description: Show usage metrics since this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). - Maximum value is 28 days ago. - in: query - required: false - schema: - type: string - - name: until - description: Show usage metrics until this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) - and should not preceed the `since` date if it is passed. - in: query - required: false - schema: - type: string - - *20 - - name: per_page - description: The number of days of metrics to display per page (max 28). For - more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 28 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *53 - examples: - default: *54 - '500': *41 - '403': *29 - '404': *7 - '422': *55 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-metrics - "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": - get: - summary: Get a summary of Copilot usage for an enterprise team - 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: - - *40 - - &193 - 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 - - *20 - - name: per_page - description: The number of days of metrics to display per page (max 28). For - more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 28 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *56 - examples: - default: &142 - 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': *41 - '401': *25 - '403': *29 - '404': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-usage "/events": get: summary: List public events @@ -9798,7 +8461,7 @@ paths: application/json: schema: type: array - items: &87 + items: &82 title: Event description: Event type: object @@ -9808,7 +8471,7 @@ paths: type: type: string nullable: true - actor: &57 + actor: &52 title: Actor description: Actor type: object @@ -9848,18 +8511,18 @@ paths: - id - name - url - org: *57 + org: *52 payload: type: object properties: action: type: string - issue: &75 + issue: &70 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &451 + properties: &450 id: type: integer format: int64 @@ -9970,7 +8633,7 @@ paths: description: A collection of related issues and pull requests. type: object - properties: &387 + properties: &386 url: type: string format: uri @@ -10040,7 +8703,7 @@ paths: format: date-time example: '2012-10-09T23:39:01Z' nullable: true - required: &388 + required: &387 - closed_issues - creator - description @@ -10119,7 +8782,7 @@ paths: timeline_url: type: string format: uri - repository: *58 + repository: *53 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -10129,9 +8792,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 - author_association: &61 + properties: *54 + required: *55 + author_association: &56 title: author_association type: string example: OWNER @@ -10145,7 +8808,7 @@ paths: - MEMBER - NONE - OWNER - reactions: &62 + reactions: &57 title: Reaction Rollup type: object properties: @@ -10195,7 +8858,7 @@ paths: - total - completed - percent_completed - required: &452 + required: &451 - assignee - closed_at - comments @@ -10217,7 +8880,7 @@ paths: - author_association - created_at - updated_at - comment: &449 + comment: &448 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -10265,7 +8928,7 @@ paths: issue_url: type: string format: uri - author_association: *61 + author_association: *56 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -10275,9 +8938,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 - reactions: *62 + properties: *54 + required: *55 + reactions: *57 required: - id - node_id @@ -10372,7 +9035,7 @@ paths: created_at: '2022-06-07T07:50:26Z' '304': *37 '403': *29 - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -10453,7 +9116,7 @@ paths: _links: type: object properties: - timeline: &64 + timeline: &59 title: Link With Type description: Hypermedia Link with Type type: object @@ -10465,17 +9128,17 @@ paths: required: - href - type - user: *64 - security_advisories: *64 - current_user: *64 - current_user_public: *64 - current_user_actor: *64 - current_user_organization: *64 + user: *59 + security_advisories: *59 + current_user: *59 + current_user_public: *59 + current_user_actor: *59 + current_user_organization: *59 current_user_organizations: type: array - items: *64 - repository_discussions: *64 - repository_discussions_category: *64 + items: *59 + repository_discussions: *59 + repository_discussions_category: *59 required: - timeline - user @@ -10537,7 +9200,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *65 + - *60 - *18 - *20 responses: @@ -10547,7 +9210,7 @@ paths: application/json: schema: type: array - items: &66 + items: &61 title: Base Gist description: Base Gist type: object @@ -10644,7 +9307,7 @@ paths: - created_at - updated_at examples: - default: &67 + default: &62 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -10689,7 +9352,7 @@ paths: site_admin: false truncated: false headers: - Link: *39 + Link: *51 '304': *37 '403': *29 x-github: @@ -10765,7 +9428,7 @@ paths: description: Response content: application/json: - schema: &68 + schema: &63 title: Gist Simple description: Gist Simple type: object @@ -10782,7 +9445,7 @@ paths: url: type: string format: uri - user: &574 + user: &573 title: Public User description: Public User type: object @@ -11140,7 +9803,7 @@ paths: truncated: type: boolean examples: - default: &69 + default: &64 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -11243,7 +9906,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-public-gists parameters: - - *65 + - *60 - *18 - *20 responses: @@ -11253,11 +9916,11 @@ paths: application/json: schema: type: array - items: *66 + items: *61 examples: - default: *67 + default: *62 headers: - Link: *39 + Link: *51 '422': *16 '304': *37 '403': *29 @@ -11277,7 +9940,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-starred-gists parameters: - - *65 + - *60 - *18 - *20 responses: @@ -11287,11 +9950,11 @@ paths: application/json: schema: type: array - items: *66 + items: *61 examples: - default: *67 + default: *62 headers: - Link: *39 + Link: *51 '401': *25 '304': *37 '403': *29 @@ -11317,7 +9980,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist parameters: - - &70 + - &65 name: gist_id description: The unique identifier of the gist. in: path @@ -11329,10 +9992,10 @@ paths: description: Response content: application/json: - schema: *68 + schema: *63 examples: - default: *69 - '403': &73 + default: *64 + '403': &68 description: Forbidden Gist content: application/json: @@ -11380,7 +10043,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#update-a-gist parameters: - - *70 + - *65 requestBody: required: true content: @@ -11440,9 +10103,9 @@ paths: description: Response content: application/json: - schema: *68 + schema: *63 examples: - updateGist: *69 + updateGist: *64 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -11600,7 +10263,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#delete-a-gist parameters: - - *70 + - *65 responses: '204': description: Response @@ -11629,7 +10292,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#list-gist-comments parameters: - - *70 + - *65 - *18 - *20 responses: @@ -11639,7 +10302,7 @@ paths: application/json: schema: type: array - items: &71 + items: &66 title: Gist Comment description: A comment made to a gist. type: object @@ -11674,7 +10337,7 @@ paths: type: string format: date-time example: '2011-04-18T23:23:56Z' - author_association: *61 + author_association: *56 required: - url - id @@ -11714,7 +10377,7 @@ paths: updated_at: '2011-04-18T23:23:56Z' author_association: COLLABORATOR headers: - Link: *39 + Link: *51 '304': *37 '404': *7 '403': *29 @@ -11739,7 +10402,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#create-a-gist-comment parameters: - - *70 + - *65 requestBody: required: true content: @@ -11764,9 +10427,9 @@ paths: description: Response content: application/json: - schema: *71 + schema: *66 examples: - default: &72 + default: &67 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -11824,8 +10487,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#get-a-gist-comment parameters: - - *70 - - &74 + - *65 + - &69 name: comment_id description: The unique identifier of the comment. in: path @@ -11838,12 +10501,12 @@ paths: description: Response content: application/json: - schema: *71 + schema: *66 examples: - default: *72 + default: *67 '304': *37 '404': *7 - '403': *73 + '403': *68 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -11865,8 +10528,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#update-a-gist-comment parameters: - - *70 - - *74 + - *65 + - *69 requestBody: required: true content: @@ -11891,9 +10554,9 @@ paths: description: Response content: application/json: - schema: *71 + schema: *66 examples: - default: *72 + default: *67 '404': *7 x-github: githubCloudOnly: false @@ -11910,8 +10573,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#delete-a-gist-comment parameters: - - *70 - - *74 + - *65 + - *69 responses: '204': description: Response @@ -11934,7 +10597,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-commits parameters: - - *70 + - *65 - *18 - *20 responses: @@ -12035,7 +10698,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-forks parameters: - - *70 + - *65 - *18 - *20 responses: @@ -12045,7 +10708,7 @@ paths: application/json: schema: type: array - items: *68 + items: *63 examples: default: value: @@ -12091,7 +10754,7 @@ paths: type: User site_admin: false headers: - Link: *39 + Link: *51 '404': *7 '304': *37 '403': *29 @@ -12110,13 +10773,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#fork-a-gist parameters: - - *70 + - *65 responses: '201': description: Response content: application/json: - schema: *66 + schema: *61 examples: default: value: @@ -12187,7 +10850,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#check-if-a-gist-is-starred parameters: - - *70 + - *65 responses: '204': description: Response if gist is starred @@ -12217,7 +10880,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#star-a-gist parameters: - - *70 + - *65 responses: '204': description: Response @@ -12239,7 +10902,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#unstar-a-gist parameters: - - *70 + - *65 responses: '204': description: Response @@ -12268,7 +10931,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist-revision parameters: - - *70 + - *65 - name: sha in: path required: true @@ -12279,9 +10942,9 @@ paths: description: Response content: application/json: - schema: *68 + schema: *63 examples: - default: *69 + default: *64 '422': *16 '404': *7 '403': *29 @@ -12440,7 +11103,7 @@ paths: type: integer repositories: type: array - items: *58 + items: *53 repository_selection: type: string example: selected @@ -12563,7 +11226,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *39 + Link: *51 '403': *29 '304': *37 '401': *25 @@ -12647,7 +11310,7 @@ paths: - closed - all default: open - - &182 + - &175 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -12665,8 +11328,8 @@ paths: - updated - comments default: created - - *42 - - *65 + - *39 + - *60 - name: collab in: query required: false @@ -12696,9 +11359,9 @@ paths: application/json: schema: type: array - items: *75 + items: *70 examples: - default: &183 + default: &176 value: - id: 1 node_id: MDU6SXNzdWUx @@ -12943,7 +11606,7 @@ paths: watchers: 1 author_association: COLLABORATOR headers: - Link: *39 + Link: *51 '422': *16 '304': *37 '404': *7 @@ -12982,8 +11645,8 @@ paths: title: License Simple description: License Simple type: object - properties: *76 - required: *77 + properties: *71 + required: *72 examples: default: value: @@ -13267,7 +11930,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &78 + X-CommonMarker-Version: &73 example: 0.17.4 schema: type: string @@ -13322,7 +11985,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *78 + X-CommonMarker-Version: *73 content: text/html: schema: @@ -13351,7 +12014,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account parameters: - - &81 + - &76 name: account_id description: account_id parameter in: path @@ -13363,7 +12026,7 @@ paths: description: Response content: application/json: - schema: &80 + schema: &75 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -13393,7 +12056,7 @@ paths: nullable: true id: type: integer - plan: &79 + plan: &74 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -13482,7 +12145,7 @@ paths: nullable: true updated_at: type: string - plan: *79 + plan: *74 required: - url - id @@ -13490,7 +12153,7 @@ paths: - login - marketplace_purchase examples: - default: &82 + default: &77 value: url: https://api.github.com/orgs/github type: Organization @@ -13575,9 +12238,9 @@ paths: application/json: schema: type: array - items: *79 + items: *74 examples: - default: &83 + default: &78 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -13595,7 +12258,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *39 + Link: *51 '404': *7 '401': *25 x-github: @@ -13617,14 +12280,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &84 + - &79 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &85 + - &80 name: sort description: The property to sort the results by. in: query @@ -13654,9 +12317,9 @@ paths: application/json: schema: type: array - items: *80 + items: *75 examples: - default: &86 + default: &81 value: - url: https://api.github.com/orgs/github type: Organization @@ -13707,7 +12370,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *39 + Link: *51 '404': *7 '422': *16 '401': *25 @@ -13730,15 +12393,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed parameters: - - *81 + - *76 responses: '200': description: Response content: application/json: - schema: *80 + schema: *75 examples: - default: *82 + default: *77 '404': description: Not Found when the account has not purchased the listing '401': *25 @@ -13770,11 +12433,11 @@ paths: application/json: schema: type: array - items: *79 + items: *74 examples: - default: *83 + default: *78 headers: - Link: *39 + Link: *51 '401': *25 x-github: githubCloudOnly: false @@ -13795,8 +12458,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *84 - - *85 + - *79 + - *80 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -13816,11 +12479,11 @@ paths: application/json: schema: type: array - items: *80 + items: *75 examples: - default: *86 + default: *81 headers: - Link: *39 + Link: *51 '401': *25 x-github: githubCloudOnly: false @@ -14067,14 +12730,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &255 + - &254 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &256 + - &255 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -14091,7 +12754,7 @@ paths: application/json: schema: type: array - items: *87 + items: *82 examples: default: value: @@ -14145,7 +12808,7 @@ paths: '404': *7 '403': *29 '304': *37 - '301': &267 + '301': &266 description: Moved permanently content: application/json: @@ -14167,7 +12830,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &481 + - &480 name: all description: If `true`, show notifications marked as read. in: query @@ -14175,7 +12838,7 @@ paths: schema: type: boolean default: false - - &482 + - &481 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -14184,8 +12847,8 @@ paths: schema: type: boolean default: false - - *65 - - &483 + - *60 + - &482 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: @@ -14210,18 +12873,18 @@ paths: application/json: schema: type: array - items: &88 + items: &83 title: Thread description: Thread type: object properties: id: type: string - repository: &113 + repository: &106 title: Minimal Repository description: Minimal Repository type: object - properties: &154 + properties: &147 id: type: integer format: int64 @@ -14497,7 +13160,7 @@ paths: web_commit_signoff_required: type: boolean example: false - security_and_analysis: &220 + security_and_analysis: &214 nullable: true type: object properties: @@ -14553,7 +13216,7 @@ paths: enum: - enabled - disabled - required: &155 + required: &148 - archive_url - assignees_url - blobs_url @@ -14641,7 +13304,7 @@ paths: - url - subscription_url examples: - default: &484 + default: &483 value: - id: '1' repository: @@ -14723,7 +13386,7 @@ paths: url: https://api.github.com/notifications/threads/1 subscription_url: https://api.github.com/notifications/threads/1/subscription headers: - Link: *39 + Link: *51 '304': *37 '403': *29 '401': *25 @@ -14807,7 +13470,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread parameters: - - &89 + - &84 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 @@ -14821,7 +13484,7 @@ paths: description: Response content: application/json: - schema: *88 + schema: *83 examples: default: value: @@ -14923,7 +13586,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-read parameters: - - *89 + - *84 responses: '205': description: Reset Content @@ -14945,7 +13608,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-done parameters: - - *89 + - *84 responses: '204': description: No content @@ -14968,13 +13631,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user parameters: - - *89 + - *84 responses: '200': description: Response content: application/json: - schema: &90 + schema: &85 title: Thread Subscription description: Thread Subscription type: object @@ -15011,7 +13674,7 @@ paths: - url - subscribed examples: - default: &91 + default: &86 value: subscribed: true ignored: false @@ -15042,7 +13705,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#set-a-thread-subscription parameters: - - *89 + - *84 requestBody: required: false content: @@ -15063,9 +13726,9 @@ paths: description: Response content: application/json: - schema: *90 + schema: *85 examples: - default: *91 + default: *86 '304': *37 '403': *29 '401': *25 @@ -15088,7 +13751,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription parameters: - - *89 + - *84 responses: '204': description: Response @@ -15183,14 +13846,66 @@ paths: application/json: schema: type: array - items: &188 + items: &182 title: Organization Simple description: A GitHub organization. type: object - properties: *92 - required: *93 + properties: &134 + login: + type: string + example: github + id: + type: integer + example: 1 + node_id: + type: string + example: MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + example: https://api.github.com/orgs/github + repos_url: + type: string + format: uri + example: https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + example: https://api.github.com/orgs/github/events + hooks_url: + type: string + example: https://api.github.com/orgs/github/hooks + issues_url: + type: string + example: https://api.github.com/orgs/github/issues + members_url: + type: string + example: https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + example: https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + example: https://github.com/images/error/octocat_happy.gif + description: + type: string + example: A great organization + nullable: true + required: &135 + - login + - url + - id + - node_id + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url + - description examples: - default: &592 + default: &591 value: - login: github id: 1 @@ -15229,7 +13944,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization parameters: - - &94 + - &87 name: org description: The organization name. The name is not case sensitive. in: path @@ -15339,8 +14054,12 @@ paths: repositoryName: github/example '400': *15 '403': *29 - '500': *41 - '503': *63 + '500': &132 + description: Internal Error + content: + application/json: + schema: *3 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15366,13 +14085,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#get-an-organization parameters: - - *94 + - *87 responses: '200': description: Response content: application/json: - schema: &95 + schema: &88 title: Organization Full description: Organization Full type: object @@ -15661,7 +14380,7 @@ paths: - updated_at - archived_at examples: - default-response: &96 + default-response: &89 value: login: github id: 1 @@ -15752,7 +14471,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#update-an-organization parameters: - - *94 + - *87 requestBody: required: false content: @@ -15968,18 +14687,18 @@ paths: description: Response content: application/json: - schema: *95 + schema: *88 examples: - default: *96 + default: *89 '422': description: Validation failed content: application/json: schema: oneOf: - - *97 - - *98 - '409': &134 + - *90 + - *91 + '409': &127 description: Conflict content: application/json: @@ -16006,9 +14725,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#delete-an-organization parameters: - - *94 + - *87 responses: - '202': *99 + '202': *92 '404': *7 '403': *29 x-github: @@ -16031,7 +14750,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization parameters: - - *94 + - *87 responses: '200': description: Response @@ -16057,7 +14776,7 @@ paths: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16078,7 +14797,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: - - *94 + - *87 - *18 - *20 responses: @@ -16096,7 +14815,7 @@ paths: type: integer repository_cache_usages: type: array - items: &272 + items: &271 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -16131,7 +14850,7 @@ paths: active_caches_size_in_bytes: 1022142 active_caches_count: 2 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16151,13 +14870,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: - - *94 + - *87 responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &100 + schema: &93 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -16171,7 +14890,7 @@ paths: required: - include_claim_keys examples: - default: &101 + default: &94 value: include_claim_keys: - repo @@ -16193,20 +14912,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: - - *94 + - *87 requestBody: required: true content: application/json: - schema: *100 + schema: *93 examples: - default: *101 + default: *94 responses: '201': description: Empty response content: application/json: - schema: &122 + schema: &115 title: Empty Object description: An object without any properties. type: object @@ -16236,7 +14955,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization parameters: - - *94 + - *87 responses: '200': description: Response @@ -16245,7 +14964,7 @@ paths: schema: type: object properties: - enabled_repositories: &102 + enabled_repositories: &95 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -16258,7 +14977,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: &103 + allowed_actions: &96 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -16266,7 +14985,7 @@ paths: - all - local_only - selected - selected_actions_url: &278 + selected_actions_url: &277 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` @@ -16297,7 +15016,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization parameters: - - *94 + - *87 responses: '204': description: Response @@ -16308,8 +15027,8 @@ paths: schema: type: object properties: - enabled_repositories: *102 - allowed_actions: *103 + enabled_repositories: *95 + allowed_actions: *96 required: - enabled_repositories examples: @@ -16336,7 +15055,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: - - *94 + - *87 - *18 - *20 responses: @@ -16354,9 +15073,9 @@ paths: type: number repositories: type: array - items: *58 + items: *53 examples: - default: &586 + default: &585 value: total_count: 1 repositories: @@ -16496,7 +15215,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: - - *94 + - *87 responses: '204': description: Response @@ -16540,8 +15259,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: - - *94 - - &104 + - *87 + - &97 name: repository_id description: The unique identifier of the repository. in: path @@ -16569,8 +15288,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: - - *94 - - *104 + - *87 + - *97 responses: '204': description: Response @@ -16593,13 +15312,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *94 + - *87 responses: '200': description: Response content: application/json: - schema: &105 + schema: &98 type: object properties: github_owned_allowed: @@ -16621,7 +15340,7 @@ paths: items: type: string examples: - default: &106 + default: &99 value: github_owned_allowed: true verified_allowed: false @@ -16646,7 +15365,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *94 + - *87 responses: '204': description: Response @@ -16654,9 +15373,9 @@ paths: required: false content: application/json: - schema: *105 + schema: *98 examples: - selected_actions: *106 + selected_actions: *99 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -16678,23 +15397,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization parameters: - - *94 + - *87 responses: '200': description: Response content: application/json: - schema: &282 + schema: &281 type: object properties: - default_workflow_permissions: &107 + default_workflow_permissions: &100 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &108 + can_approve_pull_request_reviews: &101 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -16702,7 +15421,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &109 + default: &102 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -16727,7 +15446,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization parameters: - - *94 + - *87 responses: '204': description: Success response @@ -16735,13 +15454,13 @@ paths: required: false content: application/json: - schema: &283 + schema: &282 type: object properties: - default_workflow_permissions: *107 - can_approve_pull_request_reviews: *108 + default_workflow_permissions: *100 + can_approve_pull_request_reviews: *101 examples: - default: *109 + default: *102 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16761,7 +15480,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: - - *94 + - *87 - *18 - *20 - name: visible_to_repository @@ -16786,7 +15505,7 @@ paths: type: number runner_groups: type: array - items: &110 + items: &103 type: object properties: id: @@ -16898,7 +15617,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: - - *94 + - *87 requestBody: required: true content: @@ -16967,9 +15686,9 @@ paths: description: Response content: application/json: - schema: *110 + schema: *103 examples: - default: &112 + default: &105 value: id: 2 name: octo-runner-group @@ -17004,8 +15723,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: - - *94 - - &111 + - *87 + - &104 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -17017,7 +15736,7 @@ paths: description: Response content: application/json: - schema: *110 + schema: *103 examples: default: value: @@ -17053,8 +15772,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: - - *94 - - *111 + - *87 + - *104 requestBody: required: true content: @@ -17104,9 +15823,9 @@ paths: description: Response content: application/json: - schema: *110 + schema: *103 examples: - default: *112 + default: *105 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -17125,8 +15844,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: - - *94 - - *111 + - *87 + - *104 responses: '204': description: Response @@ -17149,8 +15868,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: - - *94 - - *111 + - *87 + - *104 - *20 - *18 responses: @@ -17168,9 +15887,9 @@ paths: type: number repositories: type: array - items: *113 + items: *106 examples: - default: &577 + default: &576 value: total_count: 1 repositories: @@ -17422,8 +16141,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: - - *94 - - *111 + - *87 + - *104 requestBody: required: true content: @@ -17467,9 +16186,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: - - *94 - - *111 + - *87 - *104 + - *97 responses: '204': description: Response @@ -17491,9 +16210,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: - - *94 - - *111 + - *87 - *104 + - *97 responses: '204': description: Response @@ -17516,8 +16235,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: - - *94 - - *111 + - *87 + - *104 - *18 - *20 responses: @@ -17535,7 +16254,7 @@ paths: type: number runners: type: array - items: &115 + items: &108 title: Self hosted runners description: A self hosted runner type: object @@ -17564,7 +16283,7 @@ paths: type: boolean labels: type: array - items: &118 + items: &111 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -17592,7 +16311,7 @@ paths: - busy - labels examples: - default: &116 + default: &109 value: total_count: 2 runners: @@ -17630,7 +16349,7 @@ paths: name: no-gpu type: custom headers: - Link: *39 + Link: *51 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -17649,8 +16368,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: - - *94 - - *111 + - *87 + - *104 requestBody: required: true content: @@ -17694,9 +16413,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: - - *94 - - *111 - - &114 + - *87 + - *104 + - &107 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -17724,9 +16443,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: - - *94 - - *111 - - *114 + - *87 + - *104 + - *107 responses: '204': description: Response @@ -17756,7 +16475,7 @@ paths: in: query schema: type: string - - *94 + - *87 - *18 - *20 responses: @@ -17774,11 +16493,11 @@ paths: type: integer runners: type: array - items: *115 + items: *108 examples: - default: *116 + default: *109 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17800,7 +16519,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization parameters: - - *94 + - *87 responses: '200': description: Response @@ -17808,7 +16527,7 @@ paths: application/json: schema: type: array - items: &284 + items: &283 title: Runner Application description: Runner Application type: object @@ -17833,7 +16552,7 @@ paths: - download_url - filename examples: - default: &285 + default: &284 value: - os: osx architecture: x64 @@ -17876,7 +16595,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: - - *94 + - *87 requestBody: required: true content: @@ -17919,7 +16638,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &286 + '201': &285 description: Response content: application/json: @@ -17929,7 +16648,7 @@ paths: - runner - encoded_jit_config properties: - runner: *115 + runner: *108 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -17985,13 +16704,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization parameters: - - *94 + - *87 responses: '201': description: Response content: application/json: - schema: &117 + schema: &110 title: Authentication Token description: Authentication Token type: object @@ -18013,7 +16732,7 @@ paths: repositories: description: The repositories this token has access to type: array - items: *58 + items: *53 single_file: type: string example: config.yaml @@ -18029,7 +16748,7 @@ paths: - token - expires_at examples: - default: &287 + default: &286 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -18060,15 +16779,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization parameters: - - *94 + - *87 responses: '201': description: Response content: application/json: - schema: *117 + schema: *110 examples: - default: &288 + default: &287 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -18093,16 +16812,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: - - *94 - - *114 + - *87 + - *107 responses: '200': description: Response content: application/json: - schema: *115 + schema: *108 examples: - default: &289 + default: &288 value: id: 23 name: MBP @@ -18142,8 +16861,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: - - *94 - - *114 + - *87 + - *107 responses: '204': description: Response @@ -18168,10 +16887,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: - - *94 - - *114 + - *87 + - *107 responses: - '200': &119 + '200': &112 description: Response content: application/json: @@ -18185,7 +16904,7 @@ paths: type: integer labels: type: array - items: *118 + items: *111 examples: default: value: @@ -18224,8 +16943,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: - - *94 - - *114 + - *87 + - *107 requestBody: required: true content: @@ -18249,7 +16968,7 @@ paths: - gpu - accelerated responses: - '200': *119 + '200': *112 '404': *7 '422': *8 x-github: @@ -18273,8 +16992,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: - - *94 - - *114 + - *87 + - *107 requestBody: required: true content: @@ -18299,7 +17018,7 @@ paths: - gpu - accelerated responses: - '200': *119 + '200': *112 '404': *7 '422': *8 x-github: @@ -18323,10 +17042,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: - - *94 - - *114 + - *87 + - *107 responses: - '200': &290 + '200': &289 description: Response content: application/json: @@ -18340,7 +17059,7 @@ paths: type: integer labels: type: array - items: *118 + items: *111 examples: default: value: @@ -18381,9 +17100,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: - - *94 - - *114 - - &291 + - *87 + - *107 + - &290 name: name description: The name of a self-hosted runner's custom label. in: path @@ -18391,7 +17110,7 @@ paths: schema: type: string responses: - '200': *119 + '200': *112 '404': *7 '422': *8 x-github: @@ -18416,7 +17135,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-organization-secrets parameters: - - *94 + - *87 - *18 - *20 responses: @@ -18434,7 +17153,7 @@ paths: type: integer secrets: type: array - items: &120 + items: &113 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -18484,7 +17203,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18507,13 +17226,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-public-key parameters: - - *94 + - *87 responses: '200': description: Response content: application/json: - schema: &303 + schema: &302 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -18542,7 +17261,7 @@ paths: - key_id - key examples: - default: &304 + default: &303 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -18567,8 +17286,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-secret parameters: - - *94 - - &121 + - *87 + - &114 name: secret_name description: The name of the secret. in: path @@ -18580,7 +17299,7 @@ paths: description: Response content: application/json: - schema: *120 + schema: *113 examples: default: value: @@ -18610,8 +17329,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 requestBody: required: true content: @@ -18666,7 +17385,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -18692,8 +17411,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 responses: '204': description: Response @@ -18719,8 +17438,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 - *20 - *18 responses: @@ -18738,9 +17457,9 @@ paths: type: integer repositories: type: array - items: *113 + items: *106 examples: - default: &125 + default: &118 value: total_count: 1 repositories: @@ -18832,8 +17551,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 requestBody: required: true content: @@ -18885,8 +17604,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 - name: repository_id in: path required: true @@ -18919,8 +17638,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 - name: repository_id in: path required: true @@ -18952,8 +17671,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - - *94 - - &277 + - *87 + - &276 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)." @@ -18977,7 +17696,7 @@ paths: type: integer variables: type: array - items: &123 + items: &116 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -19041,7 +17760,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19062,7 +17781,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-organization-variable parameters: - - *94 + - *87 requestBody: required: true content: @@ -19110,7 +17829,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -19135,8 +17854,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-organization-variable parameters: - - *94 - - &124 + - *87 + - &117 name: name description: The name of the variable. in: path @@ -19148,7 +17867,7 @@ paths: description: Response content: application/json: - schema: *123 + schema: *116 examples: default: value: @@ -19178,8 +17897,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-organization-variable parameters: - - *94 - - *124 + - *87 + - *117 requestBody: required: true content: @@ -19241,8 +17960,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-organization-variable parameters: - - *94 - - *124 + - *87 + - *117 responses: '204': description: Response @@ -19268,8 +17987,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - - *94 - - *124 + - *87 + - *117 - *20 - *18 responses: @@ -19287,9 +18006,9 @@ paths: type: integer repositories: type: array - items: *113 + items: *106 examples: - default: *125 + default: *118 '409': description: Response when the visibility of the variable is not set to `selected` @@ -19315,8 +18034,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - - *94 - - *124 + - *87 + - *117 requestBody: required: true content: @@ -19365,8 +18084,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - - *94 - - *124 + - *87 + - *117 - name: repository_id in: path required: true @@ -19400,8 +18119,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - - *94 - - *124 + - *87 + - *117 - name: repository_id in: path required: true @@ -19435,9 +18154,9 @@ paths: url: https://docs.github.com/rest/orgs/orgs#list-attestations parameters: - *18 - - *43 - - *44 - - *94 + - *40 + - *41 + - *87 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -19477,8 +18196,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: &317 + default: &316 value: attestations: - bundle: @@ -19585,7 +18306,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *94 + - *87 - *18 - *20 responses: @@ -19597,7 +18318,7 @@ paths: type: array items: *19 examples: - default: &184 + default: &177 value: - login: octocat id: 1 @@ -19635,8 +18356,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization parameters: - - *94 - - &126 + - *87 + - &119 name: username description: The handle for the GitHub user account. in: path @@ -19667,8 +18388,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization parameters: - - *94 - - *126 + - *87 + - *119 responses: '204': description: Response @@ -19688,8 +18409,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - - *94 - - *126 + - *87 + - *119 responses: '204': description: Response @@ -19714,18 +18435,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - - *94 - - &343 + - *87 + - &342 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: &130 + schema: &123 type: string description: The name of the tool used to generate the code scanning analysis. - - &344 + - &343 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 @@ -19733,22 +18454,22 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &131 + schema: &124 nullable: true type: string description: The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. - - *43 - - *44 + - *40 + - *41 - *20 - *18 - - *42 + - *39 - name: state description: If specified, only code scanning alerts with this state will be returned. in: query required: false - schema: &346 + schema: &345 type: string description: State of a code scanning alert. enum: @@ -19771,7 +18492,7 @@ paths: be returned. in: query required: false - schema: &347 + schema: &346 type: string description: Severity of a code scanning alert. enum: @@ -19792,18 +18513,18 @@ paths: items: type: object properties: - number: *48 - created_at: *49 - updated_at: *127 - url: *50 - html_url: *51 - instances_url: &348 + number: *46 + created_at: *47 + updated_at: *120 + url: *48 + html_url: *49 + instances_url: &347 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &132 + state: &125 type: string description: State of a code scanning alert. nullable: true @@ -19811,7 +18532,7 @@ paths: - open - dismissed - fixed - fixed_at: *128 + fixed_at: *121 dismissed_by: title: Simple User description: A GitHub user. @@ -19819,8 +18540,8 @@ paths: properties: *4 required: *5 nullable: true - dismissed_at: *129 - dismissed_reason: &349 + dismissed_at: *122 + dismissed_reason: &348 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -19829,13 +18550,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &350 + dismissed_comment: &349 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &351 + rule: &350 type: object properties: id: @@ -19888,25 +18609,25 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &352 + tool: &351 type: object properties: - name: *130 + name: *123 version: nullable: true type: string description: The version of the tool used to generate the code scanning analysis. - guid: *131 - most_recent_instance: &353 + guid: *124 + most_recent_instance: &352 type: object properties: - ref: &345 + ref: &344 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &359 + analysis_key: &358 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -19917,13 +18638,13 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &360 + category: &359 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: *132 + state: *125 commit_sha: type: string message: @@ -19962,7 +18683,7 @@ paths: - generated - test - library - repository: *52 + repository: *50 required: - number - created_at @@ -20207,9 +18928,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: *39 + Link: *51 '404': *7 - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20231,7 +18952,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization parameters: - - *94 + - *87 - name: target_type in: query description: The target type of the code security configuration @@ -20250,8 +18971,8 @@ paths: schema: type: integer default: 30 - - *43 - - *44 + - *40 + - *41 responses: '200': description: Response @@ -20259,7 +18980,7 @@ paths: application/json: schema: type: array - items: &133 + items: &126 type: object description: A code security configuration properties: @@ -20517,7 +19238,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration parameters: - - *94 + - *87 requestBody: required: true content: @@ -20590,7 +19311,7 @@ paths: - disabled - not_set default: disabled - code_scanning_default_setup_options: &137 + code_scanning_default_setup_options: &130 type: object description: Feature options for code scanning default setup nullable: true @@ -20707,9 +19428,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *133 + schema: *126 examples: - default: &135 + default: &128 value: id: 1325 target_type: organization @@ -20758,7 +19479,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations parameters: - - *94 + - *87 responses: '200': description: Response @@ -20778,7 +19499,7 @@ paths: description: The visibility of newly created repositories for which the code security configuration will be applied to by default - configuration: *133 + configuration: *126 examples: default: value: @@ -20868,7 +19589,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *94 + - *87 requestBody: required: true content: @@ -20891,12 +19612,12 @@ paths: - 32 - 91 responses: - '204': &138 + '204': &131 description: A header with no content is returned. '400': *15 '403': *29 '404': *7 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20918,8 +19639,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration parameters: - - *94 - - &136 + - *87 + - &129 name: configuration_id description: The unique identifier of the code security configuration. in: path @@ -20931,9 +19652,9 @@ paths: description: Response content: application/json: - schema: *133 + schema: *126 examples: - default: *135 + default: *128 '304': *37 '403': *29 '404': *7 @@ -20957,8 +19678,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration parameters: - - *94 - - *136 + - *87 + - *129 requestBody: required: true content: @@ -21024,7 +19745,7 @@ paths: - enabled - disabled - not_set - code_scanning_default_setup_options: *137 + code_scanning_default_setup_options: *130 secret_scanning: type: string description: The enablement status of secret scanning @@ -21111,7 +19832,7 @@ paths: description: Response when a configuration is updated content: application/json: - schema: *133 + schema: *126 examples: default: value: @@ -21165,14 +19886,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *94 - - *136 + - *87 + - *129 responses: - '204': *138 + '204': *131 '400': *15 '403': *29 '404': *7 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21196,8 +19917,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *94 - - *136 + - *87 + - *129 requestBody: required: true content: @@ -21236,7 +19957,7 @@ paths: - 32 - 91 responses: - '202': *99 + '202': *92 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21260,8 +19981,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: - - *94 - - *136 + - *87 + - *129 requestBody: required: true content: @@ -21301,12 +20022,12 @@ paths: - none - private_and_internal - public - configuration: *133 + configuration: *126 examples: default: value: default_for_new_repos: all - configuration: *135 + configuration: *128 '403': *29 '404': *7 x-github: @@ -21330,8 +20051,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration parameters: - - *94 - - *136 + - *87 + - *129 - 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)." @@ -21340,8 +20061,8 @@ paths: schema: type: integer default: 30 - - *43 - - *44 + - *40 + - *41 - name: status description: |- A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. @@ -21377,7 +20098,7 @@ paths: - failed - updating - removed_by_enterprise - repository: *52 + repository: *50 examples: default: summary: Example of code security configuration repositories @@ -21474,7 +20195,7 @@ paths: parameters: - *18 - *20 - - *94 + - *87 responses: '200': description: Response @@ -21490,7 +20211,7 @@ paths: type: integer codespaces: type: array - items: &185 + items: &178 type: object title: Codespace description: A codespace. @@ -21515,12 +20236,12 @@ paths: nullable: true owner: *19 billable_owner: *19 - repository: *113 + repository: *106 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &373 + properties: &372 name: type: string description: The name of the machine. @@ -21562,7 +20283,7 @@ paths: - ready - in_progress nullable: true - required: &374 + required: &373 - name - display_name - operating_system @@ -21767,7 +20488,7 @@ paths: - pulls_url - recent_folders examples: - default: &186 + default: &179 value: total_count: 3 codespaces: @@ -22177,7 +20898,7 @@ paths: stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop recent_folders: [] '304': *37 - '500': *41 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -22199,7 +20920,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *94 + - *87 deprecated: true requestBody: required: true @@ -22243,7 +20964,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *7 '422': *16 - '500': *41 + '500': *132 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -22266,7 +20987,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization parameters: - - *94 + - *87 deprecated: true requestBody: required: true @@ -22298,7 +21019,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *7 '422': *16 - '500': *41 + '500': *132 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -22321,7 +21042,7 @@ paths: url: https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *94 + - *87 requestBody: required: true content: @@ -22352,7 +21073,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *7 '422': *16 - '500': *41 + '500': *132 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -22373,7 +21094,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *94 + - *87 - *18 - *20 responses: @@ -22391,7 +21112,7 @@ paths: type: integer secrets: type: array - items: &139 + items: &133 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -22430,7 +21151,7 @@ paths: - updated_at - visibility examples: - default: &375 + default: &374 value: total_count: 2 secrets: @@ -22443,7 +21164,7 @@ paths: updated_at: '2020-01-11T11:59:22Z' visibility: all headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -22462,13 +21183,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *94 + - *87 responses: '200': description: Response content: application/json: - schema: &376 + schema: &375 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -22497,7 +21218,7 @@ paths: - key_id - key examples: - default: &377 + default: &376 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -22520,23 +21241,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 responses: '200': description: Response content: application/json: - schema: *139 + schema: *133 examples: - default: &379 + default: &378 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' updated_at: '2020-01-10T14:59:22Z' visibility: all headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -22556,8 +21277,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 requestBody: required: true content: @@ -22612,7 +21333,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -22638,8 +21359,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 responses: '204': description: Response @@ -22664,8 +21385,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 - *20 - *18 responses: @@ -22683,9 +21404,9 @@ paths: type: integer repositories: type: array - items: *113 + items: *106 examples: - default: *125 + default: *118 '404': *7 x-github: githubCloudOnly: false @@ -22707,8 +21428,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 requestBody: required: true content: @@ -22758,8 +21479,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 - name: repository_id in: path required: true @@ -22792,8 +21513,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 - name: repository_id in: path required: true @@ -22832,7 +21553,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: - - *94 + - *87 responses: '200': description: OK @@ -22943,7 +21664,7 @@ paths: cli: enabled public_code_suggestions: block plan_type: business - '500': *41 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -22975,7 +21696,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: - - *94 + - *87 - *20 - name: per_page description: The number of results per page (max 100). For more information, @@ -22998,12 +21719,324 @@ paths: currently being billed. seats: type: array - items: *140 + items: &181 + title: Copilot Business Seat Detail + description: Information about a Copilot Business seat assignment + for a user, team, or organization. + type: object + properties: + assignee: *19 + organization: + title: Organization Simple + description: A GitHub organization. + type: object + properties: *134 + required: *135 + nullable: true + assigning_team: + description: The team through which the assignee is granted + access to GitHub Copilot, if applicable. + oneOf: + - &174 + 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 + nullable: true + 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 + example: https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + parent: + title: Team Simple + description: Groups of organization members that gives + permissions on specified repositories. + type: object + properties: &190 + id: + description: Unique identifier of the team + type: integer + example: 1 + node_id: + type: string + example: MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + example: https://api.github.com/organizations/1/team/1 + members_url: + type: string + example: https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + example: Justice League + description: + description: Description of the team + type: string + nullable: true + example: A great team. + permission: + description: Permission that the team will have + for its repositories + type: string + example: admin + privacy: + description: The level of privacy this team should + have + type: string + example: closed + notification_setting: + description: The notification setting the team + has set + type: string + example: notifications_enabled + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/1/repos + slug: + type: string + example: justice-league + ldap_dn: + description: Distinguished Name (DN) that team + maps to within LDAP environment + example: uid=example,ou=users,dc=github,dc=com + type: string + required: &191 + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + nullable: true + 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 + example: disabled | all + group_id: + nullable: true + type: string + example: 62ab9291-fae2-468e-974b-7e45096d5021 + html_url: + type: string + format: uri + example: 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 + nullable: true + pending_cancellation_date: + type: string + format: date + nullable: true + 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 + format: date-time + nullable: true + description: Timestamp of user's last GitHub Copilot activity, + in ISO 8601 format. + last_activity_editor: + type: string + nullable: true + 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: *141 + 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: *39 - '500': *41 + Link: *51 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -23036,7 +22069,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: - - *94 + - *87 requestBody: content: application/json: @@ -23078,7 +22111,7 @@ paths: default: value: seats_created: 5 - '500': *41 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -23114,7 +22147,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: - - *94 + - *87 requestBody: content: application/json: @@ -23156,7 +22189,7 @@ paths: default: value: seats_cancelled: 5 - '500': *41 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -23194,7 +22227,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: - - *94 + - *87 requestBody: content: application/json: @@ -23235,7 +22268,7 @@ paths: default: value: seats_created: 5 - '500': *41 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -23271,7 +22304,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: - - *94 + - *87 requestBody: content: application/json: @@ -23313,7 +22346,7 @@ paths: default: value: seats_cancelled: 5 - '500': *41 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -23352,7 +22385,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization parameters: - - *94 + - *87 - 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`). @@ -23384,13 +22417,422 @@ paths: application/json: schema: type: array - items: *53 + items: &234 + title: Copilot Usage Metrics + description: Copilot usage metrics for a given day. + type: object + properties: + date: + type: string + format: date + description: The date for which the usage metrics are aggregated, + in `YYYY-MM-DD` format. + total_active_users: + type: integer + description: The total number of Copilot users with activity + belonging to any Copilot feature, globally, for the given + day. Includes passive activity such as receiving a code suggestion, + as well as engagement activity such as accepting a code suggestion + or prompting chat. Does not include authentication events. + Is not limited to the individual features detailed on the + endpoint. + total_engaged_users: + type: integer + description: The total number of Copilot users who engaged with + any Copilot feature, for the given day. Examples include but + are not limited to accepting a code suggestion, prompting + Copilot chat, or triggering a PR Summary. Does not include + authentication events. Is not limited to the individual features + detailed on the endpoint. + copilot_ide_code_completions: + type: object + description: Usage metrics for Copilot editor code completions + in the IDE. + nullable: true + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot + code suggestion, across all active editors. Includes both + full and partial acceptances. + languages: + type: array + description: Code completion metrics for active languages. + items: + type: object + description: Usage metrics for a given language for the + given editor for Copilot code completions. + properties: + name: + type: string + description: Name of the language used for Copilot + code completion suggestions. + total_engaged_users: + type: integer + description: Number of users who accepted at least + one Copilot code completion suggestion for the given + language. Includes both full and partial acceptances. + editors: + type: array + items: + type: object + description: Copilot code completion metrics for active + editors. + additionalProperties: true + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted at least + one Copilot code completion suggestion for the given + editor. Includes both full and partial acceptances. + models: + type: array + description: List of model metrics for custom models + and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the 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 + nullable: true + description: The training date for the custom + model. + total_engaged_users: + type: integer + description: Number of users who accepted at + least one Copilot code completion suggestion + for the given editor, for the given language + and model. Includes both full and partial + acceptances. + languages: + type: array + description: Code completion metrics for active + languages, for the given editor. + items: + type: object + description: Usage metrics for a given language + for the given editor for Copilot code completions. + properties: + name: + type: string + description: Name of the language used + for Copilot code completion suggestions, + for the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted + at least one Copilot code completion + suggestion for the given editor, for + the given language. Includes both full + and partial acceptances. + total_code_suggestions: + type: integer + description: The number of Copilot code + suggestions generated for the given + editor, for the given language. + total_code_acceptances: + type: integer + description: The number of Copilot code + suggestions accepted for the given editor, + for the given language. Includes both + full and partial acceptances. + total_code_lines_suggested: + type: integer + description: The number of lines of code + suggested by Copilot code completions + for the given editor, for the given + language. + total_code_lines_accepted: + type: integer + description: The number of lines of code + accepted from Copilot code suggestions + for the given editor, for the given + language. + copilot_ide_chat: + type: object + description: Usage metrics for Copilot Chat in the IDE. + nullable: true + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot + Chat in the IDE. + editors: + type: array + items: + type: object + description: Copilot Chat metrics, for active editors. + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: The number of users who prompted Copilot + Chat in the specified editor. + models: + type: array + description: List of model metrics for custom models + and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the 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 + nullable: true + description: The training date for the custom + model. + total_engaged_users: + type: integer + description: The number of users who prompted + Copilot Chat in the given editor and model. + total_chats: + type: integer + description: The total number of chats initiated + by users in the given editor and model. + total_chat_insertion_events: + type: integer + description: The number of times users accepted + a code suggestion from Copilot Chat using + the 'Insert Code' UI element, for the given + editor. + total_chat_copy_events: + type: integer + description: The number of times users copied + a code suggestion from Copilot Chat using + the keyboard, or the 'Copy' UI element, for + the given editor. + copilot_dotcom_chat: + type: object + description: Usage metrics for Copilot Chat in github.com + nullable: true + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot + Chat on github.com at least once. + models: + type: array + description: List of model metrics for a custom models and + the default model. + items: + type: object + properties: + name: + type: string + description: Name of the 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 + description: The training date for the custom model + (if applicable). + nullable: true + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot + Chat on github.com at least once for each model. + total_chats: + type: integer + description: Total number of chats initiated by users + on github.com. + copilot_dotcom_pull_requests: + type: object + description: Usage metrics for Copilot for pull requests. + nullable: true + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: The number of users who used Copilot for Pull + Requests on github.com to generate a pull request summary + at least once. + repositories: + type: array + description: Repositories in which users used Copilot for + Pull Requests to generate pull request summaries + items: + type: object + properties: + name: + type: string + description: Repository name + total_engaged_users: + type: integer + description: The number of users who generated pull + request summaries using Copilot for Pull Requests + in the given repository. + models: + type: array + description: List of model metrics for custom models + and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the 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 + nullable: true + description: The training date for the custom + model. + total_pr_summaries_created: + type: integer + description: The number of pull request summaries + generated using Copilot for Pull Requests + in the given repository. + total_engaged_users: + type: integer + description: The number of users who generated + pull request summaries using Copilot for Pull + Requests in the given repository and model. + required: + - date + additionalProperties: true examples: - default: *54 - '500': *41 + default: &235 + 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': *132 '403': *29 '404': *7 - '422': *55 + '422': &236 + 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 @@ -23421,7 +22863,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: - - *94 + - *87 - 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`). @@ -23453,10 +22895,158 @@ paths: application/json: schema: type: array - items: *56 + items: &237 + 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 + description: Breakdown of Copilot code completions usage by + language and editor + nullable: true + 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: *142 - '500': *41 + default: &238 + 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': *132 '401': *25 '403': *29 '404': *7 @@ -23481,18 +23071,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *94 + - *87 + - *136 + - *137 + - *138 + - *139 + - *140 + - *141 + - *39 + - *40 + - *41 + - *142 - *143 - - *144 - - *145 - - *146 - - *147 - - *148 - - *42 - - *43 - - *44 - - *149 - - *150 - *18 responses: '200': @@ -23501,9 +23091,9 @@ paths: application/json: schema: type: array - items: *151 + items: *144 examples: - default: *152 + default: *145 '304': *37 '400': *15 '403': *29 @@ -23529,7 +23119,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-organization-secrets parameters: - - *94 + - *87 - *18 - *20 responses: @@ -23547,7 +23137,7 @@ paths: type: integer secrets: type: array - items: &153 + items: &146 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -23597,7 +23187,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23618,13 +23208,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key parameters: - - *94 + - *87 responses: '200': description: Response content: application/json: - schema: &406 + schema: &405 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -23641,7 +23231,7 @@ paths: - key_id - key examples: - default: &407 + default: &406 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -23664,14 +23254,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 responses: '200': description: Response content: application/json: - schema: *153 + schema: *146 examples: default: value: @@ -23699,8 +23289,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 requestBody: required: true content: @@ -23755,7 +23345,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -23779,8 +23369,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 responses: '204': description: Response @@ -23804,8 +23394,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 - *20 - *18 responses: @@ -23823,9 +23413,9 @@ paths: type: integer repositories: type: array - items: *113 + items: *106 examples: - default: *125 + default: *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23846,8 +23436,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 requestBody: required: true content: @@ -23897,8 +23487,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 - name: repository_id in: path required: true @@ -23929,8 +23519,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 - name: repository_id in: path required: true @@ -23960,7 +23550,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: - - *94 + - *87 responses: '200': description: Response @@ -23968,7 +23558,7 @@ paths: application/json: schema: type: array - items: &199 + items: &193 title: Package description: A software package type: object @@ -24018,8 +23608,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *154 - required: *155 + properties: *147 + required: *148 nullable: true created_at: type: string @@ -24038,7 +23628,7 @@ paths: - created_at - updated_at examples: - default: &200 + default: &194 value: - id: 197 name: hello_docker @@ -24116,7 +23706,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-organization-events parameters: - - *94 + - *87 - *18 - *20 responses: @@ -24126,7 +23716,7 @@ paths: application/json: schema: type: array - items: *87 + items: *82 examples: 200-response: value: @@ -24195,7 +23785,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-failed-organization-invitations parameters: - - *94 + - *87 - *18 - *20 responses: @@ -24205,7 +23795,7 @@ paths: application/json: schema: type: array - items: &178 + items: &171 title: Organization Invitation description: Organization Invitation type: object @@ -24252,7 +23842,7 @@ paths: - invitation_teams_url - node_id examples: - default: &179 + default: &172 value: - id: 1 login: monalisa @@ -24285,7 +23875,7 @@ paths: invitation_teams_url: https://api.github.com/organizations/2/invitations/1/teams invitation_source: member headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -24309,7 +23899,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks parameters: - - *94 + - *87 - *18 - *20 responses: @@ -24319,7 +23909,7 @@ paths: application/json: schema: type: array - items: &156 + items: &149 title: Org Hook description: Org Hook type: object @@ -24407,7 +23997,7 @@ paths: created_at: '2011-09-06T17:26:27Z' type: Organization headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -24430,7 +24020,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook parameters: - - *94 + - *87 requestBody: required: true content: @@ -24490,9 +24080,9 @@ paths: description: Response content: application/json: - schema: *156 + schema: *149 examples: - default: &157 + default: &150 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -24539,8 +24129,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - - *94 - - &158 + - *87 + - &151 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. @@ -24553,9 +24143,9 @@ paths: description: Response content: application/json: - schema: *156 + schema: *149 examples: - default: *157 + default: *150 '404': *7 x-github: githubCloudOnly: false @@ -24582,8 +24172,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - - *94 - - *158 + - *87 + - *151 requestBody: required: false content: @@ -24628,7 +24218,7 @@ paths: description: Response content: application/json: - schema: *156 + schema: *149 examples: default: value: @@ -24669,8 +24259,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *94 - - *158 + - *87 + - *151 responses: '204': description: Response @@ -24697,8 +24287,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - - *94 - - *158 + - *87 + - *151 responses: '200': description: Response @@ -24728,8 +24318,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - - *94 - - *158 + - *87 + - *151 requestBody: required: false content: @@ -24779,10 +24369,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *94 - - *158 + - *87 + - *151 - *18 - - *159 + - *152 responses: '200': description: Response @@ -24790,9 +24380,9 @@ paths: application/json: schema: type: array - items: *160 + items: *153 examples: - default: *161 + default: *154 '400': *15 '422': *16 x-github: @@ -24817,17 +24407,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - - *94 - - *158 + - *87 + - *151 - *17 responses: '200': description: Response content: application/json: - schema: *162 + schema: *155 examples: - default: *163 + default: *156 '400': *15 '422': *16 x-github: @@ -24852,11 +24442,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - - *94 - - *158 + - *87 + - *151 - *17 responses: - '202': *99 + '202': *92 '400': *15 '422': *16 x-github: @@ -24882,8 +24472,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *94 - - *158 + - *87 + - *151 responses: '204': description: Response @@ -24905,8 +24495,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor parameters: - - *94 - - &168 + - *87 + - &161 name: actor_type in: path description: The type of the actor @@ -24919,14 +24509,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &169 + - &162 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &164 + - &157 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`.' @@ -24934,7 +24524,7 @@ paths: required: true schema: type: string - - &165 + - &158 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) @@ -24945,7 +24535,7 @@ paths: type: string - *20 - *18 - - *42 + - *39 - name: sort description: The property to sort the results by. in: query @@ -25027,13 +24617,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats parameters: - - *94 - - *164 - - *165 + - *87 + - *157 + - *158 - *20 - *18 - - *42 - - &174 + - *39 + - &167 name: sort description: The property to sort the results by. in: query @@ -25111,15 +24701,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats parameters: - - *94 - - *164 - - *165 + - *87 + - *157 + - *158 responses: '200': description: Response content: application/json: - schema: &166 + schema: &159 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -25135,7 +24725,7 @@ paths: type: integer format: int64 examples: - default: &167 + default: &160 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -25155,24 +24745,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user parameters: - - *94 - - &170 + - *87 + - &163 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *164 - - *165 + - *157 + - *158 responses: '200': description: Response content: application/json: - schema: *166 + schema: *159 examples: - default: *167 + default: *160 x-github: enabledForGitHubApps: true category: orgs @@ -25190,19 +24780,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor parameters: - - *94 - - *164 - - *165 - - *168 - - *169 + - *87 + - *157 + - *158 + - *161 + - *162 responses: '200': description: Response content: application/json: - schema: *166 + schema: *159 examples: - default: *167 + default: *160 x-github: enabledForGitHubApps: true category: orgs @@ -25219,10 +24809,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats parameters: - - *94 - - *164 - - *165 - - &171 + - *87 + - *157 + - *158 + - &164 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -25235,7 +24825,7 @@ paths: description: Response content: application/json: - schema: &172 + schema: &165 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -25251,7 +24841,7 @@ paths: type: integer format: int64 examples: - default: &173 + default: &166 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -25287,19 +24877,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user parameters: - - *94 - - *170 + - *87 + - *163 + - *157 + - *158 - *164 - - *165 - - *171 responses: '200': description: Response content: application/json: - schema: *172 + schema: *165 examples: - default: *173 + default: *166 x-github: enabledForGitHubApps: true category: orgs @@ -25316,20 +24906,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor parameters: - - *94 - - *168 - - *169 + - *87 + - *161 + - *162 + - *157 + - *158 - *164 - - *165 - - *171 responses: '200': description: Response content: application/json: - schema: *172 + schema: *165 examples: - default: *173 + default: *166 x-github: enabledForGitHubApps: true category: orgs @@ -25346,14 +24936,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-user-stats parameters: - - *94 - - *170 - - *164 - - *165 + - *87 + - *163 + - *157 + - *158 - *20 - *18 - - *42 - - *174 + - *39 + - *167 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -25426,7 +25016,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app parameters: - - *94 + - *87 responses: '200': description: Response @@ -25434,7 +25024,7 @@ paths: application/json: schema: *22 examples: - default: &445 + default: &444 value: id: 1 account: @@ -25503,7 +25093,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *94 + - *87 - *18 - *20 responses: @@ -25573,7 +25163,7 @@ paths: suspended_at: suspended_by: headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25592,7 +25182,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *94 + - *87 responses: '200': description: Response @@ -25600,12 +25190,12 @@ paths: application/json: schema: anyOf: - - &176 + - &169 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &175 + limit: &168 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -25630,7 +25220,7 @@ paths: properties: {} additionalProperties: false examples: - default: &177 + default: &170 value: limit: collaborators_only origin: organization @@ -25654,18 +25244,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *94 + - *87 requestBody: required: true content: application/json: - schema: &446 + schema: &445 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *175 + limit: *168 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -25689,9 +25279,9 @@ paths: description: Response content: application/json: - schema: *176 + schema: *169 examples: - default: *177 + default: *170 '422': *16 x-github: githubCloudOnly: false @@ -25709,7 +25299,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *94 + - *87 responses: '204': description: Response @@ -25733,7 +25323,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-pending-organization-invitations parameters: - - *94 + - *87 - *18 - *20 - name: role @@ -25767,11 +25357,11 @@ paths: application/json: schema: type: array - items: *178 + items: *171 examples: - default: *179 + default: *172 headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -25792,7 +25382,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#create-an-organization-invitation parameters: - - *94 + - *87 requestBody: required: false content: @@ -25846,7 +25436,7 @@ paths: description: Response content: application/json: - schema: *178 + schema: *171 examples: default: value: @@ -25900,8 +25490,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - - *94 - - &180 + - *87 + - &173 name: invitation_id description: The unique identifier of the invitation. in: path @@ -25931,8 +25521,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - - *94 - - *180 + - *87 + - *173 - *18 - *20 responses: @@ -25942,9 +25532,9 @@ paths: application/json: schema: type: array - items: *181 + items: *174 examples: - default: &198 + default: &192 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -25960,7 +25550,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos parent: headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -25989,7 +25579,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user parameters: - - *94 + - *87 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -26019,7 +25609,7 @@ paths: - closed - all default: open - - *182 + - *175 - name: sort description: What to sort results by. in: query @@ -26031,8 +25621,8 @@ paths: - updated - comments default: created - - *42 - - *65 + - *39 + - *60 - *18 - *20 responses: @@ -26042,11 +25632,11 @@ paths: application/json: schema: type: array - items: *75 + items: *70 examples: - default: *183 + default: *176 headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -26066,7 +25656,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-members parameters: - - *94 + - *87 - 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) @@ -26102,9 +25692,9 @@ paths: type: array items: *19 examples: - default: *184 + default: *177 headers: - Link: *39 + Link: *51 '422': *16 x-github: githubCloudOnly: false @@ -26122,8 +25712,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-organization-membership-for-a-user parameters: - - *94 - - *126 + - *87 + - *119 responses: '204': description: Response if requester is an organization member and user is @@ -26154,8 +25744,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-an-organization-member parameters: - - *94 - - *126 + - *87 + - *119 responses: '204': description: Response @@ -26181,8 +25771,8 @@ paths: parameters: - *18 - *20 - - *94 - - *126 + - *87 + - *119 responses: '200': description: Response @@ -26198,11 +25788,11 @@ paths: type: integer codespaces: type: array - items: *185 + items: *178 examples: - default: *186 + default: *179 '304': *37 - '500': *41 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -26225,9 +25815,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - - *94 - - *126 - - &187 + - *87 + - *119 + - &180 name: codespace_name in: path required: true @@ -26235,9 +25825,9 @@ paths: schema: type: string responses: - '202': *99 + '202': *92 '304': *37 - '500': *41 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -26260,17 +25850,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user parameters: - - *94 - - *126 - - *187 + - *87 + - *119 + - *180 responses: '200': description: Response content: application/json: - schema: *185 + schema: *178 examples: - default: &372 + default: &371 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -26412,7 +26002,7 @@ paths: recent_folders: [] template: '304': *37 - '500': *41 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -26443,14 +26033,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: - - *94 - - *126 + - *87 + - *119 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *140 + schema: *181 examples: default: value: @@ -26493,7 +26083,7 @@ paths: members_url: https://api.github.com/teams/1/members{/member} repositories_url: https://api.github.com/teams/1/repos parent: - '500': *41 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -26518,14 +26108,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user parameters: - - *94 - - *126 + - *87 + - *119 responses: '200': description: Response content: application/json: - schema: &189 + schema: &183 title: Org Membership description: Org Membership type: object @@ -26554,7 +26144,7 @@ paths: type: string format: uri example: https://api.github.com/orgs/octocat - organization: *188 + organization: *182 user: title: Simple User description: A GitHub user. @@ -26577,7 +26167,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &190 + response-if-user-has-an-active-admin-membership-with-organization: &184 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -26645,8 +26235,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user parameters: - - *94 - - *126 + - *87 + - *119 requestBody: required: false content: @@ -26674,9 +26264,9 @@ paths: description: Response content: application/json: - schema: *189 + schema: *183 examples: - response-if-user-already-had-membership-with-organization: *190 + response-if-user-already-had-membership-with-organization: *184 '422': *16 '403': *29 x-github: @@ -26697,8 +26287,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-organization-membership-for-a-user parameters: - - *94 - - *126 + - *87 + - *119 responses: '204': description: Response @@ -26723,7 +26313,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-organization-migrations parameters: - - *94 + - *87 - *18 - *20 - name: exclude @@ -26744,7 +26334,7 @@ paths: application/json: schema: type: array - items: &191 + items: &185 title: Migration description: A migration. type: object @@ -26785,7 +26375,7 @@ paths: type: array description: The repositories included in the migration. Only returned for export migrations. - items: *58 + items: *53 url: type: string format: uri @@ -26981,7 +26571,7 @@ paths: updated_at: '2015-07-06T15:33:38-07:00' node_id: MDQ6VXNlcjE= headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -26997,7 +26587,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#start-an-organization-migration parameters: - - *94 + - *87 requestBody: required: true content: @@ -27073,7 +26663,7 @@ paths: description: Response content: application/json: - schema: *191 + schema: *185 examples: default: value: @@ -27251,8 +26841,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status parameters: - - *94 - - &192 + - *87 + - &186 name: migration_id description: The unique identifier of the migration. in: path @@ -27279,7 +26869,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *191 + schema: *185 examples: default: value: @@ -27448,8 +27038,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *94 - - *192 + - *87 + - *186 responses: '302': description: Response @@ -27470,8 +27060,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *94 - - *192 + - *87 + - *186 responses: '204': description: Response @@ -27494,9 +27084,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository parameters: - - *94 - - *192 - - &591 + - *87 + - *186 + - &590 name: repo_name description: repo_name parameter in: path @@ -27523,8 +27113,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *94 - - *192 + - *87 + - *186 - *18 - *20 responses: @@ -27534,9 +27124,9 @@ paths: application/json: schema: type: array - items: *113 + items: *106 examples: - default: &205 + default: &199 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -27647,7 +27237,7 @@ paths: secret_scanning_non_provider_patterns: status: disabled headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -27673,7 +27263,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization parameters: - - *94 + - *87 responses: '200': description: Response - list of organization roles @@ -27689,7 +27279,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &195 + items: &189 title: Organization Role description: Organization roles type: object @@ -27836,8 +27426,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - - *94 - - *193 + - *87 + - &187 + name: team_slug + description: The slug of the team name. + in: path + required: true + schema: + type: string responses: '204': description: Response @@ -27862,9 +27458,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - - *94 - - *193 - - &194 + - *87 + - *187 + - &188 name: role_id description: The unique identifier of the role. in: path @@ -27899,9 +27495,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - - *94 - - *193 - - *194 + - *87 + - *187 + - *188 responses: '204': description: Response @@ -27926,8 +27522,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user parameters: - - *94 - - *126 + - *87 + - *119 responses: '204': description: Response @@ -27952,9 +27548,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-user parameters: - - *94 - - *126 - - *194 + - *87 + - *119 + - *188 responses: '204': description: Response @@ -27984,9 +27580,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-user parameters: - - *94 - - *126 - - *194 + - *87 + - *119 + - *188 responses: '204': description: Response @@ -28014,14 +27610,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role parameters: - - *94 - - *194 + - *87 + - *188 responses: '200': description: Response content: application/json: - schema: *195 + schema: *189 examples: default: value: @@ -28071,8 +27667,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: - - *94 - - *194 + - *87 + - *188 - *18 - *20 responses: @@ -28150,8 +27746,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *196 - required: *197 + properties: *190 + required: *191 nullable: true required: - id @@ -28166,9 +27762,9 @@ paths: - slug - parent examples: - default: *198 + default: *192 headers: - Link: *39 + Link: *51 '404': description: Response if the organization or role does not exist. '422': @@ -28195,8 +27791,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: - - *94 - - *194 + - *87 + - *188 - *18 - *20 responses: @@ -28224,13 +27820,13 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: &239 + items: &233 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *196 - required: *197 + properties: *190 + required: *191 name: nullable: true type: string @@ -28325,9 +27921,9 @@ paths: - type - url examples: - default: *184 + default: *177 headers: - Link: *39 + Link: *51 '404': description: Response if the organization or role does not exist. '422': @@ -28349,7 +27945,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization parameters: - - *94 + - *87 - 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) @@ -28373,9 +27969,9 @@ paths: type: array items: *19 examples: - default: *184 + default: *177 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28398,8 +27994,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator parameters: - - *94 - - *126 + - *87 + - *119 requestBody: required: false content: @@ -28456,8 +28052,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization parameters: - - *94 - - *126 + - *87 + - *119 responses: '204': description: Response @@ -28514,8 +28110,8 @@ paths: - docker - nuget - container - - *94 - - &593 + - *87 + - &592 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -28551,12 +28147,12 @@ paths: application/json: schema: type: array - items: *199 + items: *193 examples: - default: *200 + default: *194 '403': *29 '401': *25 - '400': &595 + '400': &594 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -28578,7 +28174,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization parameters: - - &201 + - &195 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 @@ -28596,20 +28192,20 @@ paths: - docker - nuget - container - - &202 + - &196 name: package_name description: The name of the package. in: path required: true schema: type: string - - *94 + - *87 responses: '200': description: Response content: application/json: - schema: *199 + schema: *193 examples: default: value: @@ -28661,9 +28257,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization parameters: - - *201 - - *202 - - *94 + - *195 + - *196 + - *87 responses: '204': description: Response @@ -28695,9 +28291,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization parameters: - - *201 - - *202 - - *94 + - *195 + - *196 + - *87 - name: token description: package token schema: @@ -28729,9 +28325,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: - - *201 - - *202 - - *94 + - *195 + - *196 + - *87 - *20 - *18 - name: state @@ -28751,7 +28347,7 @@ paths: application/json: schema: type: array - items: &203 + items: &197 title: Package Version description: A version of a software package type: object @@ -28876,10 +28472,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *201 - - *202 - - *94 - - &204 + - *195 + - *196 + - *87 + - &198 name: package_version_id description: Unique identifier of the package version. in: path @@ -28891,7 +28487,7 @@ paths: description: Response content: application/json: - schema: *203 + schema: *197 examples: default: value: @@ -28927,10 +28523,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization parameters: - - *201 - - *202 - - *94 - - *204 + - *195 + - *196 + - *87 + - *198 responses: '204': description: Response @@ -28962,10 +28558,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization parameters: - - *201 - - *202 - - *94 - - *204 + - *195 + - *196 + - *87 + - *198 responses: '204': description: Response @@ -28992,10 +28588,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: - - *94 + - *87 - *18 - *20 - - &206 + - &200 name: sort description: The property by which to sort the results. in: query @@ -29005,8 +28601,8 @@ paths: enum: - created_at default: created_at - - *42 - - &207 + - *39 + - &201 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -29017,7 +28613,7 @@ paths: items: type: string example: owner[]=octocat1,owner[]=octocat2 - - &208 + - &202 name: repository description: The name of the repository to use to filter the results. in: query @@ -29025,7 +28621,7 @@ paths: schema: type: string example: Hello-World - - &209 + - &203 name: permission description: The permission to use to filter the results. in: query @@ -29033,7 +28629,7 @@ paths: schema: type: string example: issues_read - - &210 + - &204 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) @@ -29043,7 +28639,7 @@ paths: schema: type: string format: date-time - - &211 + - &205 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) @@ -29054,7 +28650,7 @@ paths: type: string format: date-time responses: - '500': *41 + '500': *132 '422': *16 '404': *7 '403': *29 @@ -29186,7 +28782,7 @@ paths: token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29206,7 +28802,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: - - *94 + - *87 requestBody: required: true content: @@ -29247,11 +28843,11 @@ paths: action: deny reason: Access is too broad. responses: - '500': *41 + '500': *132 '422': *16 '404': *7 '403': *29 - '202': *99 + '202': *92 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29272,7 +28868,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: - - *94 + - *87 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -29308,11 +28904,11 @@ paths: action: deny reason: This request is denied because the access is too broad. responses: - '500': *41 + '500': *132 '422': *16 '404': *7 '403': *29 - '204': *138 + '204': *131 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29333,7 +28929,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: - - *94 + - *87 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -29344,7 +28940,7 @@ paths: - *18 - *20 responses: - '500': *41 + '500': *132 '404': *7 '403': *29 '200': @@ -29353,11 +28949,11 @@ paths: application/json: schema: type: array - items: *113 + items: *106 examples: - default: *205 + default: *199 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29378,18 +28974,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: - - *94 + - *87 - *18 - *20 - - *206 - - *42 - - *207 - - *208 - - *209 - - *210 - - *211 + - *200 + - *39 + - *201 + - *202 + - *203 + - *204 + - *205 responses: - '500': *41 + '500': *132 '422': *16 '404': *7 '403': *29 @@ -29516,7 +29112,7 @@ paths: token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29536,7 +29132,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: - - *94 + - *87 requestBody: required: true content: @@ -29571,9 +29167,9 @@ paths: - 1296269 - 1296280 responses: - '500': *41 + '500': *132 '404': *7 - '202': *99 + '202': *92 '403': *29 '422': *16 x-github: @@ -29596,7 +29192,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: - - *94 + - *87 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -29624,9 +29220,9 @@ paths: value: action: revoke responses: - '500': *41 + '500': *132 '404': *7 - '204': *138 + '204': *131 '403': *29 '422': *16 x-github: @@ -29648,7 +29244,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: - - *94 + - *87 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -29658,7 +29254,7 @@ paths: - *18 - *20 responses: - '500': *41 + '500': *132 '404': *7 '403': *29 '200': @@ -29667,11 +29263,11 @@ paths: application/json: schema: type: array - items: *113 + items: *106 examples: - default: *205 + default: *199 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29691,7 +29287,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-organization-projects parameters: - - *94 + - *87 - name: state description: Indicates the state of the projects to return. in: query @@ -29712,7 +29308,7 @@ paths: application/json: schema: type: array - items: &212 + items: &206 title: Project description: Projects are a way to organize columns and cards of work. @@ -29836,7 +29432,7 @@ paths: organization_permission: write private: true headers: - Link: *39 + Link: *51 '422': *8 x-github: githubCloudOnly: false @@ -29856,7 +29452,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#create-an-organization-project parameters: - - *94 + - *87 requestBody: required: true content: @@ -29882,7 +29478,7 @@ paths: description: Response content: application/json: - schema: *212 + schema: *206 examples: default: value: @@ -29920,7 +29516,7 @@ paths: '401': *25 '403': *29 '404': *7 - '410': &264 + '410': &263 description: Gone content: application/json: @@ -29944,7 +29540,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization parameters: - - *94 + - *87 responses: '200': description: Response @@ -29952,7 +29548,7 @@ paths: application/json: schema: type: array - items: &213 + items: &207 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -30018,7 +29614,7 @@ paths: - property_name - value_type examples: - default: &214 + default: &208 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -30062,7 +29658,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization parameters: - - *94 + - *87 requestBody: required: true content: @@ -30073,7 +29669,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *213 + items: *207 minItems: 1 maxItems: 100 required: @@ -30103,9 +29699,9 @@ paths: application/json: schema: type: array - items: *213 + items: *207 examples: - default: *214 + default: *208 '403': *29 '404': *7 x-github: @@ -30126,8 +29722,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - - *94 - - &215 + - *87 + - &209 name: custom_property_name description: The custom property name in: path @@ -30139,9 +29735,9 @@ paths: description: Response content: application/json: - schema: *213 + schema: *207 examples: - default: &216 + default: &210 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -30175,13 +29771,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: - - *94 - - *215 + - *87 + - *209 requestBody: required: true content: application/json: schema: + title: Custom Property Set Payload + description: Custom property set payload type: object properties: value_type: @@ -30235,9 +29833,9 @@ paths: description: Response content: application/json: - schema: *213 + schema: *207 examples: - default: *216 + default: *210 '403': *29 '404': *7 x-github: @@ -30260,10 +29858,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - - *94 - - *215 + - *87 + - *209 responses: - '204': *138 + '204': *131 '403': *29 '404': *7 x-github: @@ -30284,7 +29882,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories parameters: - - *94 + - *87 - *18 - *20 - name: repository_query @@ -30322,7 +29920,7 @@ paths: example: octocat/Hello-World properties: type: array - items: &217 + items: &211 title: Custom Property Value description: Custom property name and associated value type: object @@ -30361,7 +29959,7 @@ paths: - property_name: team value: octocat headers: - Link: *39 + Link: *51 '403': *29 '404': *7 x-github: @@ -30389,7 +29987,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: - - *94 + - *87 requestBody: required: true content: @@ -30409,7 +30007,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *217 + items: *211 required: - repository_names - properties @@ -30450,7 +30048,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-public-organization-members parameters: - - *94 + - *87 - *18 - *20 responses: @@ -30462,9 +30060,9 @@ paths: type: array items: *19 examples: - default: *184 + default: *177 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30481,8 +30079,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-public-organization-membership-for-a-user parameters: - - *94 - - *126 + - *87 + - *119 responses: '204': description: Response if user is a public member @@ -30506,8 +30104,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user parameters: - - *94 - - *126 + - *87 + - *119 responses: '204': description: Response @@ -30528,8 +30126,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user parameters: - - *94 - - *126 + - *87 + - *119 responses: '204': description: Response @@ -30553,7 +30151,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-organization-repositories parameters: - - *94 + - *87 - name: type description: Specifies the types of repositories you want returned. in: query @@ -30599,11 +30197,11 @@ paths: application/json: schema: type: array - items: *113 + items: *106 examples: - default: *205 + default: *199 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30622,7 +30220,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-organization-repository parameters: - - *94 + - *87 requestBody: required: true content: @@ -30803,7 +30401,7 @@ paths: description: Response content: application/json: - schema: &266 + schema: &265 title: Full Repository description: Full Repository type: object @@ -31080,8 +30678,8 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: *218 - required: *219 + properties: *212 + required: *213 nullable: true temp_clone_token: type: string @@ -31168,8 +30766,8 @@ paths: title: License Simple description: License Simple type: object - properties: *76 - required: *77 + properties: *71 + required: *72 nullable: true organization: title: Simple User @@ -31178,8 +30776,8 @@ paths: properties: *4 required: *5 nullable: true - parent: *58 - source: *58 + parent: *53 + source: *53 forks: type: integer master_branch: @@ -31196,7 +30794,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &394 + properties: &393 url: type: string format: uri @@ -31212,12 +30810,12 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &395 + required: &394 - url - key - name - html_url - security_and_analysis: *220 + security_and_analysis: *214 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -31301,7 +30899,7 @@ paths: - network_count - subscribers_count examples: - default: &268 + default: &267 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -31819,10 +31417,10 @@ paths: category: orgs subcategory: rules parameters: - - *94 + - *87 - *18 - *20 - - &530 + - &529 name: targets description: | A comma-separated list of rule targets to filter by. @@ -31840,7 +31438,7 @@ paths: application/json: schema: type: array - items: &227 + items: &221 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -31864,16 +31462,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: &223 + enforcement: &217 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins @@ -31886,7 +31486,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &224 + items: &218 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -31951,7 +31551,7 @@ paths: conditions: nullable: true anyOf: - - &221 + - &215 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name @@ -31975,20 +31575,21 @@ paths: match. items: type: string - - &225 + - &219 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: - - *221 + - *215 - title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -32022,7 +31623,7 @@ paths: description: Conditions to target repositories by id and refs by name allOf: - - *221 + - *215 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -32044,7 +31645,7 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *221 + - *215 - title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -32057,7 +31658,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &222 + items: &216 title: Repository ruleset property targeting definition type: object @@ -32090,17 +31691,17 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *222 + items: *216 required: - repository_property rules: type: array - items: &226 + items: &220 title: Repository Rule type: object description: A repository rule. oneOf: - - &512 + - &511 title: creation description: Only allow users with bypass permission to create matching refs. @@ -32112,7 +31713,7 @@ paths: type: string enum: - creation - - &513 + - &512 title: update description: Only allow users with bypass permission to update matching refs. @@ -32133,7 +31734,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &515 + - &514 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -32145,7 +31746,7 @@ paths: type: string enum: - deletion - - &516 + - &515 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -32157,7 +31758,7 @@ paths: type: string enum: - required_linear_history - - &517 + - &516 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -32235,7 +31836,7 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - &518 + - &517 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that @@ -32259,7 +31860,7 @@ paths: type: string required: - required_deployment_environments - - &519 + - &518 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -32271,7 +31872,7 @@ paths: type: string enum: - required_signatures - - &520 + - &519 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can @@ -32287,6 +31888,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 @@ -32317,7 +31925,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &521 + - &520 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be @@ -32365,7 +31973,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &522 + - &521 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -32377,7 +31985,7 @@ paths: type: string enum: - non_fast_forward - - &523 + - &522 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -32413,7 +32021,7 @@ paths: required: - operator - pattern - - &524 + - &523 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -32449,7 +32057,7 @@ paths: required: - operator - pattern - - &525 + - &524 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -32485,7 +32093,7 @@ paths: required: - operator - pattern - - &526 + - &525 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -32521,7 +32129,7 @@ paths: required: - operator - pattern - - &527 + - &526 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -32647,7 +32255,7 @@ paths: maximum: 100 required: - max_file_size - - &528 + - &527 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -32697,7 +32305,7 @@ paths: - repository_id required: - workflows - - &529 + - &528 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, @@ -32794,7 +32402,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *7 - '500': *41 + '500': *132 post: summary: Create an organization repository ruleset description: Create a repository ruleset for an organization. @@ -32810,7 +32418,7 @@ paths: category: orgs subcategory: rules parameters: - - *94 + - *87 requestBody: description: Request body required: true @@ -32829,17 +32437,18 @@ paths: - branch - tag - push + - repository default: branch - enforcement: *223 + enforcement: *217 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *224 - conditions: *225 + items: *218 + conditions: *219 rules: type: array description: An array of rules within the ruleset. - items: *226 + items: *220 required: - name - enforcement @@ -32877,9 +32486,9 @@ paths: description: Response content: application/json: - schema: *227 + schema: *221 examples: - default: &228 + default: &222 value: id: 21 name: super cool ruleset @@ -32919,7 +32528,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *7 - '500': *41 + '500': *132 "/orgs/{org}/rulesets/rule-suites": get: summary: List organization rule suites @@ -32933,8 +32542,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *94 - - &531 + - *87 + - &530 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 @@ -32949,7 +32558,7 @@ paths: in: query schema: type: string - - &532 + - &531 name: time_period description: |- The time period to filter by. @@ -32965,14 +32574,14 @@ paths: - week - month default: day - - &533 + - &532 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 - - &534 + - &533 name: rule_suite_result description: The rule results to filter on. When specified, only suites with this result will be returned. @@ -32992,7 +32601,7 @@ paths: description: Response content: application/json: - schema: &535 + schema: &534 title: Rule Suites description: Response type: array @@ -33047,7 +32656,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &536 + default: &535 value: - id: 21 actor_id: 12 @@ -33071,7 +32680,7 @@ paths: result: pass evaluation_result: fail '404': *7 - '500': *41 + '500': *132 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33090,8 +32699,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *94 - - &537 + - *87 + - &536 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -33107,7 +32716,7 @@ paths: description: Response content: application/json: - schema: &538 + schema: &537 title: Rule Suite description: Response type: object @@ -33206,7 +32815,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &539 + default: &538 value: id: 21 actor_id: 12 @@ -33241,7 +32850,7 @@ paths: result: fail rule_type: commit_message_pattern '404': *7 - '500': *41 + '500': *132 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33267,7 +32876,7 @@ paths: category: orgs subcategory: rules parameters: - - *94 + - *87 - name: ruleset_id description: The ID of the ruleset. in: path @@ -33279,11 +32888,11 @@ paths: description: Response content: application/json: - schema: *227 + schema: *221 examples: - default: *228 + default: *222 '404': *7 - '500': *41 + '500': *132 put: summary: Update an organization repository ruleset description: Update a ruleset for an organization. @@ -33299,7 +32908,7 @@ paths: category: orgs subcategory: rules parameters: - - *94 + - *87 - name: ruleset_id description: The ID of the ruleset. in: path @@ -33324,16 +32933,17 @@ paths: - branch - tag - push - enforcement: *223 + - repository + enforcement: *217 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *224 - conditions: *225 + items: *218 + conditions: *219 rules: description: An array of rules within the ruleset. type: array - items: *226 + items: *220 examples: default: value: @@ -33368,11 +32978,11 @@ paths: description: Response content: application/json: - schema: *227 + schema: *221 examples: - default: *228 + default: *222 '404': *7 - '500': *41 + '500': *132 delete: summary: Delete an organization repository ruleset description: Delete a ruleset for an organization. @@ -33388,7 +32998,7 @@ paths: category: orgs subcategory: rules parameters: - - *94 + - *87 - name: ruleset_id description: The ID of the ruleset. in: path @@ -33399,7 +33009,7 @@ paths: '204': description: Response '404': *7 - '500': *41 + '500': *132 "/orgs/{org}/secret-scanning/alerts": get: summary: List secret scanning alerts for an organization @@ -33416,15 +33026,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - - *94 - - *229 - - *230 - - *231 - - *232 - - *42 + - *87 + - *223 + - *224 + - *225 + - *226 + - *39 - *20 - *18 - - &541 + - &540 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 @@ -33434,7 +33044,7 @@ paths: required: false schema: type: string - - &542 + - &541 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 @@ -33444,9 +33054,9 @@ paths: required: false schema: type: string - - *233 - - *234 - - *235 + - *227 + - *228 + - *229 responses: '200': description: Response @@ -33454,13 +33064,13 @@ paths: application/json: schema: type: array - items: *236 + items: *230 examples: - default: *237 + default: *231 headers: - Link: *39 + Link: *51 '404': *7 - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33482,8 +33092,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization parameters: - - *94 - - *42 + - *87 + - *39 - name: sort description: The property to sort the results by. in: query @@ -33495,8 +33105,8 @@ paths: - updated - published default: created - - *43 - - *44 + - *40 + - *41 - 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)." @@ -33526,7 +33136,7 @@ paths: application/json: schema: type: array - items: &549 + items: &548 description: A repository security advisory. type: object properties: @@ -33713,7 +33323,7 @@ paths: required: - vector_string - score - cvss_severities: *46 + cvss_severities: *43 cwes: type: array nullable: true @@ -33746,7 +33356,7 @@ paths: login: type: string description: The username of the user credited. - type: *238 + type: *232 credits_detailed: type: array nullable: true @@ -33756,7 +33366,7 @@ paths: type: object properties: user: *19 - type: *238 + type: *232 state: type: string description: The state of the user's acceptance of the @@ -33780,14 +33390,14 @@ paths: type: array description: A list of teams that collaborate on the advisory. nullable: true - items: *181 + items: *174 private_fork: readOnly: true nullable: true description: A temporary private fork of the advisory's repository for collaborating on a fix. allOf: - - *52 + - *50 required: - ghsa_id - cve_id @@ -33817,7 +33427,7 @@ paths: - private_fork additionalProperties: false examples: - default: &550 + default: &549 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -34199,7 +33809,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams parameters: - - *94 + - *87 responses: '200': description: Response @@ -34207,9 +33817,9 @@ paths: application/json: schema: type: array - items: *239 + items: *233 examples: - default: *198 + default: *192 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34232,8 +33842,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team parameters: - - *94 - - *193 + - *87 + - *187 responses: '204': description: Response @@ -34258,8 +33868,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *94 - - *193 + - *87 + - *187 responses: '204': description: Response @@ -34285,13 +33895,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-an-organization parameters: - - *94 + - *87 responses: '200': description: Response content: application/json: - schema: &609 + schema: &608 type: object properties: total_minutes_used: @@ -34361,7 +33971,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &610 + default: &609 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -34391,13 +34001,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-an-organization parameters: - - *94 + - *87 responses: '200': description: Response content: application/json: - schema: &611 + schema: &610 type: object properties: total_gigabytes_bandwidth_used: @@ -34415,7 +34025,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &612 + default: &611 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -34441,13 +34051,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-an-organization parameters: - - *94 + - *87 responses: '200': description: Response content: application/json: - schema: &613 + schema: &612 type: object properties: days_left_in_billing_cycle: @@ -34465,7 +34075,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &614 + default: &613 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -34499,8 +34109,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - - *94 - - *193 + - *87 + - *187 - 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`). @@ -34532,13 +34142,13 @@ paths: application/json: schema: type: array - items: *53 + items: *234 examples: - default: *54 - '500': *41 + default: *235 + '500': *132 '403': *29 '404': *7 - '422': *55 + '422': *236 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34572,8 +34182,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: - - *94 - - *193 + - *87 + - *187 - 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`). @@ -34605,10 +34215,10 @@ paths: application/json: schema: type: array - items: *56 + items: *237 examples: - default: *142 - '500': *41 + default: *238 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -34629,7 +34239,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-teams parameters: - - *94 + - *87 - *18 - *20 responses: @@ -34639,11 +34249,11 @@ paths: application/json: schema: type: array - items: *181 + items: *174 examples: - default: *198 + default: *192 headers: - Link: *39 + Link: *51 '403': *29 x-github: githubCloudOnly: false @@ -34663,7 +34273,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#create-a-team parameters: - - *94 + - *87 requestBody: required: true content: @@ -34735,7 +34345,7 @@ paths: description: Response content: application/json: - schema: &240 + schema: &239 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -34798,8 +34408,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *196 - required: *197 + properties: *190 + required: *191 nullable: true members_count: type: integer @@ -35045,7 +34655,7 @@ paths: - repos_count - organization examples: - default: &241 + default: &240 value: id: 1 node_id: MDQ6VGVhbTE= @@ -35115,16 +34725,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-by-name parameters: - - *94 - - *193 + - *87 + - *187 responses: '200': description: Response content: application/json: - schema: *240 + schema: *239 examples: - default: *241 + default: *240 '404': *7 x-github: githubCloudOnly: false @@ -35145,8 +34755,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team parameters: - - *94 - - *193 + - *87 + - *187 requestBody: required: false content: @@ -35208,16 +34818,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *240 + schema: *239 examples: - default: *241 + default: *240 '201': description: Response content: application/json: - schema: *240 + schema: *239 examples: - default: *241 + default: *240 '404': *7 '422': *16 '403': *29 @@ -35242,8 +34852,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team parameters: - - *94 - - *193 + - *87 + - *187 responses: '204': description: Response @@ -35269,9 +34879,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions parameters: - - *94 - - *193 - - *42 + - *87 + - *187 + - *39 - *18 - *20 - name: pinned @@ -35287,7 +34897,7 @@ paths: application/json: schema: type: array - items: &242 + items: &241 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -35366,7 +34976,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *62 + reactions: *57 required: - author - body @@ -35386,7 +34996,7 @@ paths: - updated_at - url examples: - default: &564 + default: &563 value: - author: login: octocat @@ -35436,7 +35046,7 @@ paths: eyes: 1 rocket: 1 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35460,8 +35070,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion parameters: - - *94 - - *193 + - *87 + - *187 requestBody: required: true content: @@ -35495,9 +35105,9 @@ paths: description: Response content: application/json: - schema: *242 + schema: *241 examples: - default: &243 + default: &242 value: author: login: octocat @@ -35569,9 +35179,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion parameters: - - *94 - - *193 - - &244 + - *87 + - *187 + - &243 name: discussion_number description: The number that identifies the discussion. in: path @@ -35583,9 +35193,9 @@ paths: description: Response content: application/json: - schema: *242 + schema: *241 examples: - default: *243 + default: *242 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35607,9 +35217,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion parameters: - - *94 - - *193 - - *244 + - *87 + - *187 + - *243 requestBody: required: false content: @@ -35632,9 +35242,9 @@ paths: description: Response content: application/json: - schema: *242 + schema: *241 examples: - default: &565 + default: &564 value: author: login: octocat @@ -35704,9 +35314,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion parameters: - - *94 - - *193 - - *244 + - *87 + - *187 + - *243 responses: '204': description: Response @@ -35732,10 +35342,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments parameters: - - *94 - - *193 - - *244 - - *42 + - *87 + - *187 + - *243 + - *39 - *18 - *20 responses: @@ -35745,7 +35355,7 @@ paths: application/json: schema: type: array - items: &245 + items: &244 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -35802,7 +35412,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *62 + reactions: *57 required: - author - body @@ -35817,7 +35427,7 @@ paths: - updated_at - url examples: - default: &566 + default: &565 value: - author: login: octocat @@ -35861,7 +35471,7 @@ paths: eyes: 1 rocket: 1 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35885,9 +35495,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment parameters: - - *94 - - *193 - - *244 + - *87 + - *187 + - *243 requestBody: required: true content: @@ -35909,9 +35519,9 @@ paths: description: Response content: application/json: - schema: *245 + schema: *244 examples: - default: &246 + default: &245 value: author: login: octocat @@ -35977,10 +35587,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment parameters: - - *94 - - *193 - - *244 - - &247 + - *87 + - *187 + - *243 + - &246 name: comment_number description: The number that identifies the comment. in: path @@ -35992,9 +35602,9 @@ paths: description: Response content: application/json: - schema: *245 + schema: *244 examples: - default: *246 + default: *245 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36016,10 +35626,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment parameters: - - *94 - - *193 - - *244 - - *247 + - *87 + - *187 + - *243 + - *246 requestBody: required: true content: @@ -36041,9 +35651,9 @@ paths: description: Response content: application/json: - schema: *245 + schema: *244 examples: - default: &567 + default: &566 value: author: login: octocat @@ -36107,10 +35717,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment parameters: - - *94 - - *193 - - *244 - - *247 + - *87 + - *187 + - *243 + - *246 responses: '204': description: Response @@ -36136,10 +35746,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment parameters: - - *94 - - *193 - - *244 - - *247 + - *87 + - *187 + - *243 + - *246 - 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. @@ -36165,7 +35775,7 @@ paths: application/json: schema: type: array - items: &248 + items: &247 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -36208,7 +35818,7 @@ paths: - content - created_at examples: - default: &250 + default: &249 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -36234,7 +35844,7 @@ paths: content: heart created_at: '2016-05-20T20:09:31Z' headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36258,10 +35868,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment parameters: - - *94 - - *193 - - *244 - - *247 + - *87 + - *187 + - *243 + - *246 requestBody: required: true content: @@ -36294,9 +35904,9 @@ paths: team discussion comment content: application/json: - schema: *248 + schema: *247 examples: - default: &249 + default: &248 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -36325,9 +35935,9 @@ paths: description: Response content: application/json: - schema: *248 + schema: *247 examples: - default: *249 + default: *248 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36350,11 +35960,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - - *94 - - *193 - - *244 - - *247 - - &251 + - *87 + - *187 + - *243 + - *246 + - &250 name: reaction_id description: The unique identifier of the reaction. in: path @@ -36386,9 +35996,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - - *94 - - *193 - - *244 + - *87 + - *187 + - *243 - 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. @@ -36414,11 +36024,11 @@ paths: application/json: schema: type: array - items: *248 + items: *247 examples: - default: *250 + default: *249 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36442,9 +36052,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - - *94 - - *193 - - *244 + - *87 + - *187 + - *243 requestBody: required: true content: @@ -36476,16 +36086,16 @@ paths: description: Response content: application/json: - schema: *248 + schema: *247 examples: - default: *249 + default: *248 '201': description: Response content: application/json: - schema: *248 + schema: *247 examples: - default: *249 + default: *248 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -36508,10 +36118,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction parameters: - - *94 - - *193 - - *244 - - *251 + - *87 + - *187 + - *243 + - *250 responses: '204': description: Response @@ -36535,8 +36145,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations parameters: - - *94 - - *193 + - *87 + - *187 - *18 - *20 responses: @@ -36546,11 +36156,11 @@ paths: application/json: schema: type: array - items: *178 + items: *171 examples: - default: *179 + default: *172 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36570,8 +36180,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members parameters: - - *94 - - *193 + - *87 + - *187 - name: role description: Filters members returned by their role in the team. in: query @@ -36594,9 +36204,9 @@ paths: type: array items: *19 examples: - default: *184 + default: *177 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36624,15 +36234,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user parameters: - - *94 - - *193 - - *126 + - *87 + - *187 + - *119 responses: '200': description: Response content: application/json: - schema: &252 + schema: &251 title: Team Membership description: Team Membership type: object @@ -36659,7 +36269,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &568 + response-if-user-is-a-team-maintainer: &567 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -36695,9 +36305,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user parameters: - - *94 - - *193 - - *126 + - *87 + - *187 + - *119 requestBody: required: false content: @@ -36722,9 +36332,9 @@ paths: description: Response content: application/json: - schema: *252 + schema: *251 examples: - response-if-users-membership-with-team-is-now-pending: &569 + response-if-users-membership-with-team-is-now-pending: &568 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -36759,9 +36369,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user parameters: - - *94 - - *193 - - *126 + - *87 + - *187 + - *119 responses: '204': description: Response @@ -36787,8 +36397,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects parameters: - - *94 - - *193 + - *87 + - *187 - *18 - *20 responses: @@ -36798,7 +36408,7 @@ paths: application/json: schema: type: array - items: &253 + items: &252 title: Team Project description: A team's access to a project. type: object @@ -36866,7 +36476,7 @@ paths: - updated_at - permissions examples: - default: &570 + default: &569 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -36906,7 +36516,7 @@ paths: write: true admin: false headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36927,9 +36537,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project parameters: - - *94 - - *193 - - &254 + - *87 + - *187 + - &253 name: project_id description: The unique identifier of the project. in: path @@ -36941,9 +36551,9 @@ paths: description: Response content: application/json: - schema: *253 + schema: *252 examples: - default: &571 + default: &570 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -37003,9 +36613,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions parameters: - - *94 - - *193 - - *254 + - *87 + - *187 + - *253 requestBody: required: false content: @@ -37069,9 +36679,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team parameters: - - *94 - - *193 - - *254 + - *87 + - *187 + - *253 responses: '204': description: Response @@ -37095,8 +36705,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories parameters: - - *94 - - *193 + - *87 + - *187 - *18 - *20 responses: @@ -37106,11 +36716,11 @@ paths: application/json: schema: type: array - items: *113 + items: *106 examples: - default: *205 + default: *199 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37137,16 +36747,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *94 - - *193 + - *87 + - *187 + - *254 - *255 - - *256 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &572 + schema: &571 title: Team Repository description: A team's access to a repository. type: object @@ -37169,8 +36779,8 @@ paths: title: License Simple description: License Simple type: object - properties: *76 - required: *77 + properties: *71 + required: *72 nullable: true forks: type: integer @@ -37715,10 +37325,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *94 - - *193 + - *87 + - *187 + - *254 - *255 - - *256 requestBody: required: false content: @@ -37763,10 +37373,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team parameters: - - *94 - - *193 + - *87 + - *187 + - *254 - *255 - - *256 responses: '204': description: Response @@ -37790,8 +37400,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams parameters: - - *94 - - *193 + - *87 + - *187 - *18 - *20 responses: @@ -37801,9 +37411,9 @@ paths: application/json: schema: type: array - items: *181 + items: *174 examples: - response-if-child-teams-exist: &573 + response-if-child-teams-exist: &572 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -37831,7 +37441,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos html_url: https://github.com/orgs/rails/teams/core headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37856,7 +37466,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization parameters: - - *94 + - *87 - name: security_product in: path description: The security feature to enable or disable. @@ -37927,7 +37537,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#get-a-project-card parameters: - - &257 + - &256 name: card_id description: The unique identifier of the card. in: path @@ -37939,7 +37549,7 @@ paths: description: Response content: application/json: - schema: &258 + schema: &257 title: Project Card description: Project cards represent a scope of work. type: object @@ -38006,7 +37616,7 @@ paths: - created_at - updated_at examples: - default: &259 + default: &258 value: url: https://api.github.com/projects/columns/cards/1478 id: 1478 @@ -38056,7 +37666,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#update-an-existing-project-card parameters: - - *257 + - *256 requestBody: required: false content: @@ -38083,9 +37693,9 @@ paths: description: Response content: application/json: - schema: *258 + schema: *257 examples: - default: *259 + default: *258 '304': *37 '403': *29 '401': *25 @@ -38106,7 +37716,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#delete-a-project-card parameters: - - *257 + - *256 responses: '204': description: Response @@ -38144,7 +37754,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#move-a-project-card parameters: - - *257 + - *256 requestBody: required: true content: @@ -38249,7 +37859,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#get-a-project-column parameters: - - &260 + - &259 name: column_id description: The unique identifier of the column. in: path @@ -38261,7 +37871,7 @@ paths: description: Response content: application/json: - schema: &261 + schema: &260 title: Project Column description: Project columns contain cards of work. type: object @@ -38307,7 +37917,7 @@ paths: - created_at - updated_at examples: - default: &262 + default: &261 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -38336,7 +37946,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#update-an-existing-project-column parameters: - - *260 + - *259 requestBody: required: true content: @@ -38360,9 +37970,9 @@ paths: description: Response content: application/json: - schema: *261 + schema: *260 examples: - default: *262 + default: *261 '304': *37 '403': *29 '401': *25 @@ -38381,7 +37991,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#delete-a-project-column parameters: - - *260 + - *259 responses: '204': description: Response @@ -38404,7 +38014,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#list-project-cards parameters: - - *260 + - *259 - name: archived_state description: Filters the project cards that are returned by the card's state. in: query @@ -38425,7 +38035,7 @@ paths: application/json: schema: type: array - items: *258 + items: *257 examples: default: value: @@ -38459,7 +38069,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: *39 + Link: *51 '304': *37 '403': *29 '401': *25 @@ -38478,7 +38088,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#create-a-project-card parameters: - - *260 + - *259 requestBody: required: true content: @@ -38518,9 +38128,9 @@ paths: description: Response content: application/json: - schema: *258 + schema: *257 examples: - default: *259 + default: *258 '304': *37 '403': *29 '401': *25 @@ -38530,8 +38140,8 @@ paths: application/json: schema: oneOf: - - *97 - - *98 + - *90 + - *91 '503': description: Response content: @@ -38570,7 +38180,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#move-a-project-column parameters: - - *260 + - *259 requestBody: required: true content: @@ -38626,15 +38236,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-a-project parameters: - - *254 + - *253 responses: '200': description: Response content: application/json: - schema: *212 + schema: *206 examples: - default: &263 + default: &262 value: owner_url: https://api.github.com/repos/api-playground/projects-test url: https://api.github.com/projects/1002604 @@ -38687,7 +38297,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#update-a-project parameters: - - *254 + - *253 requestBody: required: false content: @@ -38733,9 +38343,9 @@ paths: description: Response content: application/json: - schema: *212 + schema: *206 examples: - default: *263 + default: *262 '404': description: Not Found if the authenticated user does not have access to the project @@ -38756,7 +38366,7 @@ paths: items: type: string '401': *25 - '410': *264 + '410': *263 '422': *8 x-github: githubCloudOnly: false @@ -38774,7 +38384,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#delete-a-project parameters: - - *254 + - *253 responses: '204': description: Delete Success @@ -38795,7 +38405,7 @@ paths: items: type: string '401': *25 - '410': *264 + '410': *263 '404': *7 x-github: githubCloudOnly: false @@ -38818,7 +38428,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/collaborators#list-project-collaborators parameters: - - *254 + - *253 - 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 @@ -38845,9 +38455,9 @@ paths: type: array items: *19 examples: - default: *184 + default: *177 headers: - Link: *39 + Link: *51 '404': *7 '422': *16 '304': *37 @@ -38870,8 +38480,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/collaborators#add-project-collaborator parameters: - - *254 - - *126 + - *253 + - *119 requestBody: required: false content: @@ -38918,8 +38528,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/collaborators#remove-user-as-a-collaborator parameters: - - *254 - - *126 + - *253 + - *119 responses: '204': description: Response @@ -38947,8 +38557,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/collaborators#get-project-permission-for-a-user parameters: - - *254 - - *126 + - *253 + - *119 responses: '200': description: Response @@ -39015,7 +38625,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#list-project-columns parameters: - - *254 + - *253 - *18 - *20 responses: @@ -39025,7 +38635,7 @@ paths: application/json: schema: type: array - items: *261 + items: *260 examples: default: value: @@ -39038,7 +38648,7 @@ paths: created_at: '2016-09-05T14:18:44Z' updated_at: '2016-09-05T14:22:28Z' headers: - Link: *39 + Link: *51 '304': *37 '403': *29 '401': *25 @@ -39057,7 +38667,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#create-a-project-column parameters: - - *254 + - *253 requestBody: required: true content: @@ -39080,7 +38690,7 @@ paths: description: Response content: application/json: - schema: *261 + schema: *260 examples: default: value: @@ -39141,7 +38751,7 @@ paths: resources: type: object properties: - core: &265 + core: &264 title: Rate Limit type: object properties: @@ -39158,19 +38768,20 @@ paths: - remaining - reset - used - graphql: *265 - search: *265 - code_search: *265 - source_import: *265 - integration_manifest: *265 - code_scanning_upload: *265 - actions_runner_registration: *265 - scim: *265 - dependency_snapshots: *265 + graphql: *264 + search: *264 + code_search: *264 + source_import: *264 + integration_manifest: *264 + code_scanning_upload: *264 + actions_runner_registration: *264 + scim: *264 + dependency_snapshots: *264 + code_scanning_autofix: *264 required: - core - search - rate: *265 + rate: *264 required: - rate - resources @@ -39228,6 +38839,11 @@ paths: used: 0 remaining: 10 reset: 1691591091 + code_scanning_autofix: + limit: 10 + used: 0 + remaining: 10 + reset: 1691591091 rate: limit: 5000 used: 1 @@ -39269,14 +38885,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: + - *254 - *255 - - *256 responses: '200': description: Response content: application/json: - schema: *266 + schema: *265 examples: default-response: summary: Default response @@ -39777,7 +39393,7 @@ paths: status: disabled '403': *29 '404': *7 - '301': *267 + '301': *266 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39795,8 +39411,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: + - *254 - *255 - - *256 requestBody: required: false content: @@ -40032,10 +39648,10 @@ paths: description: Response content: application/json: - schema: *266 + schema: *265 examples: - default: *268 - '307': &269 + default: *267 + '307': &268 description: Temporary Redirect content: application/json: @@ -40064,8 +39680,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: + - *254 - *255 - - *256 responses: '204': description: Response @@ -40087,7 +39703,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *269 + '307': *268 '404': *7 x-github: githubCloudOnly: false @@ -40110,11 +39726,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: + - *254 - *255 - - *256 - *18 - *20 - - &295 + - &294 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -40137,7 +39753,7 @@ paths: type: integer artifacts: type: array - items: &270 + items: &269 title: Artifact description: An artifact type: object @@ -40208,7 +39824,7 @@ paths: - expires_at - updated_at examples: - default: &296 + default: &295 value: total_count: 2 artifacts: @@ -40245,7 +39861,7 @@ paths: head_branch: main head_sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40267,9 +39883,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: + - *254 - *255 - - *256 - - &271 + - &270 name: artifact_id description: The unique identifier of the artifact. in: path @@ -40281,7 +39897,7 @@ paths: description: Response content: application/json: - schema: *270 + schema: *269 examples: default: value: @@ -40318,9 +39934,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: + - *254 - *255 - - *256 - - *271 + - *270 responses: '204': description: Response @@ -40344,9 +39960,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: + - *254 - *255 - - *256 - - *271 + - *270 - name: archive_format in: path required: true @@ -40360,7 +39976,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': *264 + '410': *263 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40383,14 +39999,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: + - *254 - *255 - - *256 responses: '200': description: Response content: application/json: - schema: *272 + schema: *271 examples: default: value: @@ -40416,11 +40032,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: + - *254 - *255 - - *256 - *18 - *20 - - &273 + - &272 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 @@ -40448,13 +40064,13 @@ paths: - last_accessed_at - size_in_bytes default: last_accessed_at - - *42 + - *39 responses: '200': description: Response content: application/json: - schema: &274 + schema: &273 title: Repository actions caches description: Repository actions caches type: object @@ -40496,7 +40112,7 @@ paths: - total_count - actions_caches examples: - default: &275 + default: &274 value: total_count: 1 actions_caches: @@ -40508,7 +40124,7 @@ paths: created_at: '2019-01-24T22:45:36.000Z' size_in_bytes: 1024 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40528,23 +40144,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: + - *254 - *255 - - *256 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *273 + - *272 responses: '200': description: Response content: application/json: - schema: *274 + schema: *273 examples: - default: *275 + default: *274 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40564,8 +40180,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: + - *254 - *255 - - *256 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -40596,9 +40212,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: + - *254 - *255 - - *256 - - &276 + - &275 name: job_id description: The unique identifier of the job. in: path @@ -40610,7 +40226,7 @@ paths: description: Response content: application/json: - schema: &299 + schema: &298 title: Job description: Information of a job execution in a workflow run type: object @@ -40917,9 +40533,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: + - *254 - *255 - - *256 - - *276 + - *275 responses: '302': description: Response @@ -40947,9 +40563,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: + - *254 - *255 - - *256 - - *276 + - *275 requestBody: required: false content: @@ -40970,7 +40586,7 @@ paths: description: Response content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -40994,8 +40610,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: + - *254 - *255 - - *256 responses: '200': description: Status response @@ -41045,8 +40661,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: + - *254 - *255 - - *256 requestBody: required: true content: @@ -41080,7 +40696,7 @@ paths: description: Empty response content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -41109,8 +40725,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -41128,7 +40744,7 @@ paths: type: integer secrets: type: array - items: &301 + items: &300 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -41148,7 +40764,7 @@ paths: - created_at - updated_at examples: - default: &302 + default: &301 value: total_count: 2 secrets: @@ -41159,7 +40775,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41181,9 +40797,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: + - *254 - *255 - - *256 - - *277 + - *276 - *20 responses: '200': @@ -41200,7 +40816,7 @@ paths: type: integer variables: type: array - items: &305 + items: &304 title: Actions Variable type: object properties: @@ -41230,7 +40846,7 @@ paths: - created_at - updated_at examples: - default: &306 + default: &305 value: total_count: 2 variables: @@ -41243,7 +40859,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41263,8 +40879,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: + - *254 - *255 - - *256 responses: '200': description: Response @@ -41273,11 +40889,11 @@ paths: schema: type: object properties: - enabled: &279 + enabled: &278 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *103 - selected_actions_url: *278 + allowed_actions: *96 + selected_actions_url: *277 required: - enabled examples: @@ -41304,8 +40920,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: + - *254 - *255 - - *256 responses: '204': description: Response @@ -41316,8 +40932,8 @@ paths: schema: type: object properties: - enabled: *279 - allowed_actions: *103 + enabled: *278 + allowed_actions: *96 required: - enabled examples: @@ -41346,14 +40962,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: + - *254 - *255 - - *256 responses: '200': description: Response content: application/json: - schema: &280 + schema: &279 type: object properties: access_level: @@ -41370,7 +40986,7 @@ paths: required: - access_level examples: - default: &281 + default: &280 value: access_level: organization x-github: @@ -41394,15 +41010,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: + - *254 - *255 - - *256 requestBody: required: true content: application/json: - schema: *280 + schema: *279 examples: - default: *281 + default: *280 responses: '204': description: Response @@ -41426,16 +41042,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: + - *254 - *255 - - *256 responses: '200': description: Response content: application/json: - schema: *105 + schema: *98 examples: - default: *106 + default: *99 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -41454,8 +41070,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: + - *254 - *255 - - *256 responses: '204': description: Response @@ -41463,9 +41079,9 @@ paths: required: false content: application/json: - schema: *105 + schema: *98 examples: - selected_actions: *106 + selected_actions: *99 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -41487,16 +41103,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: + - *254 - *255 - - *256 responses: '200': description: Response content: application/json: - schema: *282 + schema: *281 examples: - default: *109 + default: *102 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41517,8 +41133,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: + - *254 - *255 - - *256 responses: '204': description: Success response @@ -41529,9 +41145,9 @@ paths: required: true content: application/json: - schema: *283 + schema: *282 examples: - default: *109 + default: *102 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41558,8 +41174,8 @@ paths: in: query schema: type: string + - *254 - *255 - - *256 - *18 - *20 responses: @@ -41577,11 +41193,11 @@ paths: type: integer runners: type: array - items: *115 + items: *108 examples: - default: *116 + default: *109 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41603,8 +41219,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: + - *254 - *255 - - *256 responses: '200': description: Response @@ -41612,9 +41228,9 @@ paths: application/json: schema: type: array - items: *284 + items: *283 examples: - default: *285 + default: *284 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41636,8 +41252,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: + - *254 - *255 - - *256 requestBody: required: true content: @@ -41680,7 +41296,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *286 + '201': *285 '404': *7 '422': *8 x-github: @@ -41710,16 +41326,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: + - *254 - *255 - - *256 responses: '201': description: Response content: application/json: - schema: *117 + schema: *110 examples: - default: *287 + default: *286 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41747,16 +41363,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: + - *254 - *255 - - *256 responses: '201': description: Response content: application/json: - schema: *117 + schema: *110 examples: - default: *288 + default: *287 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41778,17 +41394,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: + - *254 - *255 - - *256 - - *114 + - *107 responses: '200': description: Response content: application/json: - schema: *115 + schema: *108 examples: - default: *289 + default: *288 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41809,9 +41425,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: + - *254 - *255 - - *256 - - *114 + - *107 responses: '204': description: Response @@ -41836,11 +41452,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: + - *254 - *255 - - *256 - - *114 + - *107 responses: - '200': *119 + '200': *112 '404': *7 x-github: githubCloudOnly: false @@ -41862,9 +41478,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: + - *254 - *255 - - *256 - - *114 + - *107 requestBody: required: true content: @@ -41888,7 +41504,7 @@ paths: - gpu - accelerated responses: - '200': *119 + '200': *112 '404': *7 '422': *8 x-github: @@ -41912,9 +41528,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: + - *254 - *255 - - *256 - - *114 + - *107 requestBody: required: true content: @@ -41939,7 +41555,7 @@ paths: - gpu - accelerated responses: - '200': *119 + '200': *112 '404': *7 '422': *8 x-github: @@ -41963,11 +41579,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: + - *254 - *255 - - *256 - - *114 + - *107 responses: - '200': *290 + '200': *289 '404': *7 x-github: githubCloudOnly: false @@ -41994,12 +41610,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: + - *254 - *255 - - *256 - - *114 - - *291 + - *107 + - *290 responses: - '200': *119 + '200': *112 '404': *7 '422': *8 x-github: @@ -42025,9 +41641,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: + - *254 - *255 - - *256 - - &309 + - &308 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. @@ -42035,7 +41651,7 @@ paths: required: false schema: type: string - - &310 + - &309 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -42043,7 +41659,7 @@ paths: required: false schema: type: string - - &311 + - &310 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -42052,7 +41668,7 @@ paths: required: false schema: type: string - - &312 + - &311 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 @@ -42079,7 +41695,7 @@ paths: - pending - *18 - *20 - - &313 + - &312 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)." @@ -42088,7 +41704,7 @@ paths: schema: type: string format: date-time - - &292 + - &291 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -42097,13 +41713,13 @@ paths: schema: type: boolean default: false - - &314 + - &313 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &315 + - &314 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -42126,7 +41742,7 @@ paths: type: integer workflow_runs: type: array - items: &293 + items: &292 title: Workflow Run description: An invocation of a workflow type: object @@ -42221,7 +41837,7 @@ paths: that triggered the run. type: array nullable: true - items: &334 + items: &333 title: Pull Request Minimal type: object properties: @@ -42340,7 +41956,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &338 + properties: &337 id: type: string description: SHA for the commit @@ -42391,7 +42007,7 @@ paths: - name - email nullable: true - required: &339 + required: &338 - id - tree_id - message @@ -42399,8 +42015,8 @@ paths: - author - committer nullable: true - repository: *113 - head_repository: *113 + repository: *106 + head_repository: *106 head_repository_id: type: integer example: 5 @@ -42438,7 +42054,7 @@ paths: - workflow_url - pull_requests examples: - default: &316 + default: &315 value: total_count: 1 workflow_runs: @@ -42652,7 +42268,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: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42674,24 +42290,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: + - *254 - *255 - - *256 - - &294 + - &293 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *292 + - *291 responses: '200': description: Response content: application/json: - schema: *293 + schema: *292 examples: - default: &297 + default: &296 value: id: 30433642 name: Build @@ -42932,9 +42548,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: + - *254 - *255 - - *256 - - *294 + - *293 responses: '204': description: Response @@ -42957,9 +42573,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: + - *254 - *255 - - *256 - - *294 + - *293 responses: '200': description: Response @@ -43078,15 +42694,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: + - *254 - *255 - - *256 - - *294 + - *293 responses: '201': description: Response content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -43113,12 +42729,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: + - *254 - *255 - - *256 - - *294 + - *293 - *18 - *20 - - *295 + - *294 responses: '200': description: Response @@ -43134,11 +42750,11 @@ paths: type: integer artifacts: type: array - items: *270 + items: *269 examples: - default: *296 + default: *295 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43160,25 +42776,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: + - *254 - *255 - - *256 - - *294 - - &298 + - *293 + - &297 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *292 + - *291 responses: '200': description: Response content: application/json: - schema: *293 + schema: *292 examples: - default: *297 + default: *296 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43201,10 +42817,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: + - *254 - *255 - - *256 - - *294 - - *298 + - *293 + - *297 - *18 - *20 responses: @@ -43222,9 +42838,9 @@ paths: type: integer jobs: type: array - items: *299 + items: *298 examples: - default: &300 + default: &299 value: total_count: 1 jobs: @@ -43313,7 +42929,7 @@ paths: workflow_name: CI head_branch: main headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -43337,10 +42953,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: + - *254 - *255 - - *256 - - *294 - - *298 + - *293 + - *297 responses: '302': description: Response @@ -43368,19 +42984,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: + - *254 - *255 - - *256 - - *294 + - *293 responses: '202': description: Response content: application/json: - schema: *122 + schema: *115 examples: default: value: - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43403,9 +43019,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: + - *254 - *255 - - *256 - - *294 + - *293 requestBody: required: true content: @@ -43472,19 +43088,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: + - *254 - *255 - - *256 - - *294 + - *293 responses: '202': description: Response content: application/json: - schema: *122 + schema: *115 examples: default: value: - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43507,9 +43123,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: + - *254 - *255 - - *256 - - *294 + - *293 - 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 @@ -43539,11 +43155,11 @@ paths: type: integer jobs: type: array - items: *299 + items: *298 examples: - default: *300 + default: *299 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43566,9 +43182,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: + - *254 - *255 - - *256 - - *294 + - *293 responses: '302': description: Response @@ -43595,14 +43211,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: + - *254 - *255 - - *256 - - *294 + - *293 responses: '204': description: Response '403': *29 - '500': *41 + '500': *132 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43624,9 +43240,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: + - *254 - *255 - - *256 - - *294 + - *293 responses: '200': description: Response @@ -43686,7 +43302,7 @@ paths: items: type: object properties: - type: &415 + type: &414 type: string description: The type of reviewer. enum: @@ -43696,7 +43312,7 @@ paths: reviewer: anyOf: - *19 - - *181 + - *174 required: - environment - wait_timer @@ -43771,9 +43387,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: + - *254 - *255 - - *256 - - *294 + - *293 requestBody: required: true content: @@ -43820,7 +43436,7 @@ paths: application/json: schema: type: array - items: &410 + items: &409 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -43908,8 +43524,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 required: - id - node_id @@ -43926,7 +43542,7 @@ paths: - created_at - updated_at examples: - default: &411 + default: &410 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -43982,9 +43598,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: + - *254 - *255 - - *256 - - *294 + - *293 requestBody: required: false content: @@ -44005,7 +43621,7 @@ paths: description: Response content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -44028,9 +43644,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: + - *254 - *255 - - *256 - - *294 + - *293 requestBody: required: false content: @@ -44051,7 +43667,7 @@ paths: description: Response content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -44076,9 +43692,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: + - *254 - *255 - - *256 - - *294 + - *293 responses: '200': description: Response @@ -44215,8 +43831,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -44234,11 +43850,11 @@ paths: type: integer secrets: type: array - items: *301 + items: *300 examples: - default: *302 + default: *301 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44261,16 +43877,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: + - *254 - *255 - - *256 responses: '200': description: Response content: application/json: - schema: *303 + schema: *302 examples: - default: *304 + default: *303 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44292,17 +43908,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: + - *254 - *255 - - *256 - - *121 + - *114 responses: '200': description: Response content: application/json: - schema: *301 + schema: *300 examples: - default: &428 + default: &427 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -44328,9 +43944,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: + - *254 - *255 - - *256 - - *121 + - *114 requestBody: required: true content: @@ -44358,7 +43974,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -44384,9 +44000,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: + - *254 - *255 - - *256 - - *121 + - *114 responses: '204': description: Response @@ -44411,9 +44027,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: + - *254 - *255 - - *256 - - *277 + - *276 - *20 responses: '200': @@ -44430,11 +44046,11 @@ paths: type: integer variables: type: array - items: *305 + items: *304 examples: - default: *306 + default: *305 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44455,8 +44071,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -44483,7 +44099,7 @@ paths: description: Response content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -44508,17 +44124,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: + - *254 - *255 - - *256 - - *124 + - *117 responses: '200': description: Response content: application/json: - schema: *305 + schema: *304 examples: - default: &429 + default: &428 value: name: USERNAME value: octocat @@ -44544,9 +44160,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: + - *254 - *255 - - *256 - - *124 + - *117 requestBody: required: true content: @@ -44588,9 +44204,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: + - *254 - *255 - - *256 - - *124 + - *117 responses: '204': description: Response @@ -44615,8 +44231,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -44634,7 +44250,7 @@ paths: type: integer workflows: type: array - items: &307 + items: &306 title: Workflow description: A GitHub Actions workflow type: object @@ -44718,7 +44334,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: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44741,9 +44357,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: + - *254 - *255 - - *256 - - &308 + - &307 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -44758,7 +44374,7 @@ paths: description: Response content: application/json: - schema: *307 + schema: *306 examples: default: value: @@ -44791,9 +44407,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: + - *254 - *255 - - *256 - - *308 + - *307 responses: '204': description: Response @@ -44818,9 +44434,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: + - *254 - *255 - - *256 - - *308 + - *307 responses: '204': description: Response @@ -44871,9 +44487,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: + - *254 - *255 - - *256 - - *308 + - *307 responses: '204': description: Response @@ -44900,19 +44516,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: + - *254 - *255 - - *256 + - *307 - *308 - *309 - *310 - *311 - - *312 - *18 - *20 + - *312 + - *291 - *313 - - *292 - *314 - - *315 responses: '200': description: Response @@ -44928,11 +44544,11 @@ paths: type: integer workflow_runs: type: array - items: *293 + items: *292 examples: - default: *316 + default: *315 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44956,9 +44572,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: + - *254 - *255 - - *256 - - *308 + - *307 responses: '200': description: Response @@ -45019,12 +44635,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: + - *254 - *255 - - *256 - - *42 + - *39 - *18 - - *43 - - *44 + - *40 + - *41 - name: ref description: |- The Git reference for the activities you want to list. @@ -45165,7 +44781,7 @@ paths: type: User site_admin: false headers: - Link: *39 + Link: *51 '422': *8 x-github: githubCloudOnly: false @@ -45184,8 +44800,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -45197,9 +44813,9 @@ paths: type: array items: *19 examples: - default: *184 + default: *177 headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -45222,8 +44838,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: + - *254 - *255 - - *256 - name: assignee in: path required: true @@ -45259,8 +44875,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-attestation parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -45372,11 +44988,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-attestations parameters: + - *254 - *255 - - *256 - *18 - - *43 - - *44 + - *40 + - *41 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -45416,8 +45032,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: *317 + default: *316 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45437,8 +45055,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: + - *254 - *255 - - *256 responses: '200': description: Response @@ -45446,7 +45064,7 @@ paths: application/json: schema: type: array - items: &318 + items: &317 title: Autolink reference description: An autolink reference. type: object @@ -45496,8 +45114,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -45536,9 +45154,9 @@ paths: description: response content: application/json: - schema: *318 + schema: *317 examples: - default: &319 + default: &318 value: id: 1 key_prefix: TICKET- @@ -45569,9 +45187,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: + - *254 - *255 - - *256 - - &320 + - &319 name: autolink_id description: The unique identifier of the autolink. in: path @@ -45583,9 +45201,9 @@ paths: description: Response content: application/json: - schema: *318 + schema: *317 examples: - default: *319 + default: *318 '404': *7 x-github: githubCloudOnly: false @@ -45605,9 +45223,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: + - *254 - *255 - - *256 - - *320 + - *319 responses: '204': description: Response @@ -45631,8 +45249,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: + - *254 - *255 - - *256 responses: '200': description: Response if Dependabot is enabled @@ -45680,8 +45298,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-automated-security-fixes parameters: + - *254 - *255 - - *256 responses: '204': description: Response @@ -45702,8 +45320,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-automated-security-fixes parameters: + - *254 - *255 - - *256 responses: '204': description: Response @@ -45723,8 +45341,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: + - *254 - *255 - - *256 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -45762,7 +45380,7 @@ paths: - url protected: type: boolean - protection: &322 + protection: &321 title: Branch Protection description: Branch Protection type: object @@ -45804,7 +45422,7 @@ paths: required: - contexts - checks - enforce_admins: &325 + enforce_admins: &324 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -45819,7 +45437,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &327 + required_pull_request_reviews: &326 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -45840,7 +45458,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *181 + items: *174 apps: description: The list of apps with review dismissal access. @@ -45869,7 +45487,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *181 + items: *174 apps: description: The list of apps allowed to bypass pull request requirements. @@ -45895,7 +45513,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &324 + restrictions: &323 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -46184,7 +45802,7 @@ paths: - linter protection_url: https://api.github.com/repos/octocat/hello-world/branches/master/protection headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -46202,9 +45820,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: + - *254 - *255 - - *256 - - &323 + - &322 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). @@ -46218,14 +45836,14 @@ paths: description: Response content: application/json: - schema: &333 + schema: &332 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &383 + commit: &382 title: Commit description: Commit type: object @@ -46259,7 +45877,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &321 + properties: &320 name: type: string example: '"Chris Wanstrath"' @@ -46274,7 +45892,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *321 + properties: *320 nullable: true message: type: string @@ -46295,7 +45913,7 @@ paths: required: - sha - url - verification: &435 + verification: &434 title: Verification type: object properties: @@ -46328,12 +45946,12 @@ paths: nullable: true oneOf: - *19 - - *122 + - *115 committer: nullable: true oneOf: - *19 - - *122 + - *115 parents: type: array items: @@ -46364,7 +45982,7 @@ paths: type: integer files: type: array - items: &398 + items: &397 title: Diff Entry description: Diff Entry type: object @@ -46447,7 +46065,7 @@ paths: - self protected: type: boolean - protection: *322 + protection: *321 protection_url: type: string format: uri @@ -46554,7 +46172,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *267 + '301': *266 '404': *7 x-github: githubCloudOnly: false @@ -46576,15 +46194,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: + - *254 - *255 - - *256 - - *323 + - *322 responses: '200': description: Response content: application/json: - schema: *322 + schema: *321 examples: default: value: @@ -46778,9 +46396,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: + - *254 - *255 - - *256 - - *323 + - *322 requestBody: required: true content: @@ -47035,7 +46653,7 @@ paths: url: type: string format: uri - required_status_checks: &330 + required_status_checks: &329 title: Status Check Policy description: Status Check Policy type: object @@ -47111,7 +46729,7 @@ paths: items: *19 teams: type: array - items: *181 + items: *174 apps: type: array items: *6 @@ -47129,7 +46747,7 @@ paths: items: *19 teams: type: array - items: *181 + items: *174 apps: type: array items: *6 @@ -47187,7 +46805,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *324 + restrictions: *323 required_conversation_resolution: type: object properties: @@ -47299,9 +46917,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: + - *254 - *255 - - *256 - - *323 + - *322 responses: '204': description: Response @@ -47326,17 +46944,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: + - *254 - *255 - - *256 - - *323 + - *322 responses: '200': description: Response content: application/json: - schema: *325 + schema: *324 examples: - default: &326 + default: &325 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -47358,17 +46976,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: + - *254 - *255 - - *256 - - *323 + - *322 responses: '200': description: Response content: application/json: - schema: *325 + schema: *324 examples: - default: *326 + default: *325 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47387,9 +47005,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: + - *254 - *255 - - *256 - - *323 + - *322 responses: '204': description: Response @@ -47414,17 +47032,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: + - *254 - *255 - - *256 - - *323 + - *322 responses: '200': description: Response content: application/json: - schema: *327 + schema: *326 examples: - default: &328 + default: &327 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -47520,9 +47138,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: + - *254 - *255 - - *256 - - *323 + - *322 requestBody: required: false content: @@ -47620,9 +47238,9 @@ paths: description: Response content: application/json: - schema: *327 + schema: *326 examples: - default: *328 + default: *327 '422': *16 x-github: githubCloudOnly: false @@ -47643,9 +47261,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: + - *254 - *255 - - *256 - - *323 + - *322 responses: '204': description: Response @@ -47672,17 +47290,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: + - *254 - *255 - - *256 - - *323 + - *322 responses: '200': description: Response content: application/json: - schema: *325 + schema: *324 examples: - default: &329 + default: &328 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -47705,17 +47323,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: + - *254 - *255 - - *256 - - *323 + - *322 responses: '200': description: Response content: application/json: - schema: *325 + schema: *324 examples: - default: *329 + default: *328 '404': *7 x-github: githubCloudOnly: false @@ -47735,9 +47353,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: + - *254 - *255 - - *256 - - *323 + - *322 responses: '204': description: Response @@ -47762,17 +47380,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: + - *254 - *255 - - *256 - - *323 + - *322 responses: '200': description: Response content: application/json: - schema: *330 + schema: *329 examples: - default: &331 + default: &330 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -47798,9 +47416,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: + - *254 - *255 - - *256 - - *323 + - *322 requestBody: required: false content: @@ -47852,9 +47470,9 @@ paths: description: Response content: application/json: - schema: *330 + schema: *329 examples: - default: *331 + default: *330 '404': *7 '422': *16 x-github: @@ -47876,9 +47494,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: + - *254 - *255 - - *256 - - *323 + - *322 responses: '204': description: Response @@ -47902,9 +47520,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: + - *254 - *255 - - *256 - - *323 + - *322 responses: '200': description: Response @@ -47938,9 +47556,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: + - *254 - *255 - - *256 - - *323 + - *322 requestBody: required: false content: @@ -48007,9 +47625,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: + - *254 - *255 - - *256 - - *323 + - *322 requestBody: required: false content: @@ -48073,9 +47691,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: + - *254 - *255 - - *256 - - *323 + - *322 requestBody: content: application/json: @@ -48141,15 +47759,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: + - *254 - *255 - - *256 - - *323 + - *322 responses: '200': description: Response content: application/json: - schema: *324 + schema: *323 examples: default: value: @@ -48240,9 +47858,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: + - *254 - *255 - - *256 - - *323 + - *322 responses: '204': description: Response @@ -48265,9 +47883,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: + - *254 - *255 - - *256 - - *323 + - *322 responses: '200': description: Response @@ -48277,7 +47895,7 @@ paths: type: array items: *6 examples: - default: &332 + default: &331 value: - id: 1 slug: octoapp @@ -48334,9 +47952,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: + - *254 - *255 - - *256 - - *323 + - *322 requestBody: required: true content: @@ -48370,7 +47988,7 @@ paths: type: array items: *6 examples: - default: *332 + default: *331 '422': *16 x-github: githubCloudOnly: false @@ -48391,9 +48009,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: + - *254 - *255 - - *256 - - *323 + - *322 requestBody: required: true content: @@ -48427,7 +48045,7 @@ paths: type: array items: *6 examples: - default: *332 + default: *331 '422': *16 x-github: githubCloudOnly: false @@ -48448,9 +48066,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: + - *254 - *255 - - *256 - - *323 + - *322 requestBody: required: true content: @@ -48484,7 +48102,7 @@ paths: type: array items: *6 examples: - default: *332 + default: *331 '422': *16 x-github: githubCloudOnly: false @@ -48506,9 +48124,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: + - *254 - *255 - - *256 - - *323 + - *322 responses: '200': description: Response @@ -48516,9 +48134,9 @@ paths: application/json: schema: type: array - items: *181 + items: *174 examples: - default: *198 + default: *192 '404': *7 x-github: githubCloudOnly: false @@ -48538,9 +48156,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: + - *254 - *255 - - *256 - - *323 + - *322 requestBody: required: false content: @@ -48576,9 +48194,9 @@ paths: application/json: schema: type: array - items: *181 + items: *174 examples: - default: *198 + default: *192 '422': *16 x-github: githubCloudOnly: false @@ -48599,9 +48217,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: + - *254 - *255 - - *256 - - *323 + - *322 requestBody: required: false content: @@ -48637,9 +48255,9 @@ paths: application/json: schema: type: array - items: *181 + items: *174 examples: - default: *198 + default: *192 '422': *16 x-github: githubCloudOnly: false @@ -48660,9 +48278,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: + - *254 - *255 - - *256 - - *323 + - *322 requestBody: content: application/json: @@ -48697,9 +48315,9 @@ paths: application/json: schema: type: array - items: *181 + items: *174 examples: - default: *198 + default: *192 '422': *16 x-github: githubCloudOnly: false @@ -48721,9 +48339,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: + - *254 - *255 - - *256 - - *323 + - *322 responses: '200': description: Response @@ -48733,7 +48351,7 @@ paths: type: array items: *19 examples: - default: *184 + default: *177 '404': *7 x-github: githubCloudOnly: false @@ -48757,9 +48375,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: + - *254 - *255 - - *256 - - *323 + - *322 requestBody: required: true content: @@ -48792,7 +48410,7 @@ paths: type: array items: *19 examples: - default: *184 + default: *177 '422': *16 x-github: githubCloudOnly: false @@ -48817,9 +48435,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: + - *254 - *255 - - *256 - - *323 + - *322 requestBody: required: true content: @@ -48852,7 +48470,7 @@ paths: type: array items: *19 examples: - default: *184 + default: *177 '422': *16 x-github: githubCloudOnly: false @@ -48877,9 +48495,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: + - *254 - *255 - - *256 - - *323 + - *322 requestBody: required: true content: @@ -48912,7 +48530,7 @@ paths: type: array items: *19 examples: - default: *184 + default: *177 '422': *16 x-github: githubCloudOnly: false @@ -48939,9 +48557,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: + - *254 - *255 - - *256 - - *323 + - *322 requestBody: required: true content: @@ -48963,7 +48581,7 @@ paths: description: Response content: application/json: - schema: *333 + schema: *332 examples: default: value: @@ -49079,8 +48697,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -49359,7 +48977,7 @@ paths: description: Response content: application/json: - schema: &335 + schema: &334 title: CheckRun description: A check performed on the code of a given code change type: object @@ -49470,16 +49088,16 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 pull_requests: description: Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check. type: array - items: *334 - deployment: &623 + items: *333 + deployment: &622 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -49546,8 +49164,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 required: - id - node_id @@ -49759,9 +49377,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: + - *254 - *255 - - *256 - - &336 + - &335 name: check_run_id description: The unique identifier of the check run. in: path @@ -49773,9 +49391,9 @@ paths: description: Response content: application/json: - schema: *335 + schema: *334 examples: - default: &337 + default: &336 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -49875,9 +49493,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: + - *254 - *255 - - *256 - - *336 + - *335 requestBody: required: true content: @@ -50117,9 +49735,9 @@ paths: description: Response content: application/json: - schema: *335 + schema: *334 examples: - default: *337 + default: *336 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50139,9 +49757,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: + - *254 - *255 - - *256 - - *336 + - *335 - *18 - *20 responses: @@ -50216,7 +49834,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: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50238,15 +49856,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: + - *254 - *255 - - *256 - - *336 + - *335 responses: '201': description: Response content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -50284,8 +49902,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -50307,7 +49925,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &340 + schema: &339 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -50371,7 +49989,7 @@ paths: nullable: true pull_requests: type: array - items: *334 + items: *333 nullable: true app: title: GitHub app @@ -50382,9 +50000,9 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 - repository: *113 + properties: *54 + required: *55 + repository: *106 created_at: type: string format: date-time @@ -50393,12 +50011,12 @@ paths: type: string format: date-time nullable: true - head_commit: &649 + head_commit: &648 title: Simple Commit description: A commit. type: object - properties: *338 - required: *339 + properties: *337 + required: *338 latest_check_runs_count: type: integer check_runs_url: @@ -50426,7 +50044,7 @@ paths: - check_runs_url - pull_requests examples: - default: &341 + default: &340 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -50717,9 +50335,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *340 + schema: *339 examples: - default: *341 + default: *340 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50738,8 +50356,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -50800,7 +50418,7 @@ paths: required: - app_id - setting - repository: *113 + repository: *106 examples: default: value: @@ -51048,9 +50666,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: + - *254 - *255 - - *256 - - &342 + - &341 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -51062,9 +50680,9 @@ paths: description: Response content: application/json: - schema: *340 + schema: *339 examples: - default: *341 + default: *340 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51087,17 +50705,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: + - *254 - *255 - - *256 - - *342 - - &391 + - *341 + - &390 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &392 + - &391 name: status description: Returns check runs with the specified `status`. in: query @@ -51136,9 +50754,9 @@ paths: type: integer check_runs: type: array - items: *335 + items: *334 examples: - default: &393 + default: &392 value: total_count: 1 check_runs: @@ -51220,7 +50838,7 @@ paths: url: https://api.github.com/repos/github/hello-world name: hello-world headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51240,15 +50858,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: + - *254 - *255 - - *256 - - *342 + - *341 responses: '201': description: Response content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -51275,30 +50893,30 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: + - *254 - *255 - - *256 + - *342 - *343 - - *344 - *20 - *18 - - &357 + - &356 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: *345 - - &358 + schema: *344 + - &357 name: pr description: The number of the pull request for the results you want to list. in: query required: false schema: type: integer - - *42 - - *43 - - *44 + - *39 + - *40 + - *41 - name: sort description: The property by which to sort the results. in: query @@ -51314,13 +50932,13 @@ paths: be returned. in: query required: false - schema: *346 + schema: *345 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *347 + schema: *346 responses: '200': description: Response @@ -51331,14 +50949,14 @@ paths: items: type: object properties: - number: *48 - created_at: *49 - updated_at: *127 - url: *50 - html_url: *51 - instances_url: *348 - state: *132 - fixed_at: *128 + number: *46 + created_at: *47 + updated_at: *120 + url: *48 + html_url: *49 + instances_url: *347 + state: *125 + fixed_at: *121 dismissed_by: title: Simple User description: A GitHub user. @@ -51346,12 +50964,12 @@ paths: properties: *4 required: *5 nullable: true - dismissed_at: *129 - dismissed_reason: *349 - dismissed_comment: *350 - rule: *351 - tool: *352 - most_recent_instance: *353 + dismissed_at: *122 + dismissed_reason: *348 + dismissed_comment: *349 + rule: *350 + tool: *351 + most_recent_instance: *352 required: - number - created_at @@ -51467,14 +51085,14 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &354 + '403': &353 description: Response if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *7 - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51494,9 +51112,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: + - *254 - *255 - - *256 - - &355 + - &354 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -51504,23 +51122,23 @@ paths: field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. required: true - schema: *48 + schema: *46 responses: '200': description: Response content: application/json: - schema: &356 + schema: &355 type: object properties: - number: *48 - created_at: *49 - updated_at: *127 - url: *50 - html_url: *51 - instances_url: *348 - state: *132 - fixed_at: *128 + number: *46 + created_at: *47 + updated_at: *120 + url: *48 + html_url: *49 + instances_url: *347 + state: *125 + fixed_at: *121 dismissed_by: title: Simple User description: A GitHub user. @@ -51528,9 +51146,9 @@ paths: properties: *4 required: *5 nullable: true - dismissed_at: *129 - dismissed_reason: *349 - dismissed_comment: *350 + dismissed_at: *122 + dismissed_reason: *348 + dismissed_comment: *349 rule: type: object properties: @@ -51584,8 +51202,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *352 - most_recent_instance: *353 + tool: *351 + most_recent_instance: *352 required: - number - created_at @@ -51674,9 +51292,9 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *354 + '403': *353 '404': *7 - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51694,9 +51312,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: + - *254 - *255 - - *256 - - *355 + - *354 requestBody: required: true content: @@ -51711,8 +51329,8 @@ paths: enum: - open - dismissed - dismissed_reason: *349 - dismissed_comment: *350 + dismissed_reason: *348 + dismissed_comment: *349 required: - state examples: @@ -51727,7 +51345,7 @@ paths: description: Response content: application/json: - schema: *356 + schema: *355 examples: default: value: @@ -51802,14 +51420,14 @@ paths: classifications: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances - '403': &363 + '403': &362 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *7 - '503': *63 + '503': *58 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -51829,13 +51447,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: + - *254 - *255 - - *256 - - *355 + - *354 - *20 - *18 + - *356 - *357 - - *358 responses: '200': description: Response @@ -51843,7 +51461,7 @@ paths: application/json: schema: type: array - items: *353 + items: *352 examples: default: value: @@ -51882,9 +51500,9 @@ paths: end_column: 50 classifications: - source - '403': *354 + '403': *353 '404': *7 - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51916,29 +51534,29 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: + - *254 - *255 - - *256 + - *342 - *343 - - *344 - *20 - *18 - - *358 + - *357 - 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: *345 + schema: *344 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &361 + schema: &360 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 - - *42 + - *39 - name: sort description: The property by which to sort the results. in: query @@ -51955,23 +51573,23 @@ paths: application/json: schema: type: array - items: &362 + items: &361 type: object properties: - ref: *345 - commit_sha: &371 + ref: *344 + commit_sha: &370 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: *359 + analysis_key: *358 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *360 + category: *359 error: type: string example: error reading field xyz @@ -51995,8 +51613,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *361 - tool: *352 + sarif_id: *360 + tool: *351 deletable: type: boolean warning: @@ -52057,9 +51675,9 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *354 + '403': *353 '404': *7 - '503': *63 + '503': *58 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -52093,8 +51711,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: + - *254 - *255 - - *256 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -52107,7 +51725,7 @@ paths: description: Response content: application/json: - schema: *362 + schema: *361 examples: response: summary: application/json response @@ -52161,9 +51779,9 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *354 + '403': *353 '404': *7 - '503': *63 + '503': *58 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -52243,8 +51861,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: + - *254 - *255 - - *256 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -52297,9 +51915,9 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *15 - '403': *363 + '403': *362 '404': *7 - '503': *63 + '503': *58 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -52319,8 +51937,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: + - *254 - *255 - - *256 responses: '200': description: Response @@ -52328,7 +51946,7 @@ paths: application/json: schema: type: array - items: &364 + items: &363 title: CodeQL Database description: A CodeQL database. type: object @@ -52439,9 +52057,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': *354 + '403': *353 '404': *7 - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52468,8 +52086,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: + - *254 - *255 - - *256 - name: language in: path description: The language of the CodeQL database. @@ -52481,7 +52099,7 @@ paths: description: Response content: application/json: - schema: *364 + schema: *363 examples: default: value: @@ -52513,11 +52131,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': &400 + '302': &399 description: Found - '403': *354 + '403': *353 '404': *7 - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52537,8 +52155,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: + - *254 - *255 - - *256 - name: language in: path description: The language of the CodeQL database. @@ -52548,9 +52166,9 @@ paths: responses: '204': description: Response - '403': *363 + '403': *362 '404': *7 - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52576,8 +52194,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -52586,7 +52204,7 @@ paths: type: object additionalProperties: false properties: - language: &365 + language: &364 type: string description: The language targeted by the CodeQL query enum: @@ -52664,7 +52282,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &369 + schema: &368 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -52672,9 +52290,9 @@ paths: id: type: integer description: The ID of the variant analysis. - controller_repo: *52 + controller_repo: *50 actor: *19 - query_language: *365 + query_language: *364 query_pack_url: type: string description: The download url for the query pack. @@ -52721,7 +52339,7 @@ paths: items: type: object properties: - repository: &366 + repository: &365 title: Repository Identifier description: Repository Identifier type: object @@ -52757,7 +52375,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &370 + analysis_status: &369 type: string description: The new status of the CodeQL variant analysis repository task. @@ -52789,7 +52407,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &367 + access_mismatch_repos: &366 type: object properties: repository_count: @@ -52803,7 +52421,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: *366 + items: *365 required: - repository_count - repositories @@ -52825,8 +52443,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *367 - over_limit_repos: *367 + no_codeql_db_repos: *366 + over_limit_repos: *366 required: - access_mismatch_repos - not_found_repos @@ -52842,7 +52460,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &368 + value: &367 summary: Default response value: id: 1 @@ -52994,17 +52612,17 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *368 + value: *367 repository_lists: summary: Response for a successful variant analysis submission - value: *368 + value: *367 '404': *7 '422': description: Unable to process variant analysis submission content: application/json: schema: *3 - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53025,8 +52643,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: + - *254 - *255 - - *256 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -53038,11 +52656,11 @@ paths: description: Response content: application/json: - schema: *369 + schema: *368 examples: - default: *368 + default: *367 '404': *7 - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53063,7 +52681,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: - - *255 + - *254 - name: repo in: path description: The name of the controller repository. @@ -53097,8 +52715,8 @@ paths: schema: type: object properties: - repository: *52 - analysis_status: *370 + repository: *50 + analysis_status: *369 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -53202,7 +52820,7 @@ paths: source_location_prefix: "/" artifact_url: https://example.com '404': *7 - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53223,8 +52841,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: + - *254 - *255 - - *256 responses: '200': description: Response @@ -53285,9 +52903,9 @@ paths: query_suite: default updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *354 + '403': *353 '404': *7 - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53306,8 +52924,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -53363,7 +52981,7 @@ paths: description: Response content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -53388,7 +53006,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *363 + '403': *362 '404': *7 '409': description: Response if there is already a validation run in progress with @@ -53396,7 +53014,7 @@ paths: content: application/json: schema: *3 - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53453,8 +53071,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -53462,7 +53080,7 @@ paths: schema: type: object properties: - commit_sha: *371 + commit_sha: *370 ref: type: string description: |- @@ -53520,7 +53138,7 @@ paths: schema: type: object properties: - id: *361 + id: *360 url: type: string description: The REST API URL for checking the status of the upload. @@ -53534,11 +53152,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': *363 + '403': *362 '404': *7 '413': description: Payload Too Large if the sarif field is too large - '503': *63 + '503': *58 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -53557,8 +53175,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: + - *254 - *255 - - *256 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -53604,10 +53222,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': *354 + '403': *353 '404': description: Not Found if the sarif id does not match any upload - '503': *63 + '503': *58 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -53629,8 +53247,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: + - *254 - *255 - - *256 responses: '200': description: Response @@ -53654,7 +53272,7 @@ paths: - failed - updating - removed_by_enterprise - configuration: *133 + configuration: *126 examples: default: value: @@ -53683,7 +53301,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': *138 + '204': *131 '304': *37 '403': *29 '404': *7 @@ -53708,8 +53326,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: + - *254 - *255 - - *256 - 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 @@ -53829,8 +53447,8 @@ paths: parameters: - *18 - *20 + - *254 - *255 - - *256 responses: '200': description: Response @@ -53846,7 +53464,7 @@ paths: type: integer codespaces: type: array - items: *185 + items: *178 examples: default: value: @@ -54122,7 +53740,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': *41 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -54144,8 +53762,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -54208,22 +53826,22 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *185 + schema: *178 examples: - default: *372 + default: *371 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *185 + schema: *178 examples: - default: *372 + default: *371 '400': *15 '401': *25 '403': *29 '404': *7 - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54247,8 +53865,8 @@ paths: parameters: - *18 - *20 + - *254 - *255 - - *256 responses: '200': description: Response @@ -54288,7 +53906,7 @@ paths: - path: ".devcontainer.json" display_name: Default project configuration total_count: 3 - '500': *41 + '500': *132 '400': *15 '401': *25 '403': *29 @@ -54312,8 +53930,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: + - *254 - *255 - - *256 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -54348,14 +53966,14 @@ paths: type: integer machines: type: array - items: &580 + items: &579 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *373 - required: *374 + properties: *372 + required: *373 examples: - default: &581 + default: &580 value: total_count: 2 machines: @@ -54372,7 +53990,7 @@ paths: memory_in_bytes: 34359738368 cpus: 8 '304': *37 - '500': *41 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -54395,8 +54013,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: + - *254 - *255 - - *256 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -54480,8 +54098,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: + - *254 - *255 - - *256 - 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 @@ -54526,7 +54144,7 @@ paths: '403': *29 '404': *7 '422': *16 - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54547,8 +54165,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -54566,7 +54184,7 @@ paths: type: integer secrets: type: array - items: &378 + items: &377 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -54586,9 +54204,9 @@ paths: - created_at - updated_at examples: - default: *375 + default: *374 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54609,16 +54227,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: + - *254 - *255 - - *256 responses: '200': description: Response content: application/json: - schema: *376 + schema: *375 examples: - default: *377 + default: *376 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54638,17 +54256,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: + - *254 - *255 - - *256 - - *121 + - *114 responses: '200': description: Response content: application/json: - schema: *378 + schema: *377 examples: - default: *379 + default: *378 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54668,9 +54286,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: + - *254 - *255 - - *256 - - *121 + - *114 requestBody: required: true content: @@ -54698,7 +54316,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -54722,9 +54340,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: + - *254 - *255 - - *256 - - *121 + - *114 responses: '204': description: Response @@ -54752,8 +54370,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: + - *254 - *255 - - *256 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -54795,7 +54413,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &380 + properties: &379 login: type: string example: octocat @@ -54888,7 +54506,7 @@ paths: user_view_type: type: string example: public - required: &381 + required: &380 - avatar_url - events_url - followers_url @@ -54937,7 +54555,7 @@ paths: admin: false role_name: write headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -54962,9 +54580,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: + - *254 - *255 - - *256 - - *126 + - *119 responses: '204': description: Response if user is a collaborator @@ -55006,9 +54624,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: + - *254 - *255 - - *256 - - *126 + - *119 requestBody: required: false content: @@ -55034,7 +54652,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &448 + schema: &447 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -55045,7 +54663,7 @@ paths: example: 42 type: integer format: int64 - repository: *113 + repository: *106 invitee: title: Simple User description: A GitHub user. @@ -55256,9 +54874,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: + - *254 - *255 - - *256 - - *126 + - *119 responses: '204': description: No Content when collaborator was removed from the repository. @@ -55287,9 +54905,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: + - *254 - *255 - - *256 - - *126 + - *119 responses: '200': description: if user has admin permissions @@ -55309,8 +54927,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *380 - required: *381 + properties: *379 + required: *380 nullable: true required: - permission @@ -55365,8 +54983,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -55376,7 +54994,7 @@ paths: application/json: schema: type: array - items: &382 + items: &381 title: Commit Comment description: Commit Comment type: object @@ -55417,8 +55035,8 @@ paths: updated_at: type: string format: date-time - author_association: *61 - reactions: *62 + author_association: *56 + reactions: *57 required: - url - html_url @@ -55434,7 +55052,7 @@ paths: - created_at - updated_at examples: - default: &385 + default: &384 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -55468,7 +55086,7 @@ paths: updated_at: '2011-04-14T16:00:49Z' author_association: COLLABORATOR headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55493,17 +55111,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: + - *254 - *255 - - *256 - - *74 + - *69 responses: '200': description: Response content: application/json: - schema: *382 + schema: *381 examples: - default: &386 + default: &385 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -55560,9 +55178,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: + - *254 - *255 - - *256 - - *74 + - *69 requestBody: required: true content: @@ -55584,7 +55202,7 @@ paths: description: Response content: application/json: - schema: *382 + schema: *381 examples: default: value: @@ -55635,9 +55253,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: + - *254 - *255 - - *256 - - *74 + - *69 responses: '204': description: Response @@ -55658,9 +55276,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: + - *254 - *255 - - *256 - - *74 + - *69 - 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. @@ -55686,11 +55304,11 @@ paths: application/json: schema: type: array - items: *248 + items: *247 examples: - default: *250 + default: *249 headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -55709,9 +55327,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: + - *254 - *255 - - *256 - - *74 + - *69 requestBody: required: true content: @@ -55743,16 +55361,16 @@ paths: description: Reaction exists content: application/json: - schema: *248 + schema: *247 examples: - default: *249 + default: *248 '201': description: Reaction created content: application/json: - schema: *248 + schema: *247 examples: - default: *249 + default: *248 '422': *16 x-github: githubCloudOnly: false @@ -55774,10 +55392,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: + - *254 - *255 - - *256 - - *74 - - *251 + - *69 + - *250 responses: '204': description: Response @@ -55826,8 +55444,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: + - *254 - *255 - - *256 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -55883,9 +55501,9 @@ paths: application/json: schema: type: array - items: *383 + items: *382 examples: - default: &499 + default: &498 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -55955,11 +55573,11 @@ paths: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e headers: - Link: *39 - '500': *41 + Link: *51 + '500': *132 '400': *15 '404': *7 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55979,9 +55597,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: + - *254 - *255 - - *256 - - &384 + - &383 name: commit_sha description: The SHA of the commit. in: path @@ -56028,7 +55646,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc protected: false '422': *16 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56053,9 +55671,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: + - *254 - *255 - - *256 - - *384 + - *383 - *18 - *20 responses: @@ -56065,11 +55683,11 @@ paths: application/json: schema: type: array - items: *382 + items: *381 examples: - default: *385 + default: *384 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56095,9 +55713,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: + - *254 - *255 - - *256 - - *384 + - *383 requestBody: required: true content: @@ -56132,9 +55750,9 @@ paths: description: Response content: application/json: - schema: *382 + schema: *381 examples: - default: *386 + default: *385 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -56162,9 +55780,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: + - *254 - *255 - - *256 - - *384 + - *383 - *18 - *20 responses: @@ -56174,7 +55792,7 @@ paths: application/json: schema: type: array - items: &490 + items: &489 title: Pull Request Simple description: Pull Request Simple type: object @@ -56280,8 +55898,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *387 - required: *388 + properties: *386 + required: *387 nullable: true active_lock_reason: type: string @@ -56326,7 +55944,7 @@ paths: nullable: true requested_teams: type: array - items: *181 + items: *174 nullable: true head: type: object @@ -56335,7 +55953,7 @@ paths: type: string ref: type: string - repo: *58 + repo: *53 sha: type: string user: @@ -56358,7 +55976,7 @@ paths: type: string ref: type: string - repo: *58 + repo: *53 sha: type: string user: @@ -56377,7 +55995,7 @@ paths: _links: type: object properties: - comments: &389 + comments: &388 title: Link description: Hypermedia Link type: object @@ -56386,13 +56004,13 @@ paths: type: string required: - href - commits: *389 - statuses: *389 - html: *389 - issue: *389 - review_comments: *389 - review_comment: *389 - self: *389 + commits: *388 + statuses: *388 + html: *388 + issue: *388 + review_comments: *388 + review_comment: *388 + self: *388 required: - comments - commits @@ -56402,8 +56020,8 @@ paths: - review_comments - review_comment - self - author_association: *61 - auto_merge: &492 + author_association: *56 + auto_merge: &491 title: Auto merge description: The status of auto merging a pull request. type: object @@ -56466,7 +56084,7 @@ paths: - author_association - auto_merge examples: - default: &491 + default: &490 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -56945,8 +56563,8 @@ paths: auto_merge: draft: false headers: - Link: *39 - '409': *134 + Link: *51 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57003,11 +56621,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: + - *254 - *255 - - *256 - *20 - *18 - - &390 + - &389 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)" @@ -57022,9 +56640,9 @@ paths: description: Response content: application/json: - schema: *383 + schema: *382 examples: - default: &477 + default: &476 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -57110,9 +56728,9 @@ paths: ..... '422': *16 '404': *7 - '500': *41 - '503': *63 - '409': *134 + '500': *132 + '503': *58 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57137,11 +56755,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: + - *254 - *255 - - *256 + - *389 - *390 - *391 - - *392 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -57175,11 +56793,11 @@ paths: type: integer check_runs: type: array - items: *335 + items: *334 examples: - default: *393 + default: *392 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57202,9 +56820,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: + - *254 - *255 - - *256 - - *390 + - *389 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -57212,7 +56830,7 @@ paths: schema: type: integer example: 1 - - *391 + - *390 - *18 - *20 responses: @@ -57230,7 +56848,7 @@ paths: type: integer check_suites: type: array - items: *340 + items: *339 examples: default: value: @@ -57405,7 +57023,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: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57430,9 +57048,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: + - *254 - *255 - - *256 - - *390 + - *389 - *18 - *20 responses: @@ -57499,7 +57117,7 @@ paths: type: string total_count: type: integer - repository: *113 + repository: *106 commit_url: type: string format: uri @@ -57630,9 +57248,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: + - *254 - *255 - - *256 - - *390 + - *389 - *18 - *20 responses: @@ -57642,7 +57260,7 @@ paths: application/json: schema: type: array - items: &554 + items: &553 title: Status description: The status of a commit. type: object @@ -57722,8 +57340,8 @@ paths: type: User site_admin: false headers: - Link: *39 - '301': *267 + Link: *51 + '301': *266 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57751,8 +57369,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: + - *254 - *255 - - *256 responses: '200': description: Response @@ -57781,20 +57399,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *394 - required: *395 + properties: *393 + required: *394 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &396 + properties: &395 url: type: string format: uri html_url: type: string format: uri - required: &397 + required: &396 - url - html_url nullable: true @@ -57802,32 +57420,32 @@ paths: title: License Simple description: License Simple type: object - properties: *76 - required: *77 + properties: *71 + required: *72 nullable: true contributing: title: Community Health File type: object - properties: *396 - required: *397 + properties: *395 + required: *396 nullable: true readme: title: Community Health File type: object - properties: *396 - required: *397 + properties: *395 + required: *396 nullable: true issue_template: title: Community Health File type: object - properties: *396 - required: *397 + properties: *395 + required: *396 nullable: true pull_request_template: title: Community Health File type: object - properties: *396 - required: *397 + properties: *395 + required: *396 nullable: true required: - code_of_conduct @@ -57954,8 +57572,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: + - *254 - *255 - - *256 - *20 - *18 - name: basehead @@ -57998,8 +57616,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *383 - merge_base_commit: *383 + base_commit: *382 + merge_base_commit: *382 status: type: string enum: @@ -58019,10 +57637,10 @@ paths: example: 6 commits: type: array - items: *383 + items: *382 files: type: array - items: *398 + items: *397 required: - url - html_url @@ -58265,8 +57883,8 @@ paths: patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" '404': *7 - '500': *41 - '503': *63 + '500': *132 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58308,8 +57926,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: + - *254 - *255 - - *256 - name: path description: path parameter in: path @@ -58450,7 +58068,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &399 + response-if-content-is-a-file: &398 summary: Response if content is a file value: type: file @@ -58582,7 +58200,7 @@ paths: - size - type - url - - &504 + - &503 title: Content File description: Content File type: object @@ -58783,7 +58401,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *399 + response-if-content-is-a-file: *398 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -58852,7 +58470,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *7 '403': *29 - '302': *400 + '302': *399 '304': *37 x-github: githubCloudOnly: false @@ -58875,8 +58493,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: + - *254 - *255 - - *256 - name: path description: path parameter in: path @@ -58969,7 +58587,7 @@ paths: description: Response content: application/json: - schema: &401 + schema: &400 title: File Commit description: File Commit type: object @@ -59121,7 +58739,7 @@ paths: description: Response content: application/json: - schema: *401 + schema: *400 examples: example-for-creating-a-file: value: @@ -59175,7 +58793,7 @@ paths: schema: oneOf: - *3 - - &430 + - &429 description: Repository rule violation was detected type: object properties: @@ -59196,7 +58814,7 @@ paths: items: type: object properties: - placeholder_id: &546 + placeholder_id: &545 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -59228,8 +58846,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: + - *254 - *255 - - *256 - name: path description: path parameter in: path @@ -59290,7 +58908,7 @@ paths: description: Response content: application/json: - schema: *401 + schema: *400 examples: default: value: @@ -59324,8 +58942,8 @@ paths: verified_at: '422': *16 '404': *7 - '409': *134 - '503': *63 + '409': *127 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59345,8 +58963,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: + - *254 - *255 - - *256 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -59446,7 +59064,7 @@ paths: site_admin: false contributions: 32 headers: - Link: *39 + Link: *51 '204': description: Response if repository is empty '403': *29 @@ -59469,21 +59087,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: + - *254 - *255 - - *256 - - *143 - - *144 - - *145 - - *146 + - *136 + - *137 + - *138 + - *139 - name: manifest in: query description: A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. schema: type: string - - *147 - - *148 - - *42 + - *140 + - *141 + - *39 - name: page description: "**Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead." @@ -59500,10 +59118,10 @@ paths: schema: type: integer default: 30 - - *43 - - *44 - - *149 - - *150 + - *40 + - *41 + - *142 + - *143 responses: '200': description: Response @@ -59511,11 +59129,11 @@ paths: application/json: schema: type: array - items: &404 + items: &403 type: object description: A Dependabot alert. properties: - number: *48 + number: *46 state: type: string description: The state of the Dependabot alert. @@ -59530,7 +59148,7 @@ paths: description: Details for the vulnerable dependency. readOnly: true properties: - package: *45 + package: *42 manifest_path: type: string description: The full path to the dependency manifest file, @@ -59544,13 +59162,13 @@ paths: enum: - development - runtime - security_advisory: *402 - security_vulnerability: *47 - url: *50 - html_url: *51 - created_at: *49 - updated_at: *127 - dismissed_at: *129 + security_advisory: *401 + security_vulnerability: *44 + url: *48 + html_url: *49 + created_at: *47 + updated_at: *120 + dismissed_at: *122 dismissed_by: title: Simple User description: A GitHub user. @@ -59574,8 +59192,8 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: *128 - auto_dismissed_at: *403 + fixed_at: *121 + auto_dismissed_at: *402 required: - number - state @@ -59802,9 +59420,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: + - *254 - *255 - - *256 - - &405 + - &404 name: alert_number in: path description: |- @@ -59813,13 +59431,13 @@ paths: or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation. required: true - schema: *48 + schema: *46 responses: '200': description: Response content: application/json: - schema: *404 + schema: *403 examples: default: value: @@ -59929,9 +59547,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: + - *254 - *255 - - *256 - - *405 + - *404 requestBody: required: true content: @@ -59976,7 +59594,7 @@ paths: description: Response content: application/json: - schema: *404 + schema: *403 examples: default: value: @@ -60082,7 +59700,7 @@ paths: '400': *15 '403': *29 '404': *7 - '409': *134 + '409': *127 '422': *8 x-github: githubCloudOnly: false @@ -60105,8 +59723,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -60124,7 +59742,7 @@ paths: type: integer secrets: type: array - items: &408 + items: &407 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -60155,7 +59773,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60177,16 +59795,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: + - *254 - *255 - - *256 responses: '200': description: Response content: application/json: - schema: *406 + schema: *405 examples: - default: *407 + default: *406 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60206,15 +59824,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: + - *254 - *255 - - *256 - - *121 + - *114 responses: '200': description: Response content: application/json: - schema: *408 + schema: *407 examples: default: value: @@ -60240,9 +59858,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: + - *254 - *255 - - *256 - - *121 + - *114 requestBody: required: true content: @@ -60270,7 +59888,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -60294,9 +59912,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: + - *254 - *255 - - *256 - - *121 + - *114 responses: '204': description: Response @@ -60318,8 +59936,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: + - *254 - *255 - - *256 - 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 @@ -60455,7 +60073,7 @@ paths: advisory_summary: Ruby OpenID advisory_url: https://github.com/advisories/GHSA-fqfj-cmh6-hj49 headers: - Link: *39 + Link: *51 '404': *7 '403': description: Response if GitHub Advanced Security is not enabled for this @@ -60479,8 +60097,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: + - *254 - *255 - - *256 responses: '200': description: Response @@ -60696,7 +60314,7 @@ paths: spdxElementId: SPDXRef-DOCUMENT relatedSpdxElement: SPDXRef-Repository headers: - Link: *39 + Link: *51 '404': *7 '403': *29 x-github: @@ -60719,8 +60337,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: + - *254 - *255 - - *256 requestBody: required: true content: @@ -60795,7 +60413,7 @@ paths: - version - url additionalProperties: false - metadata: &409 + metadata: &408 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -60828,7 +60446,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *409 + metadata: *408 resolved: type: object description: A collection of resolved package dependencies. @@ -60841,7 +60459,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *409 + metadata: *408 relationship: type: string description: A notation of whether a dependency is requested @@ -60970,8 +60588,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: + - *254 - *255 - - *256 - name: sha description: The SHA recorded at creation time. in: query @@ -61011,11 +60629,11 @@ paths: application/json: schema: type: array - items: *410 + items: *409 examples: - default: *411 + default: *410 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61079,8 +60697,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -61161,7 +60779,7 @@ paths: description: Response content: application/json: - schema: *410 + schema: *409 examples: simple-example: summary: Simple example @@ -61234,9 +60852,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: + - *254 - *255 - - *256 - - &412 + - &411 name: deployment_id description: deployment_id parameter in: path @@ -61248,7 +60866,7 @@ paths: description: Response content: application/json: - schema: *410 + schema: *409 examples: default: value: @@ -61313,9 +60931,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: + - *254 - *255 - - *256 - - *412 + - *411 responses: '204': description: Response @@ -61337,9 +60955,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: + - *254 - *255 - - *256 - - *412 + - *411 - *18 - *20 responses: @@ -61349,7 +60967,7 @@ paths: application/json: schema: type: array - items: &413 + items: &412 title: Deployment Status description: The status of a deployment. type: object @@ -61440,8 +61058,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 required: - id - node_id @@ -61490,7 +61108,7 @@ paths: environment_url: https://test-branch.lab.acme.com log_url: https://example.com/deployment/42/output headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -61510,9 +61128,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: + - *254 - *255 - - *256 - - *412 + - *411 requestBody: required: true content: @@ -61587,9 +61205,9 @@ paths: description: Response content: application/json: - schema: *413 + schema: *412 examples: - default: &414 + default: &413 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -61645,9 +61263,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: + - *254 - *255 - - *256 - - *412 + - *411 - name: status_id in: path required: true @@ -61658,9 +61276,9 @@ paths: description: Response content: application/json: - schema: *413 + schema: *412 examples: - default: *414 + default: *413 '404': *7 x-github: githubCloudOnly: false @@ -61685,8 +61303,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -61743,8 +61361,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -61761,7 +61379,7 @@ paths: type: integer environments: type: array - items: &416 + items: &415 title: Environment description: Details of a deployment environment type: object @@ -61813,7 +61431,7 @@ paths: type: type: string example: wait_timer - wait_timer: &418 + wait_timer: &417 type: integer example: 30 description: The amount of time to delay a job after @@ -61850,11 +61468,11 @@ paths: items: type: object properties: - type: *415 + type: *414 reviewer: anyOf: - *19 - - *181 + - *174 required: - id - node_id @@ -61874,7 +61492,7 @@ paths: - id - node_id - type - deployment_branch_policy: &419 + deployment_branch_policy: &418 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -61990,9 +61608,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: + - *254 - *255 - - *256 - - &417 + - &416 name: environment_name in: path required: true @@ -62005,9 +61623,9 @@ paths: description: Response content: application/json: - schema: *416 + schema: *415 examples: - default: &420 + default: &419 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -62091,9 +61709,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: + - *254 - *255 - - *256 - - *417 + - *416 requestBody: required: false content: @@ -62102,7 +61720,7 @@ paths: type: object nullable: true properties: - wait_timer: *418 + wait_timer: *417 prevent_self_review: type: boolean example: false @@ -62119,13 +61737,13 @@ paths: items: type: object properties: - type: *415 + type: *414 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *419 + deployment_branch_policy: *418 additionalProperties: false examples: default: @@ -62145,9 +61763,9 @@ paths: description: Response content: application/json: - schema: *416 + schema: *415 examples: - default: *420 + default: *419 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -62171,9 +61789,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: + - *254 - *255 - - *256 - - *417 + - *416 responses: '204': description: Default response @@ -62198,9 +61816,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: + - *254 - *255 - - *256 - - *417 + - *416 - *18 - *20 responses: @@ -62218,7 +61836,7 @@ paths: example: 2 branch_policies: type: array - items: &421 + items: &420 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -62275,9 +61893,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: + - *254 - *255 - - *256 - - *417 + - *416 requestBody: required: true content: @@ -62323,9 +61941,9 @@ paths: description: Response content: application/json: - schema: *421 + schema: *420 examples: - example-wildcard: &422 + example-wildcard: &421 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -62367,10 +61985,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: + - *254 - *255 - - *256 - - *417 - - &423 + - *416 + - &422 name: branch_policy_id in: path required: true @@ -62382,9 +62000,9 @@ paths: description: Response content: application/json: - schema: *421 + schema: *420 examples: - default: *422 + default: *421 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62403,10 +62021,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: + - *254 - *255 - - *256 - - *417 - - *423 + - *416 + - *422 requestBody: required: true content: @@ -62434,9 +62052,9 @@ paths: description: Response content: application/json: - schema: *421 + schema: *420 examples: - default: *422 + default: *421 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62455,10 +62073,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: + - *254 - *255 - - *256 - - *417 - - *423 + - *416 + - *422 responses: '204': description: Response @@ -62483,9 +62101,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *417 - - *256 + - *416 - *255 + - *254 responses: '200': description: List of deployment protection rules @@ -62501,7 +62119,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &424 + items: &423 title: Deployment protection rule description: Deployment protection rule type: object @@ -62520,7 +62138,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &425 + app: &424 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -62619,9 +62237,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: - - *417 - - *256 + - *416 - *255 + - *254 requestBody: content: application/json: @@ -62642,9 +62260,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *424 + schema: *423 examples: - default: &426 + default: &425 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -62679,9 +62297,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: - - *417 - - *256 + - *416 - *255 + - *254 - *20 - *18 responses: @@ -62700,7 +62318,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *425 + items: *424 examples: default: value: @@ -62735,10 +62353,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: + - *254 - *255 - - *256 - - *417 - - &427 + - *416 + - &426 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -62750,9 +62368,9 @@ paths: description: Response content: application/json: - schema: *424 + schema: *423 examples: - default: *426 + default: *425 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62773,10 +62391,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *417 - - *256 + - *416 - *255 - - *427 + - *254 + - *426 responses: '204': description: Response @@ -62802,9 +62420,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: + - *254 - *255 - - *256 - - *417 + - *416 - *18 - *20 responses: @@ -62822,11 +62440,11 @@ paths: type: integer secrets: type: array - items: *301 + items: *300 examples: - default: *302 + default: *301 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62849,17 +62467,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: + - *254 - *255 - - *256 - - *417 + - *416 responses: '200': description: Response content: application/json: - schema: *303 + schema: *302 examples: - default: *304 + default: *303 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62881,18 +62499,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: + - *254 - *255 - - *256 - - *417 - - *121 + - *416 + - *114 responses: '200': description: Response content: application/json: - schema: *301 + schema: *300 examples: - default: *428 + default: *427 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62914,10 +62532,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: + - *254 - *255 - - *256 - - *417 - - *121 + - *416 + - *114 requestBody: required: true content: @@ -62948,7 +62566,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -62974,10 +62592,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: + - *254 - *255 - - *256 - - *417 - - *121 + - *416 + - *114 responses: '204': description: Default response @@ -63002,10 +62620,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: + - *254 - *255 - - *256 - - *417 - - *277 + - *416 + - *276 - *20 responses: '200': @@ -63022,11 +62640,11 @@ paths: type: integer variables: type: array - items: *305 + items: *304 examples: - default: *306 + default: *305 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63047,9 +62665,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: + - *254 - *255 - - *256 - - *417 + - *416 requestBody: required: true content: @@ -63076,7 +62694,7 @@ paths: description: Response content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -63101,18 +62719,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: + - *254 - *255 - - *256 - - *417 - - *124 + - *416 + - *117 responses: '200': description: Response content: application/json: - schema: *305 + schema: *304 examples: - default: *429 + default: *428 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63133,10 +62751,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: + - *254 - *255 - - *256 - - *124 - - *417 + - *117 + - *416 requestBody: required: true content: @@ -63178,10 +62796,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: + - *254 - *255 - - *256 - - *124 - - *417 + - *117 + - *416 responses: '204': description: Response @@ -63203,8 +62821,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -63214,7 +62832,7 @@ paths: application/json: schema: type: array - items: *87 + items: *82 examples: 200-response: value: @@ -63281,8 +62899,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: + - *254 - *255 - - *256 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -63304,7 +62922,7 @@ paths: application/json: schema: type: array - items: *113 + items: *106 examples: default: value: @@ -63417,7 +63035,7 @@ paths: url: https://api.github.com/licenses/mit node_id: MDc6TGljZW5zZW1pdA== headers: - Link: *39 + Link: *51 '400': *15 x-github: githubCloudOnly: false @@ -63441,8 +63059,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: + - *254 - *255 - - *256 requestBody: required: false content: @@ -63474,9 +63092,9 @@ paths: description: Response content: application/json: - schema: *266 + schema: *265 examples: - default: *268 + default: *267 '400': *15 '422': *16 '403': *29 @@ -63497,8 +63115,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -63549,7 +63167,7 @@ paths: schema: type: string '404': *7 - '409': *134 + '409': *127 '403': *29 '422': description: Validation failed @@ -63557,8 +63175,8 @@ paths: application/json: schema: oneOf: - - *97 - - *430 + - *90 + - *429 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63583,8 +63201,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: + - *254 - *255 - - *256 - name: file_sha in: path required: true @@ -63635,7 +63253,7 @@ paths: '404': *7 '422': *16 '403': *29 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63683,8 +63301,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -63793,7 +63411,7 @@ paths: description: Response content: application/json: - schema: &431 + schema: &430 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -63956,7 +63574,7 @@ paths: type: string '422': *16 '404': *7 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64006,15 +63624,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: + - *254 - *255 - - *256 - - *384 + - *383 responses: '200': description: Response content: application/json: - schema: *431 + schema: *430 examples: default: value: @@ -64045,7 +63663,7 @@ paths: payload: verified_at: '404': *7 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64070,9 +63688,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: + - *254 - *255 - - *256 - - &432 + - &431 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. @@ -64089,7 +63707,7 @@ paths: application/json: schema: type: array - items: &433 + items: &432 title: Git Reference description: Git references within a repository type: object @@ -64142,8 +63760,8 @@ paths: sha: 612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: - Link: *39 - '409': *134 + Link: *51 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64164,17 +63782,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: + - *254 - *255 - - *256 - - *432 + - *431 responses: '200': description: Response content: application/json: - schema: *433 + schema: *432 examples: - default: &434 + default: &433 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -64184,7 +63802,7 @@ paths: sha: aa218f56b14c9653891f9e74264a383fa43fefbd url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd '404': *7 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64203,8 +63821,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -64233,16 +63851,16 @@ paths: description: Response content: application/json: - schema: *433 + schema: *432 examples: - default: *434 + default: *433 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA schema: type: string '422': *16 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64261,9 +63879,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: + - *254 - *255 - - *256 - - *432 + - *431 requestBody: required: true content: @@ -64292,11 +63910,11 @@ paths: description: Response content: application/json: - schema: *433 + schema: *432 examples: - default: *434 + default: *433 '422': *16 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64312,14 +63930,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: + - *254 - *255 - - *256 - - *432 + - *431 responses: '204': description: Response '422': *16 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64367,8 +63985,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -64435,7 +64053,7 @@ paths: description: Response content: application/json: - schema: &436 + schema: &435 title: Git Tag description: Metadata for a Git tag type: object @@ -64486,7 +64104,7 @@ paths: - sha - type - url - verification: *435 + verification: *434 required: - sha - url @@ -64496,7 +64114,7 @@ paths: - tag - message examples: - default: &437 + default: &436 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -64523,7 +64141,7 @@ paths: schema: type: string '422': *16 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64569,8 +64187,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: + - *254 - *255 - - *256 - name: tag_sha in: path required: true @@ -64581,11 +64199,11 @@ paths: description: Response content: application/json: - schema: *436 + schema: *435 examples: - default: *437 + default: *436 '404': *7 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64607,8 +64225,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -64681,7 +64299,7 @@ paths: description: Response content: application/json: - schema: &438 + schema: &437 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -64770,7 +64388,7 @@ paths: '422': *16 '404': *7 '403': *29 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64793,8 +64411,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: + - *254 - *255 - - *256 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -64817,7 +64435,7 @@ paths: description: Response content: application/json: - schema: *438 + schema: *437 examples: default-response: summary: Default response @@ -64858,7 +64476,7 @@ paths: truncated: false '422': *16 '404': *7 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64876,8 +64494,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -64887,7 +64505,7 @@ paths: application/json: schema: type: array - items: &439 + items: &438 title: Webhook description: Webhooks for repositories. type: object @@ -64941,7 +64559,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &657 + last_response: &656 title: Hook Response type: object properties: @@ -64996,7 +64614,7 @@ paths: status: unused message: headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -65015,8 +64633,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: + - *254 - *255 - - *256 requestBody: required: false content: @@ -65068,9 +64686,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *438 examples: - default: &440 + default: &439 value: type: Repository id: 12345678 @@ -65118,17 +64736,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: + - *254 - *255 - - *256 - - *158 + - *151 responses: '200': description: Response content: application/json: - schema: *439 + schema: *438 examples: - default: *440 + default: *439 '404': *7 x-github: githubCloudOnly: false @@ -65148,9 +64766,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: + - *254 - *255 - - *256 - - *158 + - *151 requestBody: required: true content: @@ -65195,9 +64813,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *438 examples: - default: *440 + default: *439 '422': *16 '404': *7 x-github: @@ -65218,9 +64836,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: + - *254 - *255 - - *256 - - *158 + - *151 responses: '204': description: Response @@ -65244,9 +64862,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: + - *254 - *255 - - *256 - - *158 + - *151 responses: '200': description: Response @@ -65273,9 +64891,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: + - *254 - *255 - - *256 - - *158 + - *151 requestBody: required: false content: @@ -65319,11 +64937,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: + - *254 - *255 - - *256 - - *158 + - *151 - *18 - - *159 + - *152 responses: '200': description: Response @@ -65331,9 +64949,9 @@ paths: application/json: schema: type: array - items: *160 + items: *153 examples: - default: *161 + default: *154 '400': *15 '422': *16 x-github: @@ -65352,18 +64970,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: + - *254 - *255 - - *256 - - *158 + - *151 - *17 responses: '200': description: Response content: application/json: - schema: *162 + schema: *155 examples: - default: *163 + default: *156 '400': *15 '422': *16 x-github: @@ -65382,12 +65000,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: + - *254 - *255 - - *256 - - *158 + - *151 - *17 responses: - '202': *99 + '202': *92 '400': *15 '422': *16 x-github: @@ -65407,9 +65025,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: + - *254 - *255 - - *256 - - *158 + - *151 responses: '204': description: Response @@ -65434,9 +65052,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: + - *254 - *255 - - *256 - - *158 + - *151 responses: '204': description: Response @@ -65494,14 +65112,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: + - *254 - *255 - - *256 responses: '200': description: Response content: application/json: - schema: &441 + schema: &440 title: Import description: A repository import from an external source. type: object @@ -65600,7 +65218,7 @@ paths: - html_url - authors_url examples: - default: &444 + default: &443 value: vcs: subversion use_lfs: true @@ -65616,7 +65234,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *7 - '503': &442 + '503': &441 description: Unavailable due to service under maintenance. content: application/json: @@ -65645,8 +65263,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -65694,7 +65312,7 @@ paths: description: Response content: application/json: - schema: *441 + schema: *440 examples: default: value: @@ -65719,7 +65337,7 @@ paths: type: string '422': *16 '404': *7 - '503': *442 + '503': *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65747,8 +65365,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: + - *254 - *255 - - *256 requestBody: required: false content: @@ -65797,7 +65415,7 @@ paths: description: Response content: application/json: - schema: *441 + schema: *440 examples: example-1: summary: Example 1 @@ -65845,7 +65463,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': *442 + '503': *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65868,12 +65486,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: + - *254 - *255 - - *256 responses: '204': description: Response - '503': *442 + '503': *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65899,9 +65517,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: + - *254 - *255 - - *256 - - &604 + - &603 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -65915,7 +65533,7 @@ paths: application/json: schema: type: array - items: &443 + items: &442 title: Porter Author description: Porter Author type: object @@ -65969,7 +65587,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *7 - '503': *442 + '503': *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65994,8 +65612,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: + - *254 - *255 - - *256 - name: author_id in: path required: true @@ -66025,7 +65643,7 @@ paths: description: Response content: application/json: - schema: *443 + schema: *442 examples: default: value: @@ -66038,7 +65656,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *16 '404': *7 - '503': *442 + '503': *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66062,8 +65680,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: + - *254 - *255 - - *256 responses: '200': description: Response @@ -66104,7 +65722,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *442 + '503': *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66132,8 +65750,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -66160,11 +65778,11 @@ paths: description: Response content: application/json: - schema: *441 + schema: *440 examples: - default: *444 + default: *443 '422': *16 - '503': *442 + '503': *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66187,8 +65805,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: + - *254 - *255 - - *256 responses: '200': description: Response @@ -66196,8 +65814,8 @@ paths: application/json: schema: *22 examples: - default: *445 - '301': *267 + default: *444 + '301': *266 '404': *7 x-github: githubCloudOnly: false @@ -66217,8 +65835,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: + - *254 - *255 - - *256 responses: '200': description: Response @@ -66226,12 +65844,12 @@ paths: application/json: schema: anyOf: - - *176 + - *169 - type: object properties: {} additionalProperties: false examples: - default: &447 + default: &446 value: limit: collaborators_only origin: repository @@ -66256,13 +65874,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: + - *254 - *255 - - *256 requestBody: required: true content: application/json: - schema: *446 + schema: *445 examples: default: summary: Example request body @@ -66274,9 +65892,9 @@ paths: description: Response content: application/json: - schema: *176 + schema: *169 examples: - default: *447 + default: *446 '409': description: Response x-github: @@ -66298,8 +65916,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: + - *254 - *255 - - *256 responses: '204': description: Response @@ -66322,8 +65940,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -66333,9 +65951,9 @@ paths: application/json: schema: type: array - items: *448 + items: *447 examples: - default: &597 + default: &596 value: - id: 1 repository: @@ -66449,7 +66067,7 @@ paths: html_url: https://github.com/octocat/Hello-World/invitations node_id: MDQ6VXNlcjE= headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66466,9 +66084,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: + - *254 - *255 - - *256 - - *180 + - *173 requestBody: required: false content: @@ -66497,7 +66115,7 @@ paths: description: Response content: application/json: - schema: *448 + schema: *447 examples: default: value: @@ -66628,9 +66246,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: + - *254 - *255 - - *256 - - *180 + - *173 responses: '204': description: Response @@ -66661,8 +66279,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: + - *254 - *255 - - *256 - 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 @@ -66702,7 +66320,7 @@ paths: required: false schema: type: string - - *182 + - *175 - name: sort description: What to sort results by. in: query @@ -66714,8 +66332,8 @@ paths: - updated - comments default: created - - *42 - - *65 + - *39 + - *60 - *18 - *20 responses: @@ -66725,9 +66343,9 @@ paths: application/json: schema: type: array - items: *75 + items: *70 examples: - default: &459 + default: &458 value: - id: 1 node_id: MDU6SXNzdWUx @@ -66874,8 +66492,8 @@ paths: author_association: COLLABORATOR state_reason: completed headers: - Link: *39 - '301': *267 + Link: *51 + '301': *266 '422': *16 '404': *7 x-github: @@ -66904,8 +66522,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -66980,9 +66598,9 @@ paths: description: Response content: application/json: - schema: *75 + schema: *70 examples: - default: &454 + default: &453 value: id: 1 node_id: MDU6SXNzdWUx @@ -67136,9 +66754,9 @@ paths: '400': *15 '403': *29 '422': *16 - '503': *63 + '503': *58 '404': *7 - '410': *264 + '410': *263 x-github: triggersNotification: true githubCloudOnly: false @@ -67166,9 +66784,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: + - *254 - *255 - - *256 - - *85 + - *80 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -67178,7 +66796,7 @@ paths: enum: - asc - desc - - *65 + - *60 - *18 - *20 responses: @@ -67188,9 +66806,9 @@ paths: application/json: schema: type: array - items: *449 + items: *448 examples: - default: &456 + default: &455 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -67221,7 +66839,7 @@ paths: issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 author_association: COLLABORATOR headers: - Link: *39 + Link: *51 '422': *16 '404': *7 x-github: @@ -67248,17 +66866,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: + - *254 - *255 - - *256 - - *74 + - *69 responses: '200': description: Response content: application/json: - schema: *449 + schema: *448 examples: - default: &450 + default: &449 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -67312,9 +66930,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: + - *254 - *255 - - *256 - - *74 + - *69 requestBody: required: true content: @@ -67336,9 +66954,9 @@ paths: description: Response content: application/json: - schema: *449 + schema: *448 examples: - default: *450 + default: *449 '422': *16 x-github: githubCloudOnly: false @@ -67356,9 +66974,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: + - *254 - *255 - - *256 - - *74 + - *69 responses: '204': description: Response @@ -67378,9 +66996,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: + - *254 - *255 - - *256 - - *74 + - *69 - 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. @@ -67406,11 +67024,11 @@ paths: application/json: schema: type: array - items: *248 + items: *247 examples: - default: *250 + default: *249 headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -67429,9 +67047,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: + - *254 - *255 - - *256 - - *74 + - *69 requestBody: required: true content: @@ -67463,16 +67081,16 @@ paths: description: Reaction exists content: application/json: - schema: *248 + schema: *247 examples: - default: *249 + default: *248 '201': description: Reaction created content: application/json: - schema: *248 + schema: *247 examples: - default: *249 + default: *248 '422': *16 x-github: githubCloudOnly: false @@ -67494,10 +67112,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: + - *254 - *255 - - *256 - - *74 - - *251 + - *69 + - *250 responses: '204': description: Response @@ -67517,8 +67135,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -67528,7 +67146,7 @@ paths: application/json: schema: type: array - items: &453 + items: &452 title: Issue Event description: Issue Event type: object @@ -67571,8 +67189,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *451 - required: *452 + properties: *450 + required: *451 nullable: true label: title: Issue Event Label @@ -67616,7 +67234,7 @@ paths: properties: *4 required: *5 nullable: true - requested_team: *181 + requested_team: *174 dismissed_review: title: Issue Event Dismissed Review type: object @@ -67681,7 +67299,7 @@ paths: required: - from - to - author_association: *61 + author_association: *56 lock_reason: type: string nullable: true @@ -67694,8 +67312,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 required: - id - node_id @@ -67861,7 +67479,7 @@ paths: author_association: COLLABORATOR state_reason: completed headers: - Link: *39 + Link: *51 '422': *16 x-github: githubCloudOnly: false @@ -67879,8 +67497,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: + - *254 - *255 - - *256 - name: event_id in: path required: true @@ -67891,7 +67509,7 @@ paths: description: Response content: application/json: - schema: *453 + schema: *452 examples: default: value: @@ -68084,7 +67702,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *7 - '410': *264 + '410': *263 '403': *29 x-github: githubCloudOnly: false @@ -68118,9 +67736,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: + - *254 - *255 - - *256 - - &455 + - &454 name: issue_number description: The number that identifies the issue. in: path @@ -68132,12 +67750,12 @@ paths: description: Response content: application/json: - schema: *75 + schema: *70 examples: - default: *454 - '301': *267 + default: *453 + '301': *266 '404': *7 - '410': *264 + '410': *263 '304': *37 x-github: githubCloudOnly: false @@ -68162,9 +67780,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: + - *254 - *255 - - *256 - - *455 + - *454 requestBody: required: false content: @@ -68259,15 +67877,15 @@ paths: description: Response content: application/json: - schema: *75 + schema: *70 examples: - default: *454 + default: *453 '422': *16 - '503': *63 + '503': *58 '403': *29 - '301': *267 + '301': *266 '404': *7 - '410': *264 + '410': *263 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68285,9 +67903,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: + - *254 - *255 - - *256 - - *455 + - *454 requestBody: required: false content: @@ -68313,9 +67931,9 @@ paths: description: Response content: application/json: - schema: *75 + schema: *70 examples: - default: *454 + default: *453 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68331,9 +67949,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: + - *254 - *255 - - *256 - - *455 + - *454 requestBody: content: application/json: @@ -68358,9 +67976,9 @@ paths: description: Response content: application/json: - schema: *75 + schema: *70 examples: - default: *454 + default: *453 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68382,9 +68000,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: + - *254 - *255 - - *256 - - *455 + - *454 - name: assignee in: path required: true @@ -68424,10 +68042,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: + - *254 - *255 - - *256 - - *455 - - *65 + - *454 + - *60 - *18 - *20 responses: @@ -68437,13 +68055,13 @@ paths: application/json: schema: type: array - items: *449 + items: *448 examples: - default: *456 + default: *455 headers: - Link: *39 + Link: *51 '404': *7 - '410': *264 + '410': *263 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68472,9 +68090,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: + - *254 - *255 - - *256 - - *455 + - *454 requestBody: required: true content: @@ -68496,16 +68114,16 @@ paths: description: Response content: application/json: - schema: *449 + schema: *448 examples: - default: *450 + default: *449 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *264 + '410': *263 '422': *16 '404': *7 x-github: @@ -68525,9 +68143,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: + - *254 - *255 - - *256 - - *455 + - *454 - *18 - *20 responses: @@ -68541,7 +68159,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &460 + - &459 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -68572,8 +68190,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 label: type: object properties: @@ -68595,7 +68213,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &461 + - &460 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -68626,8 +68244,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 label: type: object properties: @@ -68715,8 +68333,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 assignee: *19 assigner: *19 required: @@ -68731,7 +68349,7 @@ paths: - performed_via_github_app - assignee - assigner - - &462 + - &461 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -68762,8 +68380,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 milestone: type: object properties: @@ -68782,7 +68400,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &463 + - &462 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -68813,8 +68431,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 milestone: type: object properties: @@ -68833,7 +68451,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &464 + - &463 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -68864,8 +68482,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 rename: type: object properties: @@ -68887,7 +68505,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &465 + - &464 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -68918,10 +68536,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 review_requester: *19 - requested_team: *181 + requested_team: *174 requested_reviewer: *19 required: - review_requester @@ -68934,7 +68552,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &466 + - &465 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -68965,10 +68583,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 review_requester: *19 - requested_team: *181 + requested_team: *174 requested_reviewer: *19 required: - review_requester @@ -68981,7 +68599,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &467 + - &466 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -69012,8 +68630,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 dismissed_review: type: object properties: @@ -69041,7 +68659,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &468 + - &467 title: Locked Issue Event description: Locked Issue Event type: object @@ -69072,8 +68690,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 lock_reason: type: string example: '"off-topic"' @@ -69089,7 +68707,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &469 + - &468 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -69120,8 +68738,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 project_card: type: object properties: @@ -69155,7 +68773,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &470 + - &469 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -69186,8 +68804,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 project_card: type: object properties: @@ -69221,7 +68839,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &471 + - &470 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -69252,8 +68870,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 project_card: type: object properties: @@ -69287,7 +68905,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &472 + - &471 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -69377,8 +68995,8 @@ paths: name: label color: red headers: - Link: *39 - '410': *264 + Link: *51 + '410': *263 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69395,9 +69013,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: + - *254 - *255 - - *256 - - *455 + - *454 - *18 - *20 responses: @@ -69407,7 +69025,7 @@ paths: application/json: schema: type: array - items: &457 + items: &456 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -69454,7 +69072,7 @@ paths: - color - default examples: - default: &458 + default: &457 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -69471,10 +69089,10 @@ paths: color: a2eeef default: false headers: - Link: *39 - '301': *267 + Link: *51 + '301': *266 '404': *7 - '410': *264 + '410': *263 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69491,9 +69109,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: + - *254 - *255 - - *256 - - *455 + - *454 requestBody: required: false content: @@ -69552,12 +69170,12 @@ paths: application/json: schema: type: array - items: *457 + items: *456 examples: - default: *458 - '301': *267 + default: *457 + '301': *266 '404': *7 - '410': *264 + '410': *263 '422': *16 x-github: githubCloudOnly: false @@ -69574,9 +69192,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: + - *254 - *255 - - *256 - - *455 + - *454 requestBody: required: false content: @@ -69636,12 +69254,12 @@ paths: application/json: schema: type: array - items: *457 + items: *456 examples: - default: *458 - '301': *267 + default: *457 + '301': *266 '404': *7 - '410': *264 + '410': *263 '422': *16 x-github: githubCloudOnly: false @@ -69658,15 +69276,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: + - *254 - *255 - - *256 - - *455 + - *454 responses: '204': description: Response - '301': *267 + '301': *266 '404': *7 - '410': *264 + '410': *263 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69685,9 +69303,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: + - *254 - *255 - - *256 - - *455 + - *454 - name: name in: path required: true @@ -69700,7 +69318,7 @@ paths: application/json: schema: type: array - items: *457 + items: *456 examples: default: value: @@ -69711,9 +69329,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *267 + '301': *266 '404': *7 - '410': *264 + '410': *263 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69733,9 +69351,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: + - *254 - *255 - - *256 - - *455 + - *454 requestBody: required: false content: @@ -69763,7 +69381,7 @@ paths: '204': description: Response '403': *29 - '410': *264 + '410': *263 '404': *7 '422': *16 x-github: @@ -69781,9 +69399,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: + - *254 - *255 - - *256 - - *455 + - *454 responses: '204': description: Response @@ -69805,9 +69423,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: + - *254 - *255 - - *256 - - *455 + - *454 - 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. @@ -69833,13 +69451,13 @@ paths: application/json: schema: type: array - items: *248 + items: *247 examples: - default: *250 + default: *249 headers: - Link: *39 + Link: *51 '404': *7 - '410': *264 + '410': *263 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69857,9 +69475,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: + - *254 - *255 - - *256 - - *455 + - *454 requestBody: required: true content: @@ -69891,16 +69509,16 @@ paths: description: Response content: application/json: - schema: *248 + schema: *247 examples: - default: *249 + default: *248 '201': description: Response content: application/json: - schema: *248 + schema: *247 examples: - default: *249 + default: *248 '422': *16 x-github: githubCloudOnly: false @@ -69922,10 +69540,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: + - *254 - *255 - - *256 - - *455 - - *251 + - *454 + - *250 responses: '204': description: Response @@ -69954,9 +69572,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue parameters: + - *254 - *255 - - *256 - - *455 + - *454 requestBody: required: true content: @@ -69978,9 +69596,9 @@ paths: description: Response content: application/json: - schema: *75 + schema: *70 examples: - default: *454 + default: *453 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -70013,9 +69631,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues parameters: + - *254 - *255 - - *256 - - *455 + - *454 - *18 - *20 responses: @@ -70025,13 +69643,13 @@ paths: application/json: schema: type: array - items: *75 + items: *70 examples: - default: *459 + default: *458 headers: - Link: *39 + Link: *51 '404': *7 - '410': *264 + '410': *263 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70059,9 +69677,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue parameters: + - *254 - *255 - - *256 - - *455 + - *454 requestBody: required: true content: @@ -70087,16 +69705,16 @@ paths: description: Response content: application/json: - schema: *75 + schema: *70 examples: - default: *454 + default: *453 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *264 + '410': *263 '422': *16 '404': *7 x-github: @@ -70116,9 +69734,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue parameters: + - *254 - *255 - - *256 - - *455 + - *454 requestBody: required: true content: @@ -70149,13 +69767,13 @@ paths: description: Response content: application/json: - schema: *75 + schema: *70 examples: - default: *454 + default: *453 '403': *29 '404': *7 '422': *8 - '503': *63 + '503': *58 x-github: triggersNotification: true githubCloudOnly: false @@ -70173,9 +69791,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: + - *254 - *255 - - *256 - - *455 + - *454 - *18 - *20 responses: @@ -70190,6 +69808,7 @@ paths: description: Timeline Event type: object anyOf: + - *459 - *460 - *461 - *462 @@ -70202,7 +69821,6 @@ paths: - *469 - *470 - *471 - - *472 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -70245,7 +69863,7 @@ paths: issue_url: type: string format: uri - author_association: *61 + author_association: *56 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. They @@ -70255,9 +69873,9 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 - reactions: *62 + properties: *54 + required: *55 + reactions: *57 required: - event - actor @@ -70288,7 +69906,7 @@ paths: properties: type: type: string - issue: *75 + issue: *70 required: - event - created_at @@ -70483,7 +70101,7 @@ paths: type: string body_text: type: string - author_association: *61 + author_association: *56 required: - event - id @@ -70506,7 +70124,7 @@ paths: type: string comments: type: array - items: &493 + items: &492 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -70595,7 +70213,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *61 + author_association: *56 _links: type: object properties: @@ -70679,7 +70297,7 @@ paths: enum: - line - file - reactions: *62 + reactions: *57 body_html: type: string example: '"

comment body

"' @@ -70715,7 +70333,7 @@ paths: type: string comments: type: array - items: *382 + items: *381 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -70746,8 +70364,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 assignee: *19 required: - id @@ -70790,8 +70408,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 assignee: *19 required: - id @@ -70834,8 +70452,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 state_reason: type: string nullable: true @@ -71002,9 +70620,9 @@ paths: type: User site_admin: true headers: - Link: *39 + Link: *51 '404': *7 - '410': *264 + '410': *263 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71021,8 +70639,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -71032,7 +70650,7 @@ paths: application/json: schema: type: array - items: &473 + items: &472 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -71081,7 +70699,7 @@ paths: last_used: '2022-01-10T15:53:42Z' enabled: true headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71097,8 +70715,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -71134,9 +70752,9 @@ paths: description: Response content: application/json: - schema: *473 + schema: *472 examples: - default: &474 + default: &473 value: id: 1 key: ssh-rsa AAA... @@ -71170,9 +70788,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: + - *254 - *255 - - *256 - - &475 + - &474 name: key_id description: The unique identifier of the key. in: path @@ -71184,9 +70802,9 @@ paths: description: Response content: application/json: - schema: *473 + schema: *472 examples: - default: *474 + default: *473 '404': *7 x-github: githubCloudOnly: false @@ -71204,9 +70822,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: + - *254 - *255 - - *256 - - *475 + - *474 responses: '204': description: Response @@ -71226,8 +70844,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -71237,11 +70855,11 @@ paths: application/json: schema: type: array - items: *457 + items: *456 examples: - default: *458 + default: *457 headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -71260,8 +70878,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -71297,9 +70915,9 @@ paths: description: Response content: application/json: - schema: *457 + schema: *456 examples: - default: &476 + default: &475 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -71331,8 +70949,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: + - *254 - *255 - - *256 - name: name in: path required: true @@ -71343,9 +70961,9 @@ paths: description: Response content: application/json: - schema: *457 + schema: *456 examples: - default: *476 + default: *475 '404': *7 x-github: githubCloudOnly: false @@ -71362,8 +70980,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: + - *254 - *255 - - *256 - name: name in: path required: true @@ -71402,7 +71020,7 @@ paths: description: Response content: application/json: - schema: *457 + schema: *456 examples: default: value: @@ -71428,8 +71046,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: + - *254 - *255 - - *256 - name: name in: path required: true @@ -71455,8 +71073,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: + - *254 - *255 - - *256 responses: '200': description: Response @@ -71495,9 +71113,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: + - *254 - *255 - - *256 - - *357 + - *356 responses: '200': description: Response @@ -71559,8 +71177,8 @@ paths: title: License Simple description: License Simple type: object - properties: *76 - required: *77 + properties: *71 + required: *72 nullable: true required: - _links @@ -71642,8 +71260,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -71708,8 +71326,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -71743,9 +71361,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *383 + schema: *382 examples: - default: *477 + default: *476 '204': description: Response when already merged '404': @@ -71770,8 +71388,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: + - *254 - *255 - - *256 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -71812,12 +71430,12 @@ paths: application/json: schema: type: array - items: &478 + items: &477 title: Milestone description: A collection of related issues and pull requests. type: object - properties: *387 - required: *388 + properties: *386 + required: *387 examples: default: value: @@ -71856,7 +71474,7 @@ paths: closed_at: '2013-02-12T13:22:01Z' due_on: '2012-10-09T23:39:01Z' headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -71873,8 +71491,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -71914,9 +71532,9 @@ paths: description: Response content: application/json: - schema: *478 + schema: *477 examples: - default: &479 + default: &478 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -71975,9 +71593,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: + - *254 - *255 - - *256 - - &480 + - &479 name: milestone_number description: The number that identifies the milestone. in: path @@ -71989,9 +71607,9 @@ paths: description: Response content: application/json: - schema: *478 + schema: *477 examples: - default: *479 + default: *478 '404': *7 x-github: githubCloudOnly: false @@ -72008,9 +71626,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: + - *254 - *255 - - *256 - - *480 + - *479 requestBody: required: false content: @@ -72048,9 +71666,9 @@ paths: description: Response content: application/json: - schema: *478 + schema: *477 examples: - default: *479 + default: *478 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72066,9 +71684,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: + - *254 - *255 - - *256 - - *480 + - *479 responses: '204': description: Response @@ -72089,9 +71707,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: + - *254 - *255 - - *256 - - *480 + - *479 - *18 - *20 responses: @@ -72101,11 +71719,11 @@ paths: application/json: schema: type: array - items: *457 + items: *456 examples: - default: *458 + default: *457 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72122,12 +71740,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: + - *254 - *255 - - *256 + - *480 - *481 + - *60 - *482 - - *65 - - *483 - *18 - *20 responses: @@ -72137,11 +71755,11 @@ paths: application/json: schema: type: array - items: *88 + items: *83 examples: - default: *484 + default: *483 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -72163,8 +71781,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: + - *254 - *255 - - *256 requestBody: required: false content: @@ -72222,14 +71840,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: + - *254 - *255 - - *256 responses: '200': description: Response content: application/json: - schema: &485 + schema: &484 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -72354,7 +71972,7 @@ paths: - custom_404 - public examples: - default: &486 + default: &485 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -72395,8 +72013,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -72450,11 +72068,11 @@ paths: description: Response content: application/json: - schema: *485 + schema: *484 examples: - default: *486 + default: *485 '422': *16 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72475,8 +72093,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -72554,7 +72172,7 @@ paths: description: Response '422': *16 '400': *15 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72575,14 +72193,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: + - *254 - *255 - - *256 responses: '204': description: Response '422': *16 '404': *7 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72602,8 +72220,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -72613,7 +72231,7 @@ paths: application/json: schema: type: array - items: &487 + items: &486 title: Page Build description: Page Build type: object @@ -72688,7 +72306,7 @@ paths: created_at: '2014-02-10T19:00:49Z' updated_at: '2014-02-10T19:00:51Z' headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72707,8 +72325,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: + - *254 - *255 - - *256 responses: '201': description: Response @@ -72753,16 +72371,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: + - *254 - *255 - - *256 responses: '200': description: Response content: application/json: - schema: *487 + schema: *486 examples: - default: &488 + default: &487 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -72810,8 +72428,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: + - *254 - *255 - - *256 - name: build_id in: path required: true @@ -72822,9 +72440,9 @@ paths: description: Response content: application/json: - schema: *487 + schema: *486 examples: - default: *488 + default: *487 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72844,8 +72462,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -72951,9 +72569,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: + - *254 - *255 - - *256 - - &489 + - &488 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -73011,11 +72629,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: + - *254 - *255 - - *256 - - *489 + - *488 responses: - '204': *138 + '204': *131 '404': *7 x-github: githubCloudOnly: false @@ -73040,8 +72658,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: + - *254 - *255 - - *256 responses: '200': description: Response @@ -73272,7 +72890,7 @@ paths: description: Empty response content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -73299,8 +72917,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: + - *254 - *255 - - *256 responses: '200': description: Private vulnerability reporting status @@ -73337,10 +72955,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: + - *254 - *255 - - *256 responses: - '204': *138 + '204': *131 '422': *15 x-github: githubCloudOnly: false @@ -73359,10 +72977,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: + - *254 - *255 - - *256 responses: - '204': *138 + '204': *131 '422': *15 x-github: githubCloudOnly: false @@ -73383,8 +73001,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-repository-projects parameters: + - *254 - *255 - - *256 - name: state description: Indicates the state of the projects to return. in: query @@ -73405,7 +73023,7 @@ paths: application/json: schema: type: array - items: *212 + items: *206 examples: default: value: @@ -73441,11 +73059,11 @@ paths: created_at: '2011-04-10T20:09:31Z' updated_at: '2014-03-03T18:58:10Z' headers: - Link: *39 + Link: *51 '401': *25 '403': *29 '404': *7 - '410': *264 + '410': *263 '422': *8 x-github: githubCloudOnly: false @@ -73465,8 +73083,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#create-a-repository-project parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -73492,13 +73110,13 @@ paths: description: Response content: application/json: - schema: *212 + schema: *206 examples: - default: *263 + default: *262 '401': *25 '403': *29 '404': *7 - '410': *264 + '410': *263 '422': *8 x-github: githubCloudOnly: false @@ -73518,8 +73136,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: + - *254 - *255 - - *256 responses: '200': description: Response @@ -73527,7 +73145,7 @@ paths: application/json: schema: type: array - items: *217 + items: *211 examples: default: value: @@ -73558,8 +73176,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: + - *254 - *255 - - *256 requestBody: required: true content: @@ -73571,7 +73189,7 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *217 + items: *211 required: - properties examples: @@ -73621,8 +73239,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: + - *254 - *255 - - *256 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -73682,11 +73300,11 @@ paths: application/json: schema: type: array - items: *490 + items: *489 examples: - default: *491 + default: *490 headers: - Link: *39 + Link: *51 '304': *37 '422': *16 x-github: @@ -73716,8 +73334,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -73782,7 +73400,7 @@ paths: description: Response content: application/json: - schema: &495 + schema: &494 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -73893,8 +73511,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *387 - required: *388 + properties: *386 + required: *387 nullable: true active_lock_reason: type: string @@ -73939,7 +73557,7 @@ paths: nullable: true requested_teams: type: array - items: *239 + items: *233 nullable: true head: type: object @@ -73948,7 +73566,7 @@ paths: type: string ref: type: string - repo: *58 + repo: *53 sha: type: string user: *19 @@ -73965,7 +73583,7 @@ paths: type: string ref: type: string - repo: *58 + repo: *53 sha: type: string user: *19 @@ -73978,14 +73596,14 @@ paths: _links: type: object properties: - comments: *389 - commits: *389 - statuses: *389 - html: *389 - issue: *389 - review_comments: *389 - review_comment: *389 - self: *389 + comments: *388 + commits: *388 + statuses: *388 + html: *388 + issue: *388 + review_comments: *388 + review_comment: *388 + self: *388 required: - comments - commits @@ -73995,8 +73613,8 @@ paths: - review_comments - review_comment - self - author_association: *61 - auto_merge: *492 + author_association: *56 + auto_merge: *491 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -74088,7 +73706,7 @@ paths: - merged_by - review_comments examples: - default: &496 + default: &495 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -74615,8 +74233,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: + - *254 - *255 - - *256 - name: sort in: query required: false @@ -74635,7 +74253,7 @@ paths: enum: - asc - desc - - *65 + - *60 - *18 - *20 responses: @@ -74645,9 +74263,9 @@ paths: application/json: schema: type: array - items: *493 + items: *492 examples: - default: &498 + default: &497 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -74699,7 +74317,7 @@ paths: original_line: 2 side: RIGHT headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74724,17 +74342,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: + - *254 - *255 - - *256 - - *74 + - *69 responses: '200': description: Response content: application/json: - schema: *493 + schema: *492 examples: - default: &494 + default: &493 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -74809,9 +74427,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: + - *254 - *255 - - *256 - - *74 + - *69 requestBody: required: true content: @@ -74833,9 +74451,9 @@ paths: description: Response content: application/json: - schema: *493 + schema: *492 examples: - default: *494 + default: *493 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74851,9 +74469,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: + - *254 - *255 - - *256 - - *74 + - *69 responses: '204': description: Response @@ -74874,9 +74492,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: + - *254 - *255 - - *256 - - *74 + - *69 - 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. @@ -74902,11 +74520,11 @@ paths: application/json: schema: type: array - items: *248 + items: *247 examples: - default: *250 + default: *249 headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -74925,9 +74543,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: + - *254 - *255 - - *256 - - *74 + - *69 requestBody: required: true content: @@ -74959,16 +74577,16 @@ paths: description: Reaction exists content: application/json: - schema: *248 + schema: *247 examples: - default: *249 + default: *248 '201': description: Reaction created content: application/json: - schema: *248 + schema: *247 examples: - default: *249 + default: *248 '422': *16 x-github: githubCloudOnly: false @@ -74990,10 +74608,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: + - *254 - *255 - - *256 - - *74 - - *251 + - *69 + - *250 responses: '204': description: Response @@ -75036,9 +74654,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: + - *254 - *255 - - *256 - - &497 + - &496 name: pull_number description: The number that identifies the pull request. in: path @@ -75051,9 +74669,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *495 + schema: *494 examples: - default: *496 + default: *495 '304': *37 '404': *7 '406': @@ -75061,8 +74679,8 @@ paths: content: application/json: schema: *3 - '500': *41 - '503': *63 + '500': *132 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75088,9 +74706,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: + - *254 - *255 - - *256 - - *497 + - *496 requestBody: required: false content: @@ -75132,9 +74750,9 @@ paths: description: Response content: application/json: - schema: *495 + schema: *494 examples: - default: *496 + default: *495 '422': *16 '403': *29 x-github: @@ -75156,9 +74774,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: + - *254 - *255 - - *256 - - *497 + - *496 requestBody: required: true content: @@ -75218,21 +74836,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *185 + schema: *178 examples: - default: *372 + default: *371 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *185 + schema: *178 examples: - default: *372 + default: *371 '401': *25 '403': *29 '404': *7 - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -75258,10 +74876,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: + - *254 - *255 - - *256 - - *497 - - *85 + - *496 + - *80 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -75271,7 +74889,7 @@ paths: enum: - asc - desc - - *65 + - *60 - *18 - *20 responses: @@ -75281,11 +74899,11 @@ paths: application/json: schema: type: array - items: *493 + items: *492 examples: - default: *498 + default: *497 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75316,9 +74934,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: + - *254 - *255 - - *256 - - *497 + - *496 requestBody: required: true content: @@ -75423,7 +75041,7 @@ paths: description: Response content: application/json: - schema: *493 + schema: *492 examples: example-for-a-multi-line-comment: value: @@ -75511,10 +75129,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: + - *254 - *255 - - *256 - - *497 - - *74 + - *496 + - *69 requestBody: required: true content: @@ -75536,7 +75154,7 @@ paths: description: Response content: application/json: - schema: *493 + schema: *492 examples: default: value: @@ -75622,9 +75240,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: + - *254 - *255 - - *256 - - *497 + - *496 - *18 - *20 responses: @@ -75634,11 +75252,11 @@ paths: application/json: schema: type: array - items: *383 + items: *382 examples: - default: *499 + default: *498 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75666,9 +75284,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: + - *254 - *255 - - *256 - - *497 + - *496 - *18 - *20 responses: @@ -75678,7 +75296,7 @@ paths: application/json: schema: type: array - items: *398 + items: *397 examples: default: value: @@ -75694,10 +75312,10 @@ paths: patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" headers: - Link: *39 + Link: *51 '422': *16 - '500': *41 - '503': *63 + '500': *132 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75716,9 +75334,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: + - *254 - *255 - - *256 - - *497 + - *496 responses: '204': description: Response if pull request has been merged @@ -75741,9 +75359,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: + - *254 - *255 - - *256 - - *497 + - *496 requestBody: required: false content: @@ -75854,9 +75472,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: + - *254 - *255 - - *256 - - *497 + - *496 responses: '200': description: Response @@ -75872,7 +75490,7 @@ paths: items: *19 teams: type: array - items: *181 + items: *174 required: - users - teams @@ -75913,7 +75531,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos parent: headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75931,9 +75549,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: + - *254 - *255 - - *256 - - *497 + - *496 requestBody: required: false content: @@ -75970,7 +75588,7 @@ paths: description: Response content: application/json: - schema: *490 + schema: *489 examples: default: value: @@ -76506,9 +76124,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: + - *254 - *255 - - *256 - - *497 + - *496 requestBody: required: true content: @@ -76542,7 +76160,7 @@ paths: description: Response content: application/json: - schema: *490 + schema: *489 examples: default: value: @@ -77047,9 +76665,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: + - *254 - *255 - - *256 - - *497 + - *496 - *18 - *20 responses: @@ -77059,7 +76677,7 @@ paths: application/json: schema: type: array - items: &500 + items: &499 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -77128,7 +76746,7 @@ paths: type: string body_text: type: string - author_association: *61 + author_association: *56 required: - id - node_id @@ -77177,7 +76795,7 @@ paths: commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091 author_association: COLLABORATOR headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77210,9 +76828,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: + - *254 - *255 - - *256 - - *497 + - *496 requestBody: required: false content: @@ -77298,9 +76916,9 @@ paths: description: Response content: application/json: - schema: *500 + schema: *499 examples: - default: &502 + default: &501 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -77363,10 +76981,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: + - *254 - *255 - - *256 - - *497 - - &501 + - *496 + - &500 name: review_id description: The unique identifier of the review. in: path @@ -77378,9 +76996,9 @@ paths: description: Response content: application/json: - schema: *500 + schema: *499 examples: - default: &503 + default: &502 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -77439,10 +77057,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: + - *254 - *255 - - *256 - - *497 - - *501 + - *496 + - *500 requestBody: required: true content: @@ -77465,7 +77083,7 @@ paths: description: Response content: application/json: - schema: *500 + schema: *499 examples: default: value: @@ -77527,18 +77145,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: + - *254 - *255 - - *256 - - *497 - - *501 + - *496 + - *500 responses: '200': description: Response content: application/json: - schema: *500 + schema: *499 examples: - default: *502 + default: *501 '422': *8 '404': *7 x-github: @@ -77565,10 +77183,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: + - *254 - *255 - - *256 - - *497 - - *501 + - *496 + - *500 - *18 - *20 responses: @@ -77647,13 +77265,13 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *61 + author_association: *56 _links: type: object properties: - self: *389 - html: *389 - pull_request: *389 + self: *388 + html: *388 + pull_request: *388 required: - self - html @@ -77662,7 +77280,7 @@ paths: type: string body_html: type: string - reactions: *62 + reactions: *57 side: description: The side of the first line of the range for a multi-line comment. @@ -77767,7 +77385,7 @@ paths: pull_request: href: https://api.github.com/repos/octocat/Hello-World/pulls/1 headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -77796,10 +77414,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: + - *254 - *255 - - *256 - - *497 - - *501 + - *496 + - *500 requestBody: required: true content: @@ -77827,7 +77445,7 @@ paths: description: Response content: application/json: - schema: *500 + schema: *499 examples: default: value: @@ -77890,10 +77508,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: + - *254 - *255 - - *256 - - *497 - - *501 + - *496 + - *500 requestBody: required: true content: @@ -77928,9 +77546,9 @@ paths: description: Response content: application/json: - schema: *500 + schema: *499 examples: - default: *503 + default: *502 '404': *7 '422': *8 '403': *29 @@ -77952,9 +77570,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: + - *254 - *255 - - *256 - - *497 + - *496 requestBody: required: false content: @@ -78017,8 +77635,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: + - *254 - *255 - - *256 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -78031,9 +77649,9 @@ paths: description: Response content: application/json: - schema: *504 + schema: *503 examples: - default: &505 + default: &504 value: type: file encoding: base64 @@ -78075,8 +77693,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: + - *254 - *255 - - *256 - name: dir description: The alternate path to look for a README file in: path @@ -78096,9 +77714,9 @@ paths: description: Response content: application/json: - schema: *504 + schema: *503 examples: - default: *505 + default: *504 '404': *7 '422': *16 x-github: @@ -78120,8 +77738,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -78131,7 +77749,7 @@ paths: application/json: schema: type: array - items: &506 + items: &505 title: Release description: A release. type: object @@ -78194,7 +77812,7 @@ paths: author: *19 assets: type: array - items: &507 + items: &506 title: Release Asset description: Data related to a release. type: object @@ -78265,7 +77883,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *62 + reactions: *57 required: - assets_url - upload_url @@ -78355,7 +77973,7 @@ paths: type: User site_admin: false headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -78375,8 +77993,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -78452,9 +78070,9 @@ paths: description: Response content: application/json: - schema: *506 + schema: *505 examples: - default: &510 + default: &509 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -78557,9 +78175,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: + - *254 - *255 - - *256 - - &508 + - &507 name: asset_id description: The unique identifier of the asset. in: path @@ -78571,9 +78189,9 @@ paths: description: Response content: application/json: - schema: *507 + schema: *506 examples: - default: &509 + default: &508 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 @@ -78607,7 +78225,7 @@ paths: type: User site_admin: false '404': *7 - '302': *400 + '302': *399 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78623,9 +78241,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: + - *254 - *255 - - *256 - - *508 + - *507 requestBody: required: false content: @@ -78653,9 +78271,9 @@ paths: description: Response content: application/json: - schema: *507 + schema: *506 examples: - default: *509 + default: *508 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78671,9 +78289,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: + - *254 - *255 - - *256 - - *508 + - *507 responses: '204': description: Response @@ -78697,8 +78315,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -78783,16 +78401,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: + - *254 - *255 - - *256 responses: '200': description: Response content: application/json: - schema: *506 + schema: *505 examples: - default: *510 + default: *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78809,8 +78427,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: + - *254 - *255 - - *256 - name: tag description: tag parameter in: path @@ -78823,9 +78441,9 @@ paths: description: Response content: application/json: - schema: *506 + schema: *505 examples: - default: *510 + default: *509 '404': *7 x-github: githubCloudOnly: false @@ -78847,9 +78465,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: + - *254 - *255 - - *256 - - &511 + - &510 name: release_id description: The unique identifier of the release. in: path @@ -78863,9 +78481,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: *506 + schema: *505 examples: - default: *510 + default: *509 '401': description: Unauthorized x-github: @@ -78883,9 +78501,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: + - *254 - *255 - - *256 - - *511 + - *510 requestBody: required: false content: @@ -78949,9 +78567,9 @@ paths: description: Response content: application/json: - schema: *506 + schema: *505 examples: - default: *510 + default: *509 '404': description: Not Found if the discussion category name is invalid content: @@ -78972,9 +78590,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: + - *254 - *255 - - *256 - - *511 + - *510 responses: '204': description: Response @@ -78994,9 +78612,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: + - *254 - *255 - - *256 - - *511 + - *510 - *18 - *20 responses: @@ -79006,7 +78624,7 @@ paths: application/json: schema: type: array - items: *507 + items: *506 examples: default: value: @@ -79042,7 +78660,7 @@ paths: type: User site_admin: false headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79086,9 +78704,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: + - *254 - *255 - - *256 - - *511 + - *510 - name: name in: query required: true @@ -79114,7 +78732,7 @@ paths: description: Response for successful upload content: application/json: - schema: *507 + schema: *506 examples: response-for-successful-upload: value: @@ -79168,9 +78786,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: + - *254 - *255 - - *256 - - *511 + - *510 - 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. @@ -79194,11 +78812,11 @@ paths: application/json: schema: type: array - items: *248 + items: *247 examples: - default: *250 + default: *249 headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -79217,9 +78835,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: + - *254 - *255 - - *256 - - *511 + - *510 requestBody: required: true content: @@ -79249,16 +78867,16 @@ paths: description: Reaction exists content: application/json: - schema: *248 + schema: *247 examples: - default: *249 + default: *248 '201': description: Reaction created content: application/json: - schema: *248 + schema: *247 examples: - default: *249 + default: *248 '422': *16 x-github: githubCloudOnly: false @@ -79280,10 +78898,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: + - *254 - *255 - - *256 - - *511 - - *251 + - *510 + - *250 responses: '204': description: Response @@ -79307,9 +78925,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: + - *254 - *255 - - *256 - - *323 + - *322 - *18 - *20 responses: @@ -79325,8 +78943,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *512 - - &514 + - *511 + - &513 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -79346,53 +78964,53 @@ paths: type: integer description: The ID of the ruleset that includes this rule. - allOf: + - *512 - *513 + - allOf: - *514 + - *513 - allOf: - *515 - - *514 + - *513 - allOf: - *516 - - *514 + - *513 - allOf: - *517 - - *514 + - *513 - allOf: - *518 - - *514 + - *513 - allOf: - *519 - - *514 + - *513 - allOf: - *520 - - *514 + - *513 - allOf: - *521 - - *514 + - *513 - allOf: - *522 - - *514 + - *513 - allOf: - *523 - - *514 + - *513 - allOf: - *524 - - *514 + - *513 - allOf: - *525 - - *514 + - *513 - allOf: - *526 - - *514 + - *513 - allOf: - *527 - - *514 + - *513 - allOf: - *528 - - *514 - - allOf: - - *529 - - *514 + - *513 examples: default: value: @@ -79431,8 +79049,8 @@ paths: category: repos subcategory: rules parameters: + - *254 - *255 - - *256 - *18 - *20 - name: includes_parents @@ -79443,7 +79061,7 @@ paths: schema: type: boolean default: true - - *530 + - *529 responses: '200': description: Response @@ -79451,7 +79069,7 @@ paths: application/json: schema: type: array - items: *227 + items: *221 examples: default: value: @@ -79482,7 +79100,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *7 - '500': *41 + '500': *132 post: summary: Create a repository ruleset description: Create a ruleset for a repository. @@ -79498,8 +79116,8 @@ paths: category: repos subcategory: rules parameters: + - *254 - *255 - - *256 requestBody: description: Request body required: true @@ -79519,16 +79137,16 @@ paths: - tag - push default: branch - enforcement: *223 + enforcement: *217 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *224 - conditions: *221 + items: *218 + conditions: *215 rules: type: array description: An array of rules within the ruleset. - items: *226 + items: *220 required: - name - enforcement @@ -79559,9 +79177,9 @@ paths: description: Response content: application/json: - schema: *227 + schema: *221 examples: - default: &540 + default: &539 value: id: 42 name: super cool ruleset @@ -79594,7 +79212,7 @@ paths: created_at: '2023-07-15T08:43:03Z' updated_at: '2023-08-23T16:29:47Z' '404': *7 - '500': *41 + '500': *132 "/repos/{owner}/{repo}/rulesets/rule-suites": get: summary: List repository rule suites @@ -79608,12 +79226,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: + - *254 - *255 - - *256 + - *530 - *531 - *532 - *533 - - *534 - *18 - *20 responses: @@ -79621,11 +79239,11 @@ paths: description: Response content: application/json: - schema: *535 + schema: *534 examples: - default: *536 + default: *535 '404': *7 - '500': *41 + '500': *132 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79644,19 +79262,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: + - *254 - *255 - - *256 - - *537 + - *536 responses: '200': description: Response content: application/json: - schema: *538 + schema: *537 examples: - default: *539 + default: *538 '404': *7 - '500': *41 + '500': *132 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79682,8 +79300,8 @@ paths: category: repos subcategory: rules parameters: + - *254 - *255 - - *256 - name: ruleset_id description: The ID of the ruleset. in: path @@ -79703,11 +79321,11 @@ paths: description: Response content: application/json: - schema: *227 + schema: *221 examples: - default: *540 + default: *539 '404': *7 - '500': *41 + '500': *132 put: summary: Update a repository ruleset description: Update a ruleset for a repository. @@ -79723,8 +79341,8 @@ paths: category: repos subcategory: rules parameters: + - *254 - *255 - - *256 - name: ruleset_id description: The ID of the ruleset. in: path @@ -79749,16 +79367,16 @@ paths: - branch - tag - push - enforcement: *223 + enforcement: *217 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *224 - conditions: *221 + items: *218 + conditions: *215 rules: description: An array of rules within the ruleset. type: array - items: *226 + items: *220 examples: default: value: @@ -79786,11 +79404,11 @@ paths: description: Response content: application/json: - schema: *227 + schema: *221 examples: - default: *540 + default: *539 '404': *7 - '500': *41 + '500': *132 delete: summary: Delete a repository ruleset description: Delete a ruleset for a repository. @@ -79806,8 +79424,8 @@ paths: category: repos subcategory: rules parameters: + - *254 - *255 - - *256 - name: ruleset_id description: The ID of the ruleset. in: path @@ -79818,7 +79436,7 @@ paths: '204': description: Response '404': *7 - '500': *41 + '500': *132 "/repos/{owner}/{repo}/secret-scanning/alerts": get: summary: List secret scanning alerts for a repository @@ -79835,20 +79453,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: + - *254 - *255 - - *256 - - *229 - - *230 - - *231 - - *232 - - *42 + - *223 + - *224 + - *225 + - *226 + - *39 - *20 - *18 + - *540 - *541 - - *542 - - *233 - - *234 - - *235 + - *227 + - *228 + - *229 responses: '200': description: Response @@ -79856,11 +79474,11 @@ paths: application/json: schema: type: array - items: &545 + items: &544 type: object properties: - number: *48 - created_at: *49 + number: *46 + created_at: *47 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -79868,15 +79486,15 @@ paths: format: date-time readOnly: true nullable: true - url: *50 - html_url: *51 + url: *48 + html_url: *49 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *543 - resolution: *544 + state: *542 + resolution: *543 resolved_at: type: string format: date-time @@ -79930,6 +79548,11 @@ paths: properties: *4 required: *5 nullable: true + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection + bypass. + nullable: true push_protection_bypass_request_comment: type: string description: An optional comment when requesting a push protection @@ -80029,6 +79652,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 @@ -80051,6 +79675,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: @@ -80060,7 +79685,7 @@ paths: '404': description: Repository is public or secret scanning is disabled for the repository - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80082,15 +79707,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: + - *254 - *255 - - *256 - - *355 + - *354 responses: '200': description: Response content: application/json: - schema: *545 + schema: *544 examples: default: value: @@ -80110,6 +79735,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: @@ -80120,7 +79746,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80141,9 +79767,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: + - *254 - *255 - - *256 - - *355 + - *354 requestBody: required: true content: @@ -80151,8 +79777,8 @@ paths: schema: type: object properties: - state: *543 - resolution: *544 + state: *542 + resolution: *543 resolution_comment: description: An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. @@ -80170,7 +79796,7 @@ paths: description: Response content: application/json: - schema: *545 + schema: *544 examples: default: value: @@ -80208,6 +79834,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 @@ -80222,7 +79849,7 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment - '503': *63 + '503': *58 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -80244,9 +79871,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: + - *254 - *255 - - *256 - - *355 + - *354 - *20 - *18 responses: @@ -80257,7 +79884,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &678 + items: &677 type: object properties: type: @@ -80590,11 +80217,11 @@ paths: details: pull_request_review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 headers: - Link: *39 + Link: *51 '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80616,8 +80243,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -80625,14 +80252,14 @@ paths: schema: type: object properties: - reason: &547 + reason: &546 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *546 + placeholder_id: *545 required: - reason - placeholder_id @@ -80649,7 +80276,7 @@ paths: schema: type: object properties: - reason: *547 + reason: *546 expire_at: type: string format: date-time @@ -80672,7 +80299,7 @@ paths: this repository. '422': description: Bad request, input data missing or incorrect. - '503': *63 + '503': *58 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -80692,13 +80319,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: + - *254 - *255 - - *256 responses: '404': description: Repository does not have GitHub Advanced Security or secret scanning enabled - '503': *63 + '503': *58 '200': description: Response content: @@ -80708,7 +80335,7 @@ paths: properties: incremental_scans: type: array - items: &548 + items: &547 description: Information on a single scan performed by secret scanning on the repository type: object @@ -80734,15 +80361,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *548 + items: *547 backfill_scans: type: array - items: *548 + items: *547 custom_pattern_backfill_scans: type: array items: allOf: - - *548 + - *547 - type: object properties: pattern_name: @@ -80812,9 +80439,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: + - *254 - *255 - - *256 - - *42 + - *39 - name: sort description: The property to sort the results by. in: query @@ -80826,8 +80453,8 @@ paths: - updated - published default: created - - *43 - - *44 + - *40 + - *41 - 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)." @@ -80857,9 +80484,9 @@ paths: application/json: schema: type: array - items: *549 + items: *548 examples: - default: *550 + default: *549 '400': *15 '404': *7 x-github: @@ -80882,8 +80509,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -80956,7 +80583,7 @@ paths: login: type: string description: The username of the user credited. - type: *238 + type: *232 required: - login - type @@ -81043,9 +80670,9 @@ paths: description: Response content: application/json: - schema: *549 + schema: *548 examples: - default: &552 + default: &551 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -81278,8 +80905,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -81383,7 +81010,7 @@ paths: description: Response content: application/json: - schema: *549 + schema: *548 examples: default: value: @@ -81530,17 +81157,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: + - *254 - *255 - - *256 - - *551 + - *550 responses: '200': description: Response content: application/json: - schema: *549 + schema: *548 examples: - default: *552 + default: *551 '403': *29 '404': *7 x-github: @@ -81564,9 +81191,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: + - *254 - *255 - - *256 - - *551 + - *550 requestBody: required: true content: @@ -81639,7 +81266,7 @@ paths: login: type: string description: The username of the user credited. - type: *238 + type: *232 required: - login - type @@ -81725,17 +81352,17 @@ paths: description: Response content: application/json: - schema: *549 + schema: *548 examples: - default: *552 - add_credit: *552 + default: *551 + add_credit: *551 '403': *29 '404': *7 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *97 + schema: *90 examples: invalid_state_transition: value: @@ -81766,11 +81393,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: + - *254 - *255 - - *256 - - *551 + - *550 responses: - '202': *99 + '202': *92 '400': *15 '403': *29 '404': *7 @@ -81795,17 +81422,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: + - *254 - *255 - - *256 - - *551 + - *550 responses: '202': description: Response content: application/json: - schema: *266 + schema: *265 examples: - default: *268 + default: *267 '400': *15 '422': *16 '403': *29 @@ -81831,8 +81458,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -81909,7 +81536,7 @@ paths: type: User site_admin: false headers: - Link: *39 + Link: *51 '422': *16 x-github: githubCloudOnly: false @@ -81931,8 +81558,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: + - *254 - *255 - - *256 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -81941,7 +81568,7 @@ paths: application/json: schema: type: array - items: &553 + items: &552 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -81953,8 +81580,8 @@ paths: - - 1302998400 - 1124 - -435 - '202': *99 - '204': *138 + '202': *92 + '204': *131 '422': description: Repository contains more than 10,000 commits x-github: @@ -81974,8 +81601,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: + - *254 - *255 - - *256 responses: '200': description: Response @@ -82023,8 +81650,8 @@ paths: - 0 total: 89 week: 1336280400 - '202': *99 - '204': *138 + '202': *92 + '204': *131 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82051,8 +81678,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: + - *254 - *255 - - *256 responses: '200': description: Response @@ -82125,8 +81752,8 @@ paths: a: 6898 d: 77 c: 10 - '202': *99 - '204': *138 + '202': *92 + '204': *131 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82148,8 +81775,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: + - *254 - *255 - - *256 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -82303,8 +81930,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: + - *254 - *255 - - *256 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -82314,7 +81941,7 @@ paths: application/json: schema: type: array - items: *553 + items: *552 examples: default: value: @@ -82327,7 +81954,7 @@ paths: - - 0 - 2 - 21 - '204': *138 + '204': *131 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82347,8 +81974,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: + - *254 - *255 - - *256 - name: sha in: path required: true @@ -82402,7 +82029,7 @@ paths: description: Response content: application/json: - schema: *554 + schema: *553 examples: default: value: @@ -82456,8 +82083,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -82469,9 +82096,9 @@ paths: type: array items: *19 examples: - default: *184 + default: *177 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82489,14 +82116,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: + - *254 - *255 - - *256 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &555 + schema: &554 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -82564,8 +82191,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: + - *254 - *255 - - *256 requestBody: required: false content: @@ -82591,7 +82218,7 @@ paths: description: Response content: application/json: - schema: *555 + schema: *554 examples: default: value: @@ -82618,8 +82245,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: + - *254 - *255 - - *256 responses: '204': description: Response @@ -82639,8 +82266,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -82696,7 +82323,7 @@ paths: tarball_url: https://github.com/octocat/Hello-World/tarball/v0.1 node_id: MDQ6VXNlcjE= headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82719,8 +82346,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: + - *254 - *255 - - *256 responses: '200': description: Response @@ -82728,7 +82355,7 @@ paths: application/json: schema: type: array - items: &556 + items: &555 title: Tag protection description: Tag protection type: object @@ -82780,8 +82407,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: + - *254 - *255 - - *256 requestBody: required: true content: @@ -82804,7 +82431,7 @@ paths: description: Response content: application/json: - schema: *556 + schema: *555 examples: default: value: @@ -82835,8 +82462,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: + - *254 - *255 - - *256 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -82873,8 +82500,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: + - *254 - *255 - - *256 - name: ref in: path required: true @@ -82910,8 +82537,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -82921,11 +82548,11 @@ paths: application/json: schema: type: array - items: *181 + items: *174 examples: - default: *198 + default: *192 headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -82943,8 +82570,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: + - *254 - *255 - - *256 - *20 - *18 responses: @@ -82952,7 +82579,7 @@ paths: description: Response content: application/json: - schema: &557 + schema: &556 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -82964,7 +82591,7 @@ paths: required: - names examples: - default: &558 + default: &557 value: names: - octocat @@ -82987,8 +82614,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -83019,9 +82646,9 @@ paths: description: Response content: application/json: - schema: *557 + schema: *556 examples: - default: *558 + default: *557 '404': *7 '422': *8 x-github: @@ -83042,9 +82669,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: + - *254 - *255 - - *256 - - &559 + - &558 name: per description: The time frame to display results for. in: query @@ -83073,7 +82700,7 @@ paths: example: 128 clones: type: array - items: &560 + items: &559 title: Traffic type: object properties: @@ -83160,8 +82787,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: + - *254 - *255 - - *256 responses: '200': description: Response @@ -83251,8 +82878,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: + - *254 - *255 - - *256 responses: '200': description: Response @@ -83312,9 +82939,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: + - *254 - *255 - - *256 - - *559 + - *558 responses: '200': description: Response @@ -83333,7 +82960,7 @@ paths: example: 3782 views: type: array - items: *560 + items: *559 required: - uniques - count @@ -83410,8 +83037,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -83447,7 +83074,7 @@ paths: description: Response content: application/json: - schema: *113 + schema: *106 examples: default: value: @@ -83685,8 +83312,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: + - *254 - *255 - - *256 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -83709,8 +83336,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: + - *254 - *255 - - *256 responses: '204': description: Response @@ -83732,8 +83359,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: + - *254 - *255 - - *256 responses: '204': description: Response @@ -83759,8 +83386,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: + - *254 - *255 - - *256 - name: ref in: path required: true @@ -83852,9 +83479,9 @@ paths: description: Response content: application/json: - schema: *266 + schema: *265 examples: - default: *268 + default: *267 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -83895,7 +83522,7 @@ paths: application/json: schema: type: array - items: *113 + items: *106 examples: default: value: @@ -84084,7 +83711,7 @@ paths: html_url: type: string format: uri - repository: *113 + repository: *106 score: type: number file_size: @@ -84102,7 +83729,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &561 + text_matches: &560 title: Search Result Text Matches type: array items: @@ -84216,7 +83843,7 @@ paths: releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} score: 1 '304': *37 - '503': *63 + '503': *58 '422': *16 '403': *29 x-github: @@ -84264,7 +83891,7 @@ paths: enum: - author-date - committer-date - - &562 + - &561 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 @@ -84335,7 +83962,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *321 + properties: *320 nullable: true comment_count: type: integer @@ -84355,7 +83982,7 @@ paths: url: type: string format: uri - verification: *435 + verification: *434 required: - author - committer @@ -84374,7 +84001,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *321 + properties: *320 nullable: true parents: type: array @@ -84387,12 +84014,12 @@ paths: type: string sha: type: string - repository: *113 + repository: *106 score: type: number node_id: type: string - text_matches: *561 + text_matches: *560 required: - sha - node_id @@ -84584,7 +84211,7 @@ paths: - interactions - created - updated - - *562 + - *561 - *18 - *20 responses: @@ -84703,8 +84330,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *387 - required: *388 + properties: *386 + required: *387 nullable: true comments: type: integer @@ -84718,7 +84345,7 @@ paths: type: string format: date-time nullable: true - text_matches: *561 + text_matches: *560 pull_request: type: object properties: @@ -84751,10 +84378,10 @@ paths: type: string score: type: number - author_association: *61 + author_association: *56 draft: type: boolean - repository: *58 + repository: *53 body_html: type: string body_text: @@ -84771,9 +84398,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 - reactions: *62 + properties: *54 + required: *55 + reactions: *57 required: - assignee - closed_at @@ -84889,7 +84516,7 @@ paths: locked: true author_association: COLLABORATOR state_reason: completed - '503': *63 + '503': *58 '422': *16 '304': *37 '403': *29 @@ -84942,7 +84569,7 @@ paths: enum: - created - updated - - *562 + - *561 - *18 - *20 responses: @@ -84986,7 +84613,7 @@ paths: nullable: true score: type: number - text_matches: *561 + text_matches: *560 required: - id - node_id @@ -85071,7 +84698,7 @@ paths: - forks - help-wanted-issues - updated - - *562 + - *561 - *18 - *20 responses: @@ -85290,8 +84917,8 @@ paths: title: License Simple description: License Simple type: object - properties: *76 - required: *77 + properties: *71 + required: *72 nullable: true permissions: type: object @@ -85310,7 +84937,7 @@ paths: - admin - pull - push - text_matches: *561 + text_matches: *560 temp_clone_token: type: string allow_merge_commit: @@ -85512,7 +85139,7 @@ paths: spdx_id: MIT node_id: MDc6TGljZW5zZW1pdA== html_url: https://api.github.com/licenses/mit - '503': *63 + '503': *58 '422': *16 '304': *37 x-github: @@ -85610,7 +85237,7 @@ paths: type: string format: uri nullable: true - text_matches: *561 + text_matches: *560 related: type: array nullable: true @@ -85801,7 +85428,7 @@ paths: - followers - repositories - joined - - *562 + - *561 - *18 - *20 responses: @@ -85905,7 +85532,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *561 + text_matches: *560 blog: type: string nullable: true @@ -85964,7 +85591,7 @@ paths: events_url: https://api.github.com/users/mojombo/events{/privacy} site_admin: true '304': *37 - '503': *63 + '503': *58 '422': *16 x-github: githubCloudOnly: false @@ -85984,7 +85611,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &563 + - &562 name: team_id description: The unique identifier of the team. in: path @@ -85996,9 +85623,9 @@ paths: description: Response content: application/json: - schema: *240 + schema: *239 examples: - default: *241 + default: *240 '404': *7 x-github: githubCloudOnly: false @@ -86025,7 +85652,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *563 + - *562 requestBody: required: true content: @@ -86088,16 +85715,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *240 + schema: *239 examples: - default: *241 + default: *240 '201': description: Response content: application/json: - schema: *240 + schema: *239 examples: - default: *241 + default: *240 '404': *7 '422': *16 '403': *29 @@ -86125,7 +85752,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *563 + - *562 responses: '204': description: Response @@ -86156,8 +85783,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy parameters: - - *563 - - *42 + - *562 + - *39 - *18 - *20 responses: @@ -86167,11 +85794,11 @@ paths: application/json: schema: type: array - items: *242 + items: *241 examples: - default: *564 + default: *563 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86198,7 +85825,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy parameters: - - *563 + - *562 requestBody: required: true content: @@ -86232,9 +85859,9 @@ paths: description: Response content: application/json: - schema: *242 + schema: *241 examples: - default: *243 + default: *242 x-github: triggersNotification: true githubCloudOnly: false @@ -86261,16 +85888,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy parameters: - - *563 - - *244 + - *562 + - *243 responses: '200': description: Response content: application/json: - schema: *242 + schema: *241 examples: - default: *243 + default: *242 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86295,8 +85922,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy parameters: - - *563 - - *244 + - *562 + - *243 requestBody: required: false content: @@ -86319,9 +85946,9 @@ paths: description: Response content: application/json: - schema: *242 + schema: *241 examples: - default: *565 + default: *564 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86346,8 +85973,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy parameters: - - *563 - - *244 + - *562 + - *243 responses: '204': description: Response @@ -86376,9 +86003,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *563 - - *244 - - *42 + - *562 + - *243 + - *39 - *18 - *20 responses: @@ -86388,11 +86015,11 @@ paths: application/json: schema: type: array - items: *245 + items: *244 examples: - default: *566 + default: *565 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86419,8 +86046,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *563 - - *244 + - *562 + - *243 requestBody: required: true content: @@ -86442,9 +86069,9 @@ paths: description: Response content: application/json: - schema: *245 + schema: *244 examples: - default: *246 + default: *245 x-github: triggersNotification: true githubCloudOnly: false @@ -86471,17 +86098,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *563 - - *244 - - *247 + - *562 + - *243 + - *246 responses: '200': description: Response content: application/json: - schema: *245 + schema: *244 examples: - default: *246 + default: *245 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86506,9 +86133,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *563 - - *244 - - *247 + - *562 + - *243 + - *246 requestBody: required: true content: @@ -86530,9 +86157,9 @@ paths: description: Response content: application/json: - schema: *245 + schema: *244 examples: - default: *567 + default: *566 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86557,9 +86184,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *563 - - *244 - - *247 + - *562 + - *243 + - *246 responses: '204': description: Response @@ -86588,9 +86215,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *563 - - *244 - - *247 + - *562 + - *243 + - *246 - 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. @@ -86616,11 +86243,11 @@ paths: application/json: schema: type: array - items: *248 + items: *247 examples: - default: *250 + default: *249 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86647,9 +86274,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *563 - - *244 - - *247 + - *562 + - *243 + - *246 requestBody: required: true content: @@ -86681,9 +86308,9 @@ paths: description: Response content: application/json: - schema: *248 + schema: *247 examples: - default: *249 + default: *248 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86709,8 +86336,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *563 - - *244 + - *562 + - *243 - 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. @@ -86736,11 +86363,11 @@ paths: application/json: schema: type: array - items: *248 + items: *247 examples: - default: *250 + default: *249 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86767,8 +86394,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *563 - - *244 + - *562 + - *243 requestBody: required: true content: @@ -86800,9 +86427,9 @@ paths: description: Response content: application/json: - schema: *248 + schema: *247 examples: - default: *249 + default: *248 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -86826,7 +86453,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *563 + - *562 - *18 - *20 responses: @@ -86836,11 +86463,11 @@ paths: application/json: schema: type: array - items: *178 + items: *171 examples: - default: *179 + default: *172 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86864,7 +86491,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *563 + - *562 - name: role description: Filters members returned by their role in the team. in: query @@ -86887,9 +86514,9 @@ paths: type: array items: *19 examples: - default: *184 + default: *177 headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -86915,8 +86542,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *563 - - *126 + - *562 + - *119 responses: '204': description: if user is a member @@ -86952,8 +86579,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *563 - - *126 + - *562 + - *119 responses: '204': description: Response @@ -86992,8 +86619,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *563 - - *126 + - *562 + - *119 responses: '204': description: Response @@ -87029,16 +86656,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *563 - - *126 + - *562 + - *119 responses: '200': description: Response content: application/json: - schema: *252 + schema: *251 examples: - response-if-user-is-a-team-maintainer: *568 + response-if-user-is-a-team-maintainer: *567 '404': *7 x-github: githubCloudOnly: false @@ -87071,8 +86698,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *563 - - *126 + - *562 + - *119 requestBody: required: false content: @@ -87097,9 +86724,9 @@ paths: description: Response content: application/json: - schema: *252 + schema: *251 examples: - response-if-users-membership-with-team-is-now-pending: *569 + response-if-users-membership-with-team-is-now-pending: *568 '403': description: Forbidden if team synchronization is set up '422': @@ -87133,8 +86760,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *563 - - *126 + - *562 + - *119 responses: '204': description: Response @@ -87163,7 +86790,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy parameters: - - *563 + - *562 - *18 - *20 responses: @@ -87173,11 +86800,11 @@ paths: application/json: schema: type: array - items: *253 + items: *252 examples: - default: *570 + default: *569 headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -87202,16 +86829,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy parameters: - - *563 - - *254 + - *562 + - *253 responses: '200': description: Response content: application/json: - schema: *253 + schema: *252 examples: - default: *571 + default: *570 '404': description: Not Found if project is not managed by this team x-github: @@ -87236,8 +86863,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy parameters: - - *563 - - *254 + - *562 + - *253 requestBody: required: false content: @@ -87305,8 +86932,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy parameters: - - *563 - - *254 + - *562 + - *253 responses: '204': description: Response @@ -87333,7 +86960,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *563 + - *562 - *18 - *20 responses: @@ -87343,11 +86970,11 @@ paths: application/json: schema: type: array - items: *113 + items: *106 examples: - default: *205 + default: *199 headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -87375,15 +87002,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *563 + - *562 + - *254 - *255 - - *256 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *572 + schema: *571 examples: alternative-response-with-extra-repository-information: value: @@ -87534,9 +87161,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *563 + - *562 + - *254 - *255 - - *256 requestBody: required: false content: @@ -87586,9 +87213,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *563 + - *562 + - *254 - *255 - - *256 responses: '204': description: Response @@ -87613,7 +87240,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *563 + - *562 - *18 - *20 responses: @@ -87623,11 +87250,11 @@ paths: application/json: schema: type: array - items: *181 + items: *174 examples: - response-if-child-teams-exist: *573 + response-if-child-teams-exist: *572 headers: - Link: *39 + Link: *51 '404': *7 '403': *29 '422': *16 @@ -87658,7 +87285,7 @@ paths: application/json: schema: oneOf: - - &575 + - &574 title: Private User description: Private User type: object @@ -87861,7 +87488,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *574 + - *573 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -88014,7 +87641,7 @@ paths: description: Response content: application/json: - schema: *575 + schema: *574 examples: default: value: @@ -88093,7 +87720,7 @@ paths: type: array items: *19 examples: - default: *184 + default: *177 '304': *37 '404': *7 '403': *29 @@ -88116,7 +87743,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: - - *126 + - *119 responses: '204': description: If the user is blocked @@ -88144,7 +87771,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#block-a-user parameters: - - *126 + - *119 responses: '204': description: Response @@ -88168,7 +87795,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#unblock-a-user parameters: - - *126 + - *119 responses: '204': description: Response @@ -88217,11 +87844,11 @@ paths: type: integer codespaces: type: array - items: *185 + items: *178 examples: - default: *186 + default: *179 '304': *37 - '500': *41 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -88358,21 +87985,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *185 + schema: *178 examples: - default: *372 + default: *371 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *185 + schema: *178 examples: - default: *372 + default: *371 '401': *25 '403': *29 '404': *7 - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -88412,7 +88039,7 @@ paths: type: integer secrets: type: array - items: &576 + items: &575 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -88452,9 +88079,9 @@ paths: - visibility - selected_repositories_url examples: - default: *375 + default: *374 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -88522,13 +88149,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *121 + - *114 responses: '200': description: Response content: application/json: - schema: *576 + schema: *575 examples: default: value: @@ -88558,7 +88185,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *121 + - *114 requestBody: required: true content: @@ -88603,7 +88230,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -88631,7 +88258,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *121 + - *114 responses: '204': description: Response @@ -88656,7 +88283,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *121 + - *114 responses: '200': description: Response @@ -88672,13 +88299,13 @@ paths: type: integer repositories: type: array - items: *113 + items: *106 examples: - default: *577 + default: *576 '401': *25 '403': *29 '404': *7 - '500': *41 + '500': *132 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -88699,7 +88326,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *121 + - *114 requestBody: required: true content: @@ -88731,7 +88358,7 @@ paths: '401': *25 '403': *29 '404': *7 - '500': *41 + '500': *132 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -88753,7 +88380,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *121 + - *114 - name: repository_id in: path required: true @@ -88765,7 +88392,7 @@ paths: '401': *25 '403': *29 '404': *7 - '500': *41 + '500': *132 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -88786,7 +88413,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *121 + - *114 - name: repository_id in: path required: true @@ -88798,7 +88425,7 @@ paths: '401': *25 '403': *29 '404': *7 - '500': *41 + '500': *132 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -88818,17 +88445,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *187 + - *180 responses: '200': description: Response content: application/json: - schema: *185 + schema: *178 examples: - default: *372 + default: *371 '304': *37 - '500': *41 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -88852,7 +88479,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *187 + - *180 requestBody: required: false content: @@ -88882,9 +88509,9 @@ paths: description: Response content: application/json: - schema: *185 + schema: *178 examples: - default: *372 + default: *371 '401': *25 '403': *29 '404': *7 @@ -88906,11 +88533,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *187 + - *180 responses: - '202': *99 + '202': *92 '304': *37 - '500': *41 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -88935,13 +88562,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *187 + - *180 responses: '202': description: Response content: application/json: - schema: &578 + schema: &577 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -88982,7 +88609,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &579 + default: &578 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -88990,7 +88617,7 @@ paths: sha: fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 id: latest export_url: https://api.github.com/user/codespaces/:name/exports/latest - '500': *41 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -89014,7 +88641,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *187 + - *180 - name: export_id in: path required: true @@ -89027,9 +88654,9 @@ paths: description: Response content: application/json: - schema: *578 + schema: *577 examples: - default: *579 + default: *578 '404': *7 x-github: githubCloudOnly: false @@ -89050,7 +88677,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *187 + - *180 responses: '200': description: Response @@ -89066,11 +88693,11 @@ paths: type: integer machines: type: array - items: *580 + items: *579 examples: - default: *581 + default: *580 '304': *37 - '500': *41 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -89097,7 +88724,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *187 + - *180 requestBody: required: true content: @@ -89147,13 +88774,13 @@ paths: nullable: true owner: *19 billable_owner: *19 - repository: *266 + repository: *265 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *373 - required: *374 + properties: *372 + required: *373 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -89927,17 +89554,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *187 + - *180 responses: '200': description: Response content: application/json: - schema: *185 + schema: *178 examples: - default: *372 + default: *371 '304': *37 - '500': *41 + '500': *132 '400': *15 '401': *25 '402': @@ -89947,7 +89574,7 @@ paths: schema: *3 '403': *29 '404': *7 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -89967,16 +89594,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *187 + - *180 responses: '200': description: Response content: application/json: - schema: *185 + schema: *178 examples: - default: *372 - '500': *41 + default: *371 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -90005,9 +89632,9 @@ paths: application/json: schema: type: array - items: *199 + items: *193 examples: - default: &594 + default: &593 value: - id: 197 name: hello_docker @@ -90108,7 +89735,7 @@ paths: application/json: schema: type: array - items: &582 + items: &581 title: Email description: Email type: object @@ -90173,16 +89800,16 @@ paths: application/json: schema: type: array - items: *582 + items: *581 examples: - default: &596 + default: &595 value: - email: octocat@github.com verified: true primary: true visibility: public headers: - Link: *39 + Link: *51 '304': *37 '404': *7 '403': *29 @@ -90250,7 +89877,7 @@ paths: application/json: schema: type: array - items: *582 + items: *581 examples: default: value: @@ -90360,9 +89987,9 @@ paths: type: array items: *19 examples: - default: *184 + default: *177 headers: - Link: *39 + Link: *51 '304': *37 '403': *29 '401': *25 @@ -90393,9 +90020,9 @@ paths: type: array items: *19 examples: - default: *184 + default: *177 headers: - Link: *39 + Link: *51 '304': *37 '403': *29 '401': *25 @@ -90415,7 +90042,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: - - *126 + - *119 responses: '204': description: if the person is followed by the authenticated user @@ -90445,7 +90072,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#follow-a-user parameters: - - *126 + - *119 responses: '204': description: Response @@ -90470,7 +90097,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#unfollow-a-user parameters: - - *126 + - *119 responses: '204': description: Response @@ -90506,7 +90133,7 @@ paths: application/json: schema: type: array - items: &583 + items: &582 title: GPG Key description: A unique encryption key type: object @@ -90637,7 +90264,7 @@ paths: - subkeys - revoked examples: - default: &607 + default: &606 value: - id: 3 name: Octocat's GPG Key @@ -90669,7 +90296,7 @@ paths: revoked: false raw_key: string headers: - Link: *39 + Link: *51 '304': *37 '404': *7 '403': *29 @@ -90722,9 +90349,9 @@ paths: description: Response content: application/json: - schema: *583 + schema: *582 examples: - default: &584 + default: &583 value: id: 3 name: Octocat's GPG Key @@ -90781,7 +90408,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &585 + - &584 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -90793,9 +90420,9 @@ paths: description: Response content: application/json: - schema: *583 + schema: *582 examples: - default: *584 + default: *583 '404': *7 '304': *37 '403': *29 @@ -90818,7 +90445,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *585 + - *584 responses: '204': description: Response @@ -90961,7 +90588,7 @@ paths: suspended_at: suspended_by: headers: - Link: *39 + Link: *51 '304': *37 '403': *29 '401': *25 @@ -91007,11 +90634,11 @@ paths: type: string repositories: type: array - items: *58 + items: *53 examples: - default: *586 + default: *585 headers: - Link: *39 + Link: *51 '404': *7 '403': *29 '304': *37 @@ -91034,7 +90661,7 @@ paths: url: https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *23 - - *104 + - *97 responses: '204': description: Response @@ -91060,7 +90687,7 @@ paths: url: https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *23 - - *104 + - *97 responses: '204': description: Response @@ -91094,12 +90721,12 @@ paths: application/json: schema: anyOf: - - *176 + - *169 - type: object properties: {} additionalProperties: false examples: - default: *177 + default: *170 '204': description: Response when there are no restrictions x-github: @@ -91123,7 +90750,7 @@ paths: required: true content: application/json: - schema: *446 + schema: *445 examples: default: value: @@ -91134,7 +90761,7 @@ paths: description: Response content: application/json: - schema: *176 + schema: *169 examples: default: value: @@ -91215,7 +90842,7 @@ paths: - closed - all default: open - - *182 + - *175 - name: sort description: What to sort results by. in: query @@ -91227,8 +90854,8 @@ paths: - updated - comments default: created - - *42 - - *65 + - *39 + - *60 - *18 - *20 responses: @@ -91238,11 +90865,11 @@ paths: application/json: schema: type: array - items: *75 + items: *70 examples: - default: *183 + default: *176 headers: - Link: *39 + Link: *51 '404': *7 '304': *37 x-github: @@ -91273,7 +90900,7 @@ paths: application/json: schema: type: array - items: &587 + items: &586 title: Key description: Key type: object @@ -91320,7 +90947,7 @@ paths: verified: false read_only: false headers: - Link: *39 + Link: *51 '304': *37 '404': *7 '403': *29 @@ -91370,9 +90997,9 @@ paths: description: Response content: application/json: - schema: *587 + schema: *586 examples: - default: &588 + default: &587 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -91405,15 +91032,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *475 + - *474 responses: '200': description: Response content: application/json: - schema: *587 + schema: *586 examples: - default: *588 + default: *587 '404': *7 '304': *37 '403': *29 @@ -91436,7 +91063,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *475 + - *474 responses: '204': description: Response @@ -91469,7 +91096,7 @@ paths: application/json: schema: type: array - items: &589 + items: &588 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -91526,7 +91153,7 @@ paths: - id - type - login - plan: *79 + plan: *74 required: - billing_cycle - next_billing_date @@ -91537,7 +91164,7 @@ paths: - account - plan examples: - default: &590 + default: &589 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -91570,7 +91197,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *39 + Link: *51 '304': *37 '401': *25 '404': *7 @@ -91599,11 +91226,11 @@ paths: application/json: schema: type: array - items: *589 + items: *588 examples: - default: *590 + default: *589 headers: - Link: *39 + Link: *51 '304': *37 '401': *25 x-github: @@ -91641,7 +91268,7 @@ paths: application/json: schema: type: array - items: *189 + items: *183 examples: default: value: @@ -91718,7 +91345,7 @@ paths: type: User site_admin: false headers: - Link: *39 + Link: *51 '304': *37 '403': *29 '401': *25 @@ -91743,13 +91370,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user parameters: - - *94 + - *87 responses: '200': description: Response content: application/json: - schema: *189 + schema: *183 examples: default: value: @@ -91807,7 +91434,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user parameters: - - *94 + - *87 requestBody: required: true content: @@ -91832,7 +91459,7 @@ paths: description: Response content: application/json: - schema: *189 + schema: *183 examples: default: value: @@ -91900,7 +91527,7 @@ paths: application/json: schema: type: array - items: *191 + items: *185 examples: default: value: @@ -92053,7 +91680,7 @@ paths: updated_at: '2015-07-06T15:33:38-07:00' node_id: MDQ6VXNlcjE= headers: - Link: *39 + Link: *51 '304': *37 '403': *29 '401': *25 @@ -92153,7 +91780,7 @@ paths: description: Response content: application/json: - schema: *191 + schema: *185 examples: default: value: @@ -92333,7 +91960,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status parameters: - - *192 + - *186 - name: exclude in: query required: false @@ -92346,7 +91973,7 @@ paths: description: Response content: application/json: - schema: *191 + schema: *185 examples: default: value: @@ -92540,7 +92167,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive parameters: - - *192 + - *186 responses: '302': description: Response @@ -92566,7 +92193,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive parameters: - - *192 + - *186 responses: '204': description: Response @@ -92595,8 +92222,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - - *192 - - *591 + - *186 + - *590 responses: '204': description: Response @@ -92620,7 +92247,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *192 + - *186 - *18 - *20 responses: @@ -92630,11 +92257,11 @@ paths: application/json: schema: type: array - items: *113 + items: *106 examples: - default: *205 + default: *199 headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -92667,11 +92294,11 @@ paths: application/json: schema: type: array - items: *188 + items: *182 examples: - default: *592 + default: *591 headers: - Link: *39 + Link: *51 '304': *37 '403': *29 '401': *25 @@ -92711,7 +92338,7 @@ paths: - docker - nuget - container - - *593 + - *592 - *20 - *18 responses: @@ -92721,10 +92348,10 @@ paths: application/json: schema: type: array - items: *199 + items: *193 examples: - default: *594 - '400': *595 + default: *593 + '400': *594 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -92744,16 +92371,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *201 - - *202 + - *195 + - *196 responses: '200': description: Response content: application/json: - schema: *199 + schema: *193 examples: - default: &608 + default: &607 value: id: 40201 name: octo-name @@ -92866,8 +92493,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *201 - - *202 + - *195 + - *196 responses: '204': description: Response @@ -92897,8 +92524,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *201 - - *202 + - *195 + - *196 - name: token description: package token schema: @@ -92930,8 +92557,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: - - *201 - - *202 + - *195 + - *196 - *20 - *18 - name: state @@ -92951,7 +92578,7 @@ paths: application/json: schema: type: array - items: *203 + items: *197 examples: default: value: @@ -93000,15 +92627,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *201 - - *202 - - *204 + - *195 + - *196 + - *198 responses: '200': description: Response content: application/json: - schema: *203 + schema: *197 examples: default: value: @@ -93044,9 +92671,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *201 - - *202 - - *204 + - *195 + - *196 + - *198 responses: '204': description: Response @@ -93076,9 +92703,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *201 - - *202 - - *204 + - *195 + - *196 + - *198 responses: '204': description: Response @@ -93134,7 +92761,7 @@ paths: description: Response content: application/json: - schema: *212 + schema: *206 examples: default: value: @@ -93203,11 +92830,11 @@ paths: application/json: schema: type: array - items: *582 + items: *581 examples: - default: *596 + default: *595 headers: - Link: *39 + Link: *51 '304': *37 '404': *7 '403': *29 @@ -93316,9 +92943,9 @@ paths: application/json: schema: type: array - items: *58 + items: *53 examples: - default: &603 + default: &602 summary: Default response value: - id: 1296269 @@ -93620,9 +93247,9 @@ paths: description: Response content: application/json: - schema: *266 + schema: *265 examples: - default: *268 + default: *267 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -93660,11 +93287,11 @@ paths: application/json: schema: type: array - items: *448 + items: *447 examples: - default: *597 + default: *596 headers: - Link: *39 + Link: *51 '304': *37 '404': *7 '403': *29 @@ -93685,12 +93312,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *180 + - *173 responses: '204': description: Response '403': *29 - '409': *134 + '409': *127 '404': *7 '304': *37 x-github: @@ -93708,11 +93335,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *180 + - *173 responses: '204': description: Response - '409': *134 + '409': *127 '304': *37 '404': *7 '403': *29 @@ -93741,7 +93368,7 @@ paths: application/json: schema: type: array - items: &598 + items: &597 title: Social account description: Social media account type: object @@ -93756,12 +93383,12 @@ paths: - provider - url examples: - default: &599 + default: &598 value: - provider: twitter url: https://twitter.com/github headers: - Link: *39 + Link: *51 '304': *37 '404': *7 '403': *29 @@ -93818,9 +93445,9 @@ paths: application/json: schema: type: array - items: *598 + items: *597 examples: - default: *599 + default: *598 '422': *16 '304': *37 '404': *7 @@ -93907,7 +93534,7 @@ paths: application/json: schema: type: array - items: &600 + items: &599 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -93927,7 +93554,7 @@ paths: - title - created_at examples: - default: &615 + default: &614 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -93940,7 +93567,7 @@ paths: title: ssh-rsa AAAAB3NzaC1yc2EAAB created_at: '2020-07-11T21:31:57Z' headers: - Link: *39 + Link: *51 '304': *37 '404': *7 '403': *29 @@ -93993,9 +93620,9 @@ paths: description: Response content: application/json: - schema: *600 + schema: *599 examples: - default: &601 + default: &600 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -94026,7 +93653,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: - - &602 + - &601 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -94038,9 +93665,9 @@ paths: description: Response content: application/json: - schema: *600 + schema: *599 examples: - default: *601 + default: *600 '404': *7 '304': *37 '403': *29 @@ -94063,7 +93690,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: - - *602 + - *601 responses: '204': description: Response @@ -94092,7 +93719,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &616 + - &615 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 @@ -94105,7 +93732,7 @@ paths: - created - updated default: created - - *42 + - *39 - *18 - *20 responses: @@ -94115,13 +93742,13 @@ paths: application/json: schema: type: array - items: *58 + items: *53 examples: - default-response: *603 + default-response: *602 application/vnd.github.v3.star+json: schema: type: array - items: &617 + items: &616 title: Starred Repository description: Starred Repository type: object @@ -94129,7 +93756,7 @@ paths: starred_at: type: string format: date-time - repo: *58 + repo: *53 required: - starred_at - repo @@ -94257,7 +93884,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *39 + Link: *51 '304': *37 '403': *29 '401': *25 @@ -94277,8 +93904,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: + - *254 - *255 - - *256 responses: '204': description: Response if this repository is starred by you @@ -94306,8 +93933,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: + - *254 - *255 - - *256 responses: '204': description: Response @@ -94331,8 +93958,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: + - *254 - *255 - - *256 responses: '204': description: Response @@ -94365,11 +93992,11 @@ paths: application/json: schema: type: array - items: *113 + items: *106 examples: - default: *205 + default: *199 headers: - Link: *39 + Link: *51 '304': *37 '403': *29 '401': *25 @@ -94404,7 +94031,7 @@ paths: application/json: schema: type: array - items: *240 + items: *239 examples: default: value: @@ -94455,7 +94082,7 @@ paths: updated_at: '2017-08-17T12:37:15Z' type: Organization headers: - Link: *39 + Link: *51 '304': *37 '404': *7 '403': *29 @@ -94480,7 +94107,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user-using-their-id parameters: - - *81 + - *76 responses: '200': description: Response @@ -94488,10 +94115,10 @@ paths: application/json: schema: oneOf: - - *575 - *574 + - *573 examples: - default-response: &605 + default-response: &604 summary: Default response value: login: octocat @@ -94526,7 +94153,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &606 + response-with-git-hub-plan-information: &605 summary: Response with GitHub plan information value: login: octocat @@ -94586,7 +94213,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *604 + - *603 - *18 responses: '200': @@ -94597,7 +94224,7 @@ paths: type: array items: *19 examples: - default: *184 + default: *177 headers: Link: example: ; rel="next" @@ -94625,7 +94252,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user parameters: - - *126 + - *119 responses: '200': description: Response @@ -94633,11 +94260,11 @@ paths: application/json: schema: oneOf: - - *575 - *574 + - *573 examples: - default-response: *605 - response-with-git-hub-plan-information: *606 + default-response: *604 + response-with-git-hub-plan-information: *605 '404': *7 x-github: githubCloudOnly: false @@ -94661,9 +94288,9 @@ paths: url: https://docs.github.com/rest/users/attestations#list-attestations parameters: - *18 - - *43 - - *44 - - *126 + - *40 + - *41 + - *119 - name: subject_digest description: Subject Digest in: path @@ -94756,6 +94383,8 @@ paths: type: string repository_id: type: integer + bundle_url: + type: string examples: default: value: @@ -94763,7 +94392,7 @@ paths: description: Response content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -94789,7 +94418,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: - - *126 + - *119 responses: '200': description: Response @@ -94797,9 +94426,9 @@ paths: application/json: schema: type: array - items: *199 + items: *193 examples: - default: *594 + default: *593 '403': *29 '401': *25 x-github: @@ -94822,7 +94451,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-for-the-authenticated-user parameters: - - *126 + - *119 - *18 - *20 responses: @@ -94832,7 +94461,7 @@ paths: application/json: schema: type: array - items: *87 + items: *82 examples: default: value: @@ -94903,8 +94532,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-organization-events-for-the-authenticated-user parameters: - - *126 - - *94 + - *119 + - *87 - *18 - *20 responses: @@ -94914,7 +94543,7 @@ paths: application/json: schema: type: array - items: *87 + items: *82 examples: default: value: @@ -94993,7 +94622,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-user parameters: - - *126 + - *119 - *18 - *20 responses: @@ -95003,7 +94632,7 @@ paths: application/json: schema: type: array - items: *87 + items: *82 examples: default: value: @@ -95070,7 +94699,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-followers-of-a-user parameters: - - *126 + - *119 - *18 - *20 responses: @@ -95082,9 +94711,9 @@ paths: type: array items: *19 examples: - default: *184 + default: *177 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95101,7 +94730,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-the-people-a-user-follows parameters: - - *126 + - *119 - *18 - *20 responses: @@ -95113,9 +94742,9 @@ paths: type: array items: *19 examples: - default: *184 + default: *177 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95132,7 +94761,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user parameters: - - *126 + - *119 - name: target_user in: path required: true @@ -95159,8 +94788,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-a-user parameters: - - *126 - - *65 + - *119 + - *60 - *18 - *20 responses: @@ -95170,11 +94799,11 @@ paths: application/json: schema: type: array - items: *66 + items: *61 examples: - default: *67 + default: *62 headers: - Link: *39 + Link: *51 '422': *16 x-github: githubCloudOnly: false @@ -95193,7 +94822,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user parameters: - - *126 + - *119 - *18 - *20 responses: @@ -95203,11 +94832,11 @@ paths: application/json: schema: type: array - items: *583 + items: *582 examples: - default: *607 + default: *606 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95229,7 +94858,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-contextual-information-for-a-user parameters: - - *126 + - *119 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -95301,7 +94930,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-user-installation-for-the-authenticated-app parameters: - - *126 + - *119 responses: '200': description: Response @@ -95309,7 +94938,7 @@ paths: application/json: schema: *22 examples: - default: *445 + default: *444 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -95327,7 +94956,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#list-public-keys-for-a-user parameters: - - *126 + - *119 - *18 - *20 responses: @@ -95355,7 +94984,7 @@ paths: - id: 1 key: ssh-rsa AAA... headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95375,7 +95004,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-organizations-for-a-user parameters: - - *126 + - *119 - *18 - *20 responses: @@ -95385,11 +95014,11 @@ paths: application/json: schema: type: array - items: *188 + items: *182 examples: - default: *592 + default: *591 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95426,8 +95055,8 @@ paths: - docker - nuget - container - - *593 - - *126 + - *592 + - *119 - *20 - *18 responses: @@ -95437,12 +95066,12 @@ paths: application/json: schema: type: array - items: *199 + items: *193 examples: - default: *594 + default: *593 '403': *29 '401': *25 - '400': *595 + '400': *594 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -95462,17 +95091,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user parameters: - - *201 - - *202 - - *126 + - *195 + - *196 + - *119 responses: '200': description: Response content: application/json: - schema: *199 + schema: *193 examples: - default: *608 + default: *607 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -95493,9 +95122,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user parameters: - - *201 - - *202 - - *126 + - *195 + - *196 + - *119 responses: '204': description: Response @@ -95527,9 +95156,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user parameters: - - *201 - - *202 - - *126 + - *195 + - *196 + - *119 - name: token description: package token schema: @@ -95561,9 +95190,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: - - *201 - - *202 - - *126 + - *195 + - *196 + - *119 responses: '200': description: Response @@ -95571,7 +95200,7 @@ paths: application/json: schema: type: array - items: *203 + items: *197 examples: default: value: @@ -95629,16 +95258,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user parameters: - - *201 - - *202 - - *204 - - *126 + - *195 + - *196 + - *198 + - *119 responses: '200': description: Response content: application/json: - schema: *203 + schema: *197 examples: default: value: @@ -95673,10 +95302,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user parameters: - - *201 - - *202 - - *126 - - *204 + - *195 + - *196 + - *119 + - *198 responses: '204': description: Response @@ -95708,10 +95337,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user parameters: - - *201 - - *202 - - *126 - - *204 + - *195 + - *196 + - *119 + - *198 responses: '204': description: Response @@ -95734,7 +95363,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-user-projects parameters: - - *126 + - *119 - name: state description: Indicates the state of the projects to return. in: query @@ -95755,7 +95384,7 @@ paths: application/json: schema: type: array - items: *212 + items: *206 examples: default: value: @@ -95791,7 +95420,7 @@ paths: created_at: '2011-04-10T20:09:31Z' updated_at: '2014-03-03T18:58:10Z' headers: - Link: *39 + Link: *51 '422': *16 x-github: githubCloudOnly: false @@ -95814,7 +95443,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-received-by-the-authenticated-user parameters: - - *126 + - *119 - *18 - *20 responses: @@ -95824,7 +95453,7 @@ paths: application/json: schema: type: array - items: *87 + items: *82 examples: default: value: @@ -95903,7 +95532,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-received-by-a-user parameters: - - *126 + - *119 - *18 - *20 responses: @@ -95913,7 +95542,7 @@ paths: application/json: schema: type: array - items: *87 + items: *82 examples: default: value: @@ -95990,7 +95619,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repositories-for-a-user parameters: - - *126 + - *119 - name: type description: Limit results to repositories of the specified type. in: query @@ -96033,11 +95662,11 @@ paths: application/json: schema: type: array - items: *113 + items: *106 examples: - default: *205 + default: *199 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96059,15 +95688,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-a-user parameters: - - *126 + - *119 responses: '200': description: Response content: application/json: - schema: *609 + schema: *608 examples: - default: *610 + default: *609 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -96089,15 +95718,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-a-user parameters: - - *126 + - *119 responses: '200': description: Response content: application/json: - schema: *611 + schema: *610 examples: - default: *612 + default: *611 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -96119,15 +95748,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-a-user parameters: - - *126 + - *119 responses: '200': description: Response content: application/json: - schema: *613 + schema: *612 examples: - default: *614 + default: *613 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -96145,7 +95774,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-a-user parameters: - - *126 + - *119 - *18 - *20 responses: @@ -96155,11 +95784,11 @@ paths: application/json: schema: type: array - items: *598 + items: *597 examples: - default: *599 + default: *598 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96177,7 +95806,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user parameters: - - *126 + - *119 - *18 - *20 responses: @@ -96187,11 +95816,11 @@ paths: application/json: schema: type: array - items: *600 + items: *599 examples: - default: *615 + default: *614 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96213,9 +95842,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *126 - - *616 - - *42 + - *119 + - *615 + - *39 - *18 - *20 responses: @@ -96226,13 +95855,13 @@ paths: schema: anyOf: - type: array - items: *617 + items: *616 - type: array - items: *58 + items: *53 examples: - default-response: *603 + default-response: *602 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96249,7 +95878,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *126 + - *119 - *18 - *20 responses: @@ -96259,11 +95888,11 @@ paths: application/json: schema: type: array - items: *113 + items: *106 examples: - default: *205 + default: *199 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96389,7 +96018,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &618 + enterprise: &617 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -96447,7 +96076,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &619 + installation: &618 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -96466,7 +96095,7 @@ x-webhooks: required: - id - node_id - organization: &620 + organization: &619 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -96526,13 +96155,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &621 + repository: &620 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &651 + properties: &650 id: description: Unique identifier of the repository example: 42 @@ -96552,8 +96181,8 @@ x-webhooks: title: License Simple description: License Simple type: object - properties: *76 - required: *77 + properties: *71 + required: *72 nullable: true organization: title: Simple User @@ -97215,7 +96844,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &652 + required: &651 - archive_url - assignees_url - blobs_url @@ -97366,10 +96995,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -97445,11 +97074,11 @@ x-webhooks: type: string enum: - created - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 - rule: &622 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 + rule: &621 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) @@ -97672,11 +97301,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 - rule: *622 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 + rule: *621 sender: *19 required: - action @@ -97859,11 +97488,11 @@ x-webhooks: - everyone required: - from - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 - rule: *622 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 + rule: *621 sender: *19 required: - action @@ -97947,7 +97576,7 @@ x-webhooks: type: string enum: - completed - check_run: &624 + check_run: &623 title: CheckRun description: A check performed on the code of a given code change type: object @@ -97961,8 +97590,8 @@ x-webhooks: first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 check_suite: description: A suite of checks performed on the code of a given code change @@ -98010,8 +97639,8 @@ x-webhooks: type: string pull_requests: type: array - items: *334 - repository: *113 + items: *333 + repository: *106 status: example: completed type: string @@ -98048,7 +97677,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *623 + deployment: *622 details_url: example: https://example.com type: string @@ -98098,7 +97727,7 @@ x-webhooks: - annotations_url pull_requests: type: array - items: *334 + items: *333 started_at: example: '2018-05-04T01:14:52Z' type: string @@ -98133,9 +97762,9 @@ x-webhooks: - output - app - pull_requests - installation: *619 - organization: *620 - repository: *621 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - check_run @@ -98528,10 +98157,10 @@ x-webhooks: type: string enum: - created - check_run: *624 - installation: *619 - organization: *620 - repository: *621 + check_run: *623 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - check_run @@ -98927,10 +98556,10 @@ x-webhooks: type: string enum: - requested_action - check_run: *624 - installation: *619 - organization: *620 - repository: *621 + check_run: *623 + installation: *618 + organization: *619 + repository: *620 requested_action: description: The action requested by the user. type: object @@ -99335,10 +98964,10 @@ x-webhooks: type: string enum: - rerequested - check_run: *624 - installation: *619 - organization: *620 - repository: *621 + check_run: *623 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - check_run @@ -100315,10 +99944,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -100988,10 +100617,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -101655,10 +101284,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -101958,20 +101587,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &625 + commit_oid: &624 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: *618 - installation: *619 - organization: *620 - ref: &626 + enterprise: *617 + installation: *618 + organization: *619 + ref: &625 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: *621 + repository: *620 sender: *19 required: - action @@ -102289,12 +101918,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *625 - enterprise: *618 - installation: *619 - organization: *620 - ref: *626 - repository: *621 + commit_oid: *624 + enterprise: *617 + installation: *618 + organization: *619 + ref: *625 + repository: *620 sender: *19 required: - action @@ -102389,7 +102018,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *350 + dismissed_comment: *349 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -102551,12 +102180,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *625 - enterprise: *618 - installation: *619 - organization: *620 - ref: *626 - repository: *621 + commit_oid: *624 + enterprise: *617 + installation: *618 + organization: *619 + ref: *625 + repository: *620 sender: *19 required: - action @@ -102877,12 +102506,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *625 - enterprise: *618 - installation: *619 - organization: *620 - ref: *626 - repository: *621 + commit_oid: *624 + enterprise: *617 + installation: *618 + organization: *619 + ref: *625 + repository: *620 sender: *19 required: - action @@ -103139,16 +102768,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *621 + repository: *620 sender: *19 required: - action @@ -103374,12 +103003,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *625 - enterprise: *618 - installation: *619 - organization: *620 - ref: *626 - repository: *621 + commit_oid: *624 + enterprise: *617 + installation: *618 + organization: *619 + ref: *625 + repository: *620 sender: *19 required: - action @@ -103636,10 +103265,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -103719,18 +103348,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *620 - pusher_type: &627 + organization: *619 + pusher_type: &626 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &628 + ref: &627 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -103740,7 +103369,7 @@ x-webhooks: enum: - tag - branch - repository: *621 + repository: *620 sender: *19 required: - ref @@ -103822,10 +103451,10 @@ x-webhooks: type: string enum: - created - definition: *213 - enterprise: *618 - installation: *619 - organization: *620 + definition: *207 + enterprise: *617 + installation: *618 + organization: *619 sender: *19 required: - action @@ -103910,9 +103539,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 sender: *19 required: - action @@ -103989,10 +103618,10 @@ x-webhooks: type: string enum: - updated - definition: *213 - enterprise: *618 - installation: *619 - organization: *620 + definition: *207 + enterprise: *617 + installation: *618 + organization: *619 sender: *19 required: - action @@ -104069,19 +103698,19 @@ x-webhooks: type: string enum: - updated - enterprise: *618 - installation: *619 - repository: *621 - organization: *620 + enterprise: *617 + installation: *618 + repository: *620 + organization: *619 sender: *19 new_property_values: type: array description: The new custom property values for the repository. - items: *217 + items: *211 old_property_values: type: array description: The old custom property values for the repository. - items: *217 + items: *211 required: - action - repository @@ -104157,18 +103786,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *618 - installation: *619 - organization: *620 - pusher_type: *627 - ref: *628 + enterprise: *617 + installation: *618 + organization: *619 + pusher_type: *626 + ref: *627 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *621 + repository: *620 sender: *19 required: - ref @@ -104252,11 +103881,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *404 - installation: *619 - organization: *620 - enterprise: *618 - repository: *621 + alert: *403 + installation: *618 + organization: *619 + enterprise: *617 + repository: *620 sender: *19 required: - action @@ -104340,11 +103969,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *404 - installation: *619 - organization: *620 - enterprise: *618 - repository: *621 + alert: *403 + installation: *618 + organization: *619 + enterprise: *617 + repository: *620 sender: *19 required: - action @@ -104428,11 +104057,11 @@ x-webhooks: type: string enum: - created - alert: *404 - installation: *619 - organization: *620 - enterprise: *618 - repository: *621 + alert: *403 + installation: *618 + organization: *619 + enterprise: *617 + repository: *620 sender: *19 required: - action @@ -104514,11 +104143,11 @@ x-webhooks: type: string enum: - dismissed - alert: *404 - installation: *619 - organization: *620 - enterprise: *618 - repository: *621 + alert: *403 + installation: *618 + organization: *619 + enterprise: *617 + repository: *620 sender: *19 required: - action @@ -104600,11 +104229,11 @@ x-webhooks: type: string enum: - fixed - alert: *404 - installation: *619 - organization: *620 - enterprise: *618 - repository: *621 + alert: *403 + installation: *618 + organization: *619 + enterprise: *617 + repository: *620 sender: *19 required: - action @@ -104687,11 +104316,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *404 - installation: *619 - organization: *620 - enterprise: *618 - repository: *621 + alert: *403 + installation: *618 + organization: *619 + enterprise: *617 + repository: *620 sender: *19 required: - action @@ -104773,11 +104402,11 @@ x-webhooks: type: string enum: - reopened - alert: *404 - installation: *619 - organization: *620 - enterprise: *618 - repository: *621 + alert: *403 + installation: *618 + organization: *619 + enterprise: *617 + repository: *620 sender: *19 required: - action @@ -104854,9 +104483,9 @@ x-webhooks: type: string enum: - created - enterprise: *618 - installation: *619 - key: &629 + enterprise: *617 + installation: *618 + key: &628 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -104892,8 +104521,8 @@ x-webhooks: - verified - created_at - read_only - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 required: - action @@ -104970,11 +104599,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *618 - installation: *619 - key: *629 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + key: *628 + organization: *619 + repository: *620 sender: *19 required: - action @@ -105535,12 +105164,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 - workflow: &633 + workflow: &632 title: Workflow type: object nullable: true @@ -106266,13 +105895,13 @@ x-webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *410 + deployment: *409 pull_requests: type: array - items: *495 - repository: *621 - organization: *620 - installation: *619 + items: *494 + repository: *620 + organization: *619 + installation: *618 sender: *19 responses: '200': @@ -106343,7 +105972,7 @@ x-webhooks: type: string enum: - approved - approver: &630 + approver: &629 type: object properties: avatar_url: @@ -106386,11 +106015,11 @@ x-webhooks: type: string comment: type: string - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 - reviewers: &631 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 + reviewers: &630 type: array items: type: object @@ -106469,7 +106098,7 @@ x-webhooks: sender: *19 since: type: string - workflow_job_run: &632 + workflow_job_run: &631 type: object properties: conclusion: @@ -107200,18 +106829,18 @@ x-webhooks: type: string enum: - rejected - approver: *630 + approver: *629 comment: type: string - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 - reviewers: *631 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 + reviewers: *630 sender: *19 since: type: string - workflow_job_run: *632 + workflow_job_run: *631 workflow_job_runs: type: array items: @@ -107915,13 +107544,13 @@ x-webhooks: type: string enum: - requested - enterprise: *618 + enterprise: *617 environment: type: string - installation: *619 - organization: *620 - repository: *621 - requestor: &638 + installation: *618 + organization: *619 + repository: *620 + requestor: &637 title: User type: object nullable: true @@ -109820,12 +109449,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 - workflow: *633 + workflow: *632 workflow_run: title: Deployment Workflow Run type: object @@ -110505,7 +110134,7 @@ x-webhooks: type: string enum: - answered - answer: &636 + answer: &635 type: object properties: author_association: @@ -110662,7 +110291,7 @@ x-webhooks: - created_at - updated_at - body - discussion: &634 + discussion: &633 title: Discussion description: A Discussion in a repository. type: object @@ -110948,7 +110577,7 @@ x-webhooks: - id labels: type: array - items: *457 + items: *456 required: - repository_url - category @@ -110970,10 +110599,10 @@ x-webhooks: - author_association - active_lock_reason - body - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -111100,11 +110729,11 @@ x-webhooks: - from required: - category - discussion: *634 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + discussion: *633 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -111187,11 +110816,11 @@ x-webhooks: type: string enum: - closed - discussion: *634 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + discussion: *633 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -111273,7 +110902,7 @@ x-webhooks: type: string enum: - created - comment: &635 + comment: &634 type: object properties: author_association: @@ -111430,11 +111059,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *634 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + discussion: *633 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -111517,12 +111146,12 @@ x-webhooks: type: string enum: - deleted - comment: *635 - discussion: *634 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + comment: *634 + discussion: *633 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -111617,12 +111246,12 @@ x-webhooks: - from required: - body - comment: *635 - discussion: *634 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + comment: *634 + discussion: *633 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -111706,11 +111335,11 @@ x-webhooks: type: string enum: - created - discussion: *634 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + discussion: *633 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -111792,11 +111421,11 @@ x-webhooks: type: string enum: - deleted - discussion: *634 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + discussion: *633 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -111896,11 +111525,11 @@ x-webhooks: type: string required: - from - discussion: *634 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + discussion: *633 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -111982,10 +111611,10 @@ x-webhooks: type: string enum: - labeled - discussion: *634 - enterprise: *618 - installation: *619 - label: &637 + discussion: *633 + enterprise: *617 + installation: *618 + label: &636 title: Label type: object properties: @@ -112017,8 +111646,8 @@ x-webhooks: - color - default - description - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 required: - action @@ -112101,11 +111730,11 @@ x-webhooks: type: string enum: - locked - discussion: *634 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + discussion: *633 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -112187,11 +111816,11 @@ x-webhooks: type: string enum: - pinned - discussion: *634 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + discussion: *633 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -112273,11 +111902,11 @@ x-webhooks: type: string enum: - reopened - discussion: *634 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + discussion: *633 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -112362,16 +111991,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *634 - new_repository: *621 + new_discussion: *633 + new_repository: *620 required: - new_discussion - new_repository - discussion: *634 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + discussion: *633 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -112454,10 +112083,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *634 - old_answer: *636 - organization: *620 - repository: *621 + discussion: *633 + old_answer: *635 + organization: *619 + repository: *620 sender: *19 required: - action @@ -112539,12 +112168,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *634 - enterprise: *618 - installation: *619 - label: *637 - organization: *620 - repository: *621 + discussion: *633 + enterprise: *617 + installation: *618 + label: *636 + organization: *619 + repository: *620 sender: *19 required: - action @@ -112627,11 +112256,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *634 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + discussion: *633 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -112713,11 +112342,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *634 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + discussion: *633 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -112790,7 +112419,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *618 + enterprise: *617 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -113450,9 +113079,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *619 - organization: *620 - repository: *621 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - forkee @@ -113598,9 +113227,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 pages: description: The pages that were updated. type: array @@ -113637,7 +113266,7 @@ x-webhooks: - action - sha - html_url - repository: *621 + repository: *620 sender: *19 required: - pages @@ -113713,10 +113342,10 @@ x-webhooks: type: string enum: - created - enterprise: *618 + enterprise: *617 installation: *22 - organization: *620 - repositories: &639 + organization: *619 + repositories: &638 description: An array of repository objects that the installation can access. type: array @@ -113742,8 +113371,8 @@ x-webhooks: - name - full_name - private - repository: *621 - requester: *638 + repository: *620 + requester: *637 sender: *19 required: - action @@ -113818,11 +113447,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *618 + enterprise: *617 installation: *22 - organization: *620 - repositories: *639 - repository: *621 + organization: *619 + repositories: *638 + repository: *620 requester: nullable: true sender: *19 @@ -113898,11 +113527,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *618 + enterprise: *617 installation: *22 - organization: *620 - repositories: *639 - repository: *621 + organization: *619 + repositories: *638 + repository: *620 requester: nullable: true sender: *19 @@ -113978,10 +113607,10 @@ x-webhooks: type: string enum: - added - enterprise: *618 + enterprise: *617 installation: *22 - organization: *620 - repositories_added: &640 + organization: *619 + repositories_added: &639 description: An array of repository objects, which were added to the installation. type: array @@ -114027,15 +113656,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *621 - repository_selection: &641 + repository: *620 + repository_selection: &640 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *638 + requester: *637 sender: *19 required: - action @@ -114114,10 +113743,10 @@ x-webhooks: type: string enum: - removed - enterprise: *618 + enterprise: *617 installation: *22 - organization: *620 - repositories_added: *640 + organization: *619 + repositories_added: *639 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -114144,9 +113773,9 @@ x-webhooks: - name - full_name - private - repository: *621 - repository_selection: *641 - requester: *638 + repository: *620 + repository_selection: *640 + requester: *637 sender: *19 required: - action @@ -114225,11 +113854,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *618 + enterprise: *617 installation: *22 - organization: *620 - repositories: *639 - repository: *621 + organization: *619 + repositories: *638 + repository: *620 requester: nullable: true sender: *19 @@ -114407,10 +114036,10 @@ x-webhooks: type: string required: - from - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 target_type: type: string @@ -114489,11 +114118,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *618 + enterprise: *617 installation: *22 - organization: *620 - repositories: *639 - repository: *621 + organization: *619 + repositories: *638 + repository: *620 requester: nullable: true sender: *19 @@ -114617,8 +114246,8 @@ x-webhooks: first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 reactions: title: Reactions type: object @@ -114745,8 +114374,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -115901,8 +115530,8 @@ x-webhooks: - state - locked - assignee - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 required: - action @@ -115982,7 +115611,7 @@ x-webhooks: type: string enum: - deleted - comment: &642 + comment: &641 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -116147,8 +115776,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -117301,8 +116930,8 @@ x-webhooks: - state - locked - assignee - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 required: - action @@ -117382,7 +117011,7 @@ x-webhooks: type: string enum: - edited - changes: &670 + changes: &669 description: The changes to the comment. type: object properties: @@ -117394,9 +117023,9 @@ x-webhooks: type: string required: - from - comment: *642 - enterprise: *618 - installation: *619 + comment: *641 + enterprise: *617 + installation: *618 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -118550,8 +118179,8 @@ x-webhooks: - state - locked - assignee - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 required: - action @@ -118633,10 +118262,10 @@ x-webhooks: type: string enum: - assigned - assignee: *638 - enterprise: *618 - installation: *619 - issue: &645 + assignee: *637 + enterprise: *617 + installation: *618 + issue: &644 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -119554,8 +119183,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 required: - action @@ -119635,8 +119264,8 @@ x-webhooks: type: string enum: - closed - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -120694,8 +120323,8 @@ x-webhooks: required: - state - closed_at - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 required: - action @@ -120774,8 +120403,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -121686,8 +121315,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 required: - action @@ -121766,8 +121395,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -122681,7 +122310,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &643 + milestone: &642 title: Milestone description: A collection of related issues and pull requests. type: object @@ -122819,8 +122448,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 required: - action @@ -122919,8 +122548,8 @@ x-webhooks: type: string required: - from - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -123838,9 +123467,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *637 - organization: *620 - repository: *621 + label: *636 + organization: *619 + repository: *620 sender: *19 required: - action @@ -123920,8 +123549,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -124838,9 +124467,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *637 - organization: *620 - repository: *621 + label: *636 + organization: *619 + repository: *620 sender: *19 required: - action @@ -124920,8 +124549,8 @@ x-webhooks: type: string enum: - locked - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -125839,8 +125468,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 required: - action @@ -125919,8 +125548,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -126832,9 +126461,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *643 - organization: *620 - repository: *621 + milestone: *642 + organization: *619 + repository: *620 sender: *19 required: - action @@ -128295,8 +127924,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -129213,8 +128842,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 required: - action @@ -129294,9 +128923,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *618 - installation: *619 - issue: &644 + enterprise: *617 + installation: *618 + issue: &643 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -130207,8 +129836,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 required: - action @@ -130287,8 +129916,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -131205,8 +130834,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 required: - action @@ -132668,11 +132297,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *618 - installation: *619 - issue: *644 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + issue: *643 + organization: *619 + repository: *620 sender: *19 required: - action @@ -132753,7 +132382,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &673 + assignee: &672 title: User type: object nullable: true @@ -132823,11 +132452,11 @@ x-webhooks: required: - login - id - enterprise: *618 - installation: *619 - issue: *645 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + issue: *644 + organization: *619 + repository: *620 sender: *19 required: - action @@ -132906,12 +132535,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *618 - installation: *619 - issue: *645 - label: *637 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + issue: *644 + label: *636 + organization: *619 + repository: *620 sender: *19 required: - action @@ -132991,8 +132620,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -133908,8 +133537,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 required: - action @@ -133989,11 +133618,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *618 - installation: *619 - issue: *644 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + issue: *643 + organization: *619 + repository: *620 sender: *19 required: - action @@ -134072,11 +133701,11 @@ x-webhooks: type: string enum: - created - enterprise: *618 - installation: *619 - label: *637 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + label: *636 + organization: *619 + repository: *620 sender: *19 required: - action @@ -134154,11 +133783,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *618 - installation: *619 - label: *637 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + label: *636 + organization: *619 + repository: *620 sender: *19 required: - action @@ -134268,11 +133897,11 @@ x-webhooks: type: string required: - from - enterprise: *618 - installation: *619 - label: *637 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + label: *636 + organization: *619 + repository: *620 sender: *19 required: - action @@ -134354,9 +133983,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *618 - installation: *619 - marketplace_purchase: &646 + enterprise: *617 + installation: *618 + marketplace_purchase: &645 title: Marketplace Purchase type: object required: @@ -134439,8 +134068,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *620 - previous_marketplace_purchase: &647 + organization: *619 + previous_marketplace_purchase: &646 title: Marketplace Purchase type: object properties: @@ -134520,7 +134149,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *621 + repository: *620 sender: *19 required: - action @@ -134600,10 +134229,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *618 - installation: *619 - marketplace_purchase: *646 - organization: *620 + enterprise: *617 + installation: *618 + marketplace_purchase: *645 + organization: *619 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -134686,7 +134315,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *621 + repository: *620 sender: *19 required: - action @@ -134768,10 +134397,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *618 - installation: *619 - marketplace_purchase: *646 - organization: *620 + enterprise: *617 + installation: *618 + marketplace_purchase: *645 + organization: *619 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -134853,7 +134482,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *621 + repository: *620 sender: *19 required: - action @@ -134934,8 +134563,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 marketplace_purchase: title: Marketplace Purchase type: object @@ -135017,9 +134646,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *620 - previous_marketplace_purchase: *647 - repository: *621 + organization: *619 + previous_marketplace_purchase: *646 + repository: *620 sender: *19 required: - action @@ -135099,12 +134728,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *618 - installation: *619 - marketplace_purchase: *646 - organization: *620 - previous_marketplace_purchase: *647 - repository: *621 + enterprise: *617 + installation: *618 + marketplace_purchase: *645 + organization: *619 + previous_marketplace_purchase: *646 + repository: *620 sender: *19 required: - action @@ -135206,11 +134835,11 @@ x-webhooks: type: string required: - to - enterprise: *618 - installation: *619 - member: *638 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + member: *637 + organization: *619 + repository: *620 sender: *19 required: - action @@ -135310,11 +134939,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *618 - installation: *619 - member: *638 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + member: *637 + organization: *619 + repository: *620 sender: *19 required: - action @@ -135393,11 +135022,11 @@ x-webhooks: type: string enum: - removed - enterprise: *618 - installation: *619 - member: *638 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + member: *637 + organization: *619 + repository: *620 sender: *19 required: - action @@ -135475,11 +135104,11 @@ x-webhooks: type: string enum: - added - enterprise: *618 - installation: *619 - member: *638 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + member: *637 + organization: *619 + repository: *620 scope: description: The scope of the membership. Currently, can only be `team`. @@ -135555,7 +135184,7 @@ x-webhooks: required: - login - id - team: &648 + team: &647 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -135745,11 +135374,11 @@ x-webhooks: type: string enum: - removed - enterprise: *618 - installation: *619 - member: *638 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + member: *637 + organization: *619 + repository: *620 scope: description: The scope of the membership. Currently, can only be `team`. @@ -135826,7 +135455,7 @@ x-webhooks: required: - login - id - team: *648 + team: *647 required: - action - scope @@ -135908,8 +135537,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *619 - merge_group: &650 + installation: *618 + merge_group: &649 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -135928,15 +135557,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *649 + head_commit: *648 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 required: - action @@ -136022,10 +135651,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *619 - merge_group: *650 - organization: *620 - repository: *621 + installation: *618 + merge_group: *649 + organization: *619 + repository: *620 sender: *19 required: - action @@ -136098,7 +135727,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *618 + enterprise: *617 hook: description: 'The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -136206,16 +135835,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *619 - organization: *620 + installation: *618 + organization: *619 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *651 - required: *652 + properties: *650 + required: *651 nullable: true sender: *19 required: @@ -136296,11 +135925,11 @@ x-webhooks: type: string enum: - closed - enterprise: *618 - installation: *619 - milestone: *643 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + milestone: *642 + organization: *619 + repository: *620 sender: *19 required: - action @@ -136379,9 +136008,9 @@ x-webhooks: type: string enum: - created - enterprise: *618 - installation: *619 - milestone: &653 + enterprise: *617 + installation: *618 + milestone: &652 title: Milestone description: A collection of related issues and pull requests. type: object @@ -136518,8 +136147,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 required: - action @@ -136598,11 +136227,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *618 - installation: *619 - milestone: *643 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + milestone: *642 + organization: *619 + repository: *620 sender: *19 required: - action @@ -136712,11 +136341,11 @@ x-webhooks: type: string required: - from - enterprise: *618 - installation: *619 - milestone: *643 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + milestone: *642 + organization: *619 + repository: *620 sender: *19 required: - action @@ -136796,11 +136425,11 @@ x-webhooks: type: string enum: - opened - enterprise: *618 - installation: *619 - milestone: *653 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + milestone: *652 + organization: *619 + repository: *620 sender: *19 required: - action @@ -136879,11 +136508,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *638 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + blocked_user: *637 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -136962,11 +136591,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *638 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + blocked_user: *637 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -137045,9 +136674,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *618 - installation: *619 - membership: &654 + enterprise: *617 + installation: *618 + membership: &653 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -137139,8 +136768,8 @@ x-webhooks: - role - organization_url - user - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 required: - action @@ -137218,11 +136847,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *618 - installation: *619 - membership: *654 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + membership: *653 + organization: *619 + repository: *620 sender: *19 required: - action @@ -137301,8 +136930,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -137418,10 +137047,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 - user: *638 + user: *637 required: - action - invitation @@ -137499,11 +137128,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *618 - installation: *619 - membership: *654 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + membership: *653 + organization: *619 + repository: *620 sender: *19 required: - action @@ -137590,11 +137219,11 @@ x-webhooks: properties: from: type: string - enterprise: *618 - installation: *619 - membership: *654 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + membership: *653 + organization: *619 + repository: *620 sender: *19 required: - action @@ -137670,9 +137299,9 @@ x-webhooks: type: string enum: - published - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 package: description: Information about the package. type: object @@ -138171,7 +137800,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &655 + items: &654 title: Ruby Gems metadata type: object properties: @@ -138266,7 +137895,7 @@ x-webhooks: - owner - package_version - registry - repository: *621 + repository: *620 sender: *19 required: - action @@ -138342,9 +137971,9 @@ x-webhooks: type: string enum: - updated - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 package: description: Information about the package. type: object @@ -138697,7 +138326,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *655 + items: *654 source_url: type: string format: uri @@ -138767,7 +138396,7 @@ x-webhooks: - owner - package_version - registry - repository: *621 + repository: *620 sender: *19 required: - action @@ -138944,12 +138573,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *618 + enterprise: *617 id: type: integer - installation: *619 - organization: *620 - repository: *621 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - id @@ -139029,7 +138658,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &656 + personal_access_token_request: &655 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -139175,10 +138804,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *618 - organization: *620 + enterprise: *617 + organization: *619 sender: *19 - installation: *619 + installation: *618 required: - action - personal_access_token_request @@ -139257,11 +138886,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *656 - enterprise: *618 - organization: *620 + personal_access_token_request: *655 + enterprise: *617 + organization: *619 sender: *19 - installation: *619 + installation: *618 required: - action - personal_access_token_request @@ -139339,11 +138968,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *656 - enterprise: *618 - organization: *620 + personal_access_token_request: *655 + enterprise: *617 + organization: *619 sender: *19 - installation: *619 + installation: *618 required: - action - personal_access_token_request @@ -139420,11 +139049,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *656 - organization: *620 - enterprise: *618 + personal_access_token_request: *655 + organization: *619 + enterprise: *617 sender: *19 - installation: *619 + installation: *618 required: - action - personal_access_token_request @@ -139528,7 +139157,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *657 + last_response: *656 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -139560,8 +139189,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 zen: description: Random string of GitHub zen. @@ -139806,10 +139435,10 @@ x-webhooks: - from required: - note - enterprise: *618 - installation: *619 - organization: *620 - project_card: &658 + enterprise: *617 + installation: *618 + organization: *619 + project_card: &657 title: Project Card type: object properties: @@ -139928,7 +139557,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *621 + repository: *620 sender: *19 required: - action @@ -140009,11 +139638,11 @@ x-webhooks: type: string enum: - created - enterprise: *618 - installation: *619 - organization: *620 - project_card: *658 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + project_card: *657 + repository: *620 sender: *19 required: - action @@ -140093,9 +139722,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 project_card: title: Project Card type: object @@ -140223,8 +139852,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *651 - required: *652 + properties: *650 + required: *651 nullable: true sender: *19 required: @@ -140318,11 +139947,11 @@ x-webhooks: - from required: - note - enterprise: *618 - installation: *619 - organization: *620 - project_card: *658 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + project_card: *657 + repository: *620 sender: *19 required: - action @@ -140416,9 +140045,9 @@ x-webhooks: - from required: - column_id - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 project_card: allOf: - title: Project Card @@ -140608,7 +140237,7 @@ x-webhooks: type: string required: - after_id - repository: *621 + repository: *620 sender: *19 required: - action @@ -140688,10 +140317,10 @@ x-webhooks: type: string enum: - closed - enterprise: *618 - installation: *619 - organization: *620 - project: &660 + enterprise: *617 + installation: *618 + organization: *619 + project: &659 title: Project type: object properties: @@ -140815,7 +140444,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *621 + repository: *620 sender: *19 required: - action @@ -140895,10 +140524,10 @@ x-webhooks: type: string enum: - created - enterprise: *618 - installation: *619 - organization: *620 - project_column: &659 + enterprise: *617 + installation: *618 + organization: *619 + project_column: &658 title: Project Column type: object properties: @@ -140937,7 +140566,7 @@ x-webhooks: - name - created_at - updated_at - repository: *621 + repository: *620 sender: *19 required: - action @@ -141016,18 +140645,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *618 - installation: *619 - organization: *620 - project_column: *659 + enterprise: *617 + installation: *618 + organization: *619 + project_column: *658 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *651 - required: *652 + properties: *650 + required: *651 nullable: true sender: *19 required: @@ -141117,11 +140746,11 @@ x-webhooks: type: string required: - from - enterprise: *618 - installation: *619 - organization: *620 - project_column: *659 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + project_column: *658 + repository: *620 sender: *19 required: - action @@ -141201,11 +140830,11 @@ x-webhooks: type: string enum: - moved - enterprise: *618 - installation: *619 - organization: *620 - project_column: *659 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + project_column: *658 + repository: *620 sender: *19 required: - action @@ -141285,11 +140914,11 @@ x-webhooks: type: string enum: - created - enterprise: *618 - installation: *619 - organization: *620 - project: *660 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + project: *659 + repository: *620 sender: *19 required: - action @@ -141369,18 +140998,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *618 - installation: *619 - organization: *620 - project: *660 + enterprise: *617 + installation: *618 + organization: *619 + project: *659 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *651 - required: *652 + properties: *650 + required: *651 nullable: true sender: *19 required: @@ -141482,11 +141111,11 @@ x-webhooks: type: string required: - from - enterprise: *618 - installation: *619 - organization: *620 - project: *660 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + project: *659 + repository: *620 sender: *19 required: - action @@ -141565,11 +141194,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *618 - installation: *619 - organization: *620 - project: *660 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + project: *659 + repository: *620 sender: *19 required: - action @@ -141650,9 +141279,9 @@ x-webhooks: type: string enum: - closed - installation: *619 - organization: *620 - projects_v2: &661 + installation: *618 + organization: *619 + projects_v2: &660 title: Projects v2 Project description: A projects v2 project type: object @@ -141795,9 +141424,9 @@ x-webhooks: type: string enum: - created - installation: *619 - organization: *620 - projects_v2: *661 + installation: *618 + organization: *619 + projects_v2: *660 sender: *19 required: - action @@ -141878,9 +141507,9 @@ x-webhooks: type: string enum: - deleted - installation: *619 - organization: *620 - projects_v2: *661 + installation: *618 + organization: *619 + projects_v2: *660 sender: *19 required: - action @@ -141997,9 +141626,9 @@ x-webhooks: type: string to: type: string - installation: *619 - organization: *620 - projects_v2: *661 + installation: *618 + organization: *619 + projects_v2: *660 sender: *19 required: - action @@ -142082,7 +141711,7 @@ x-webhooks: type: string enum: - archived - changes: &665 + changes: &664 type: object properties: archived_at: @@ -142096,9 +141725,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *619 - organization: *620 - projects_v2_item: &662 + installation: *618 + organization: *619 + projects_v2_item: &661 title: Projects v2 Item description: An item belonging to a project type: object @@ -142232,9 +141861,9 @@ x-webhooks: nullable: true to: type: string - installation: *619 - organization: *620 - projects_v2_item: *662 + installation: *618 + organization: *619 + projects_v2_item: *661 sender: *19 required: - action @@ -142316,9 +141945,9 @@ x-webhooks: type: string enum: - created - installation: *619 - organization: *620 - projects_v2_item: *662 + installation: *618 + organization: *619 + projects_v2_item: *661 sender: *19 required: - action @@ -142399,9 +142028,9 @@ x-webhooks: type: string enum: - deleted - installation: *619 - organization: *620 - projects_v2_item: *662 + installation: *618 + organization: *619 + projects_v2_item: *661 sender: *19 required: - action @@ -142507,7 +142136,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &663 + - &662 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -142525,7 +142154,7 @@ x-webhooks: required: - id - name - - &664 + - &663 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -142548,8 +142177,8 @@ x-webhooks: oneOf: - type: string - type: integer + - *662 - *663 - - *664 required: - field_value - type: object @@ -142565,9 +142194,9 @@ x-webhooks: nullable: true required: - body - installation: *619 - organization: *620 - projects_v2_item: *662 + installation: *618 + organization: *619 + projects_v2_item: *661 sender: *19 required: - action @@ -142662,9 +142291,9 @@ x-webhooks: to: type: string nullable: true - installation: *619 - organization: *620 - projects_v2_item: *662 + installation: *618 + organization: *619 + projects_v2_item: *661 sender: *19 required: - action @@ -142747,10 +142376,10 @@ x-webhooks: type: string enum: - restored - changes: *665 - installation: *619 - organization: *620 - projects_v2_item: *662 + changes: *664 + installation: *618 + organization: *619 + projects_v2_item: *661 sender: *19 required: - action @@ -142832,9 +142461,9 @@ x-webhooks: type: string enum: - reopened - installation: *619 - organization: *620 - projects_v2: *661 + installation: *618 + organization: *619 + projects_v2: *660 sender: *19 required: - action @@ -142915,9 +142544,9 @@ x-webhooks: type: string enum: - created - installation: *619 - organization: *620 - projects_v2_status_update: &666 + installation: *618 + organization: *619 + projects_v2_status_update: &665 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -143044,9 +142673,9 @@ x-webhooks: type: string enum: - deleted - installation: *619 - organization: *620 - projects_v2_status_update: *666 + installation: *618 + organization: *619 + projects_v2_status_update: *665 sender: *19 required: - action @@ -143182,9 +142811,9 @@ x-webhooks: type: string format: date nullable: true - installation: *619 - organization: *620 - projects_v2_status_update: *666 + installation: *618 + organization: *619 + projects_v2_status_update: *665 sender: *19 required: - action @@ -143255,10 +142884,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - repository @@ -143335,13 +142964,13 @@ x-webhooks: type: string enum: - assigned - assignee: *638 - enterprise: *618 - installation: *619 - number: &667 + assignee: *637 + enterprise: *617 + installation: *618 + number: &666 description: The pull request number. type: integer - organization: *620 + organization: *619 pull_request: title: Pull Request type: object @@ -145624,7 +145253,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *621 + repository: *620 sender: *19 required: - action @@ -145706,11 +145335,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 number: type: integer - organization: *620 + organization: *619 pull_request: title: Pull Request type: object @@ -147988,7 +147617,7 @@ x-webhooks: - draft reason: type: string - repository: *621 + repository: *620 sender: *19 required: - action @@ -148070,11 +147699,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 number: type: integer - organization: *620 + organization: *619 pull_request: title: Pull Request type: object @@ -150352,7 +149981,7 @@ x-webhooks: - draft reason: type: string - repository: *621 + repository: *620 sender: *19 required: - action @@ -150434,13 +150063,13 @@ x-webhooks: type: string enum: - closed - enterprise: *618 - installation: *619 - number: *667 - organization: *620 - pull_request: &668 + enterprise: *617 + installation: *618 + number: *666 + organization: *619 + pull_request: &667 allOf: - - *495 + - *494 - type: object properties: allow_auto_merge: @@ -150502,7 +150131,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *621 + repository: *620 sender: *19 required: - action @@ -150583,12 +150212,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *618 - installation: *619 - number: *667 - organization: *620 - pull_request: *668 - repository: *621 + enterprise: *617 + installation: *618 + number: *666 + organization: *619 + pull_request: *667 + repository: *620 sender: *19 required: - action @@ -150668,11 +150297,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *618 - milestone: *478 - number: *667 - organization: *620 - pull_request: &669 + enterprise: *617 + milestone: *477 + number: *666 + organization: *619 + pull_request: &668 title: Pull Request type: object properties: @@ -152935,7 +152564,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *621 + repository: *620 sender: *19 required: - action @@ -153014,11 +152643,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 number: type: integer - organization: *620 + organization: *619 pull_request: title: Pull Request type: object @@ -155300,7 +154929,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *621 + repository: *620 sender: *19 required: - action @@ -155424,12 +155053,12 @@ x-webhooks: type: string required: - from - enterprise: *618 - installation: *619 - number: *667 - organization: *620 - pull_request: *668 - repository: *621 + enterprise: *617 + installation: *618 + number: *666 + organization: *619 + pull_request: *667 + repository: *620 sender: *19 required: - action @@ -155509,11 +155138,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 number: type: integer - organization: *620 + organization: *619 pull_request: title: Pull Request type: object @@ -157780,7 +157409,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *621 + repository: *620 sender: *19 required: - action @@ -157860,11 +157489,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *618 - installation: *619 - label: *637 - number: *667 - organization: *620 + enterprise: *617 + installation: *618 + label: *636 + number: *666 + organization: *619 pull_request: title: Pull Request type: object @@ -160146,7 +159775,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *621 + repository: *620 sender: *19 required: - action @@ -160227,10 +159856,10 @@ x-webhooks: type: string enum: - locked - enterprise: *618 - installation: *619 - number: *667 - organization: *620 + enterprise: *617 + installation: *618 + number: *666 + organization: *619 pull_request: title: Pull Request type: object @@ -162510,7 +162139,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *621 + repository: *620 sender: *19 required: - action @@ -162590,12 +162219,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *618 - milestone: *478 - number: *667 - organization: *620 - pull_request: *669 - repository: *621 + enterprise: *617 + milestone: *477 + number: *666 + organization: *619 + pull_request: *668 + repository: *620 sender: *19 required: - action @@ -162674,12 +162303,12 @@ x-webhooks: type: string enum: - opened - enterprise: *618 - installation: *619 - number: *667 - organization: *620 - pull_request: *668 - repository: *621 + enterprise: *617 + installation: *618 + number: *666 + organization: *619 + pull_request: *667 + repository: *620 sender: *19 required: - action @@ -162760,12 +162389,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *618 - installation: *619 - number: *667 - organization: *620 - pull_request: *668 - repository: *621 + enterprise: *617 + installation: *618 + number: *666 + organization: *619 + pull_request: *667 + repository: *620 sender: *19 required: - action @@ -162845,12 +162474,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *618 - installation: *619 - number: *667 - organization: *620 - pull_request: *668 - repository: *621 + enterprise: *617 + installation: *618 + number: *666 + organization: *619 + pull_request: *667 + repository: *620 sender: *19 required: - action @@ -163216,9 +162845,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 pull_request: type: object properties: @@ -165388,7 +165017,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *621 + repository: *620 sender: *19 required: - action @@ -165468,7 +165097,7 @@ x-webhooks: type: string enum: - deleted - comment: &671 + comment: &670 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -165753,9 +165382,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 pull_request: type: object properties: @@ -167913,7 +167542,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *621 + repository: *620 sender: *19 required: - action @@ -167993,11 +167622,11 @@ x-webhooks: type: string enum: - edited - changes: *670 - comment: *671 - enterprise: *618 - installation: *619 - organization: *620 + changes: *669 + comment: *670 + enterprise: *617 + installation: *618 + organization: *619 pull_request: type: object properties: @@ -170158,7 +169787,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *621 + repository: *620 sender: *19 required: - action @@ -170239,9 +169868,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 pull_request: title: Simple Pull Request type: object @@ -172414,7 +172043,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *621 + repository: *620 review: description: The review that was affected. type: object @@ -172657,9 +172286,9 @@ x-webhooks: type: string required: - from - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 pull_request: title: Simple Pull Request type: object @@ -174713,8 +174342,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *621 - review: &672 + repository: *620 + review: &671 description: The review that was affected. type: object properties: @@ -174943,12 +174572,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 number: description: The pull request number. type: integer - organization: *620 + organization: *619 pull_request: title: Pull Request type: object @@ -177231,7 +176860,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *621 + repository: *620 requested_reviewer: title: User type: object @@ -177315,12 +176944,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 number: description: The pull request number. type: integer - organization: *620 + organization: *619 pull_request: title: Pull Request type: object @@ -179610,7 +179239,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *621 + repository: *620 requested_team: title: Team description: Groups of organization members that gives permissions @@ -179802,12 +179431,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 number: description: The pull request number. type: integer - organization: *620 + organization: *619 pull_request: title: Pull Request type: object @@ -182092,7 +181721,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *621 + repository: *620 requested_reviewer: title: User type: object @@ -182177,12 +181806,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 number: description: The pull request number. type: integer - organization: *620 + organization: *619 pull_request: title: Pull Request type: object @@ -184458,7 +184087,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *621 + repository: *620 requested_team: title: Team description: Groups of organization members that gives permissions @@ -184639,9 +184268,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 pull_request: title: Simple Pull Request type: object @@ -186816,8 +186445,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *621 - review: *672 + repository: *620 + review: *671 sender: *19 required: - action @@ -186897,9 +186526,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 pull_request: title: Simple Pull Request type: object @@ -188969,7 +188598,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *621 + repository: *620 sender: *19 thread: type: object @@ -189352,9 +188981,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 pull_request: title: Simple Pull Request type: object @@ -191410,7 +191039,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *621 + repository: *620 sender: *19 thread: type: object @@ -191796,10 +191425,10 @@ x-webhooks: type: string before: type: string - enterprise: *618 - installation: *619 - number: *667 - organization: *620 + enterprise: *617 + installation: *618 + number: *666 + organization: *619 pull_request: title: Pull Request type: object @@ -194070,7 +193699,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *621 + repository: *620 sender: *19 required: - action @@ -194152,11 +193781,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *673 - enterprise: *618 - installation: *619 - number: *667 - organization: *620 + assignee: *672 + enterprise: *617 + installation: *618 + number: *666 + organization: *619 pull_request: title: Pull Request type: object @@ -196439,7 +196068,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *621 + repository: *620 sender: *19 required: - action @@ -196518,11 +196147,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *618 - installation: *619 - label: *637 - number: *667 - organization: *620 + enterprise: *617 + installation: *618 + label: *636 + number: *666 + organization: *619 pull_request: title: Pull Request type: object @@ -198795,7 +198424,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *621 + repository: *620 sender: *19 required: - action @@ -198876,10 +198505,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *618 - installation: *619 - number: *667 - organization: *620 + enterprise: *617 + installation: *618 + number: *666 + organization: *619 pull_request: title: Pull Request type: object @@ -201144,7 +200773,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *621 + repository: *620 sender: *19 required: - action @@ -201344,7 +200973,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *618 + enterprise: *617 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -201436,8 +201065,8 @@ x-webhooks: - url - author - committer - installation: *619 - organization: *620 + installation: *618 + organization: *619 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -202012,9 +201641,9 @@ x-webhooks: type: string enum: - published - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 registry_package: type: object properties: @@ -202460,7 +202089,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *655 + items: *654 summary: type: string tag_name: @@ -202514,7 +202143,7 @@ x-webhooks: - owner - package_version - registry - repository: *621 + repository: *620 sender: *19 required: - action @@ -202592,9 +202221,9 @@ x-webhooks: type: string enum: - updated - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 registry_package: type: object properties: @@ -202902,7 +202531,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *655 + items: *654 summary: type: string tag_name: @@ -202951,7 +202580,7 @@ x-webhooks: - owner - package_version - registry - repository: *621 + repository: *620 sender: *19 required: - action @@ -203028,10 +202657,10 @@ x-webhooks: type: string enum: - created - enterprise: *618 - installation: *619 - organization: *620 - release: &674 + enterprise: *617 + installation: *618 + organization: *619 + release: &673 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -203336,7 +202965,7 @@ x-webhooks: - tarball_url - zipball_url - body - repository: *621 + repository: *620 sender: *19 required: - action @@ -203413,11 +203042,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *618 - installation: *619 - organization: *620 - release: *674 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + release: *673 + repository: *620 sender: *19 required: - action @@ -203525,11 +203154,11 @@ x-webhooks: type: boolean required: - to - enterprise: *618 - installation: *619 - organization: *620 - release: *674 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + release: *673 + repository: *620 sender: *19 required: - action @@ -203607,9 +203236,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -203918,7 +203547,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *621 + repository: *620 sender: *19 required: - action @@ -203994,10 +203623,10 @@ x-webhooks: type: string enum: - published - enterprise: *618 - installation: *619 - organization: *620 - release: &675 + enterprise: *617 + installation: *618 + organization: *619 + release: &674 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -204303,7 +203932,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *621 + repository: *620 sender: *19 required: - action @@ -204379,11 +204008,11 @@ x-webhooks: type: string enum: - released - enterprise: *618 - installation: *619 - organization: *620 - release: *674 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + release: *673 + repository: *620 sender: *19 required: - action @@ -204459,11 +204088,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *618 - installation: *619 - organization: *620 - release: *675 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + release: *674 + repository: *620 sender: *19 required: - action @@ -204539,11 +204168,11 @@ x-webhooks: type: string enum: - published - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 - repository_advisory: *549 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 + repository_advisory: *548 sender: *19 required: - action @@ -204619,11 +204248,11 @@ x-webhooks: type: string enum: - reported - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 - repository_advisory: *549 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 + repository_advisory: *548 sender: *19 required: - action @@ -204699,10 +204328,10 @@ x-webhooks: type: string enum: - archived - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -204779,10 +204408,10 @@ x-webhooks: type: string enum: - created - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -204860,10 +204489,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -204947,10 +204576,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -205062,10 +204691,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -205137,10 +204766,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 status: type: string @@ -205221,10 +204850,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -205301,10 +204930,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -205398,10 +205027,10 @@ x-webhooks: - name required: - repository - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -205481,11 +205110,11 @@ x-webhooks: type: string enum: - created - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 - repository_ruleset: *227 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 + repository_ruleset: *221 sender: *19 required: - action @@ -205563,11 +205192,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 - repository_ruleset: *227 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 + repository_ruleset: *221 sender: *19 required: - action @@ -205645,11 +205274,11 @@ x-webhooks: type: string enum: - edited - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 - repository_ruleset: *227 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 + repository_ruleset: *221 changes: type: object properties: @@ -205668,16 +205297,16 @@ x-webhooks: properties: added: type: array - items: *221 + items: *215 deleted: type: array - items: *221 + items: *215 updated: type: array items: type: object properties: - condition: *221 + condition: *215 changes: type: object properties: @@ -205710,16 +205339,16 @@ x-webhooks: properties: added: type: array - items: *226 + items: *220 deleted: type: array - items: *226 + items: *220 updated: type: array items: type: object properties: - rule: *226 + rule: *220 changes: type: object properties: @@ -205953,10 +205582,10 @@ x-webhooks: - from required: - owner - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -206034,10 +205663,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -206115,7 +205744,7 @@ x-webhooks: type: string enum: - create - alert: &676 + alert: &675 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -206236,10 +205865,10 @@ x-webhooks: type: string enum: - open - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -206445,10 +206074,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -206526,11 +206155,11 @@ x-webhooks: type: string enum: - reopen - alert: *676 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + alert: *675 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -206729,10 +206358,10 @@ x-webhooks: enum: - fixed - open - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -206810,11 +206439,11 @@ x-webhooks: type: string enum: - created - alert: &677 + alert: &676 type: object properties: - number: *48 - created_at: *49 + number: *46 + created_at: *47 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -206822,8 +206451,8 @@ x-webhooks: format: date-time readOnly: true nullable: true - url: *50 - html_url: *51 + url: *48 + html_url: *49 locations_url: type: string format: uri @@ -206897,6 +206526,11 @@ x-webhooks: properties: *4 required: *5 nullable: true + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection + bypass. + nullable: true push_protection_bypass_request_comment: type: string description: An optional comment when requesting a push protection @@ -206916,10 +206550,10 @@ x-webhooks: description: Whether the detected secret was found in multiple repositories in the same organization or business. nullable: true - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -207000,11 +206634,11 @@ x-webhooks: type: string enum: - created - alert: *677 - installation: *619 - location: *678 - organization: *620 - repository: *621 + alert: *676 + installation: *618 + location: *677 + organization: *619 + repository: *620 sender: *19 required: - location @@ -207242,11 +206876,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *677 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + alert: *676 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -207324,11 +206958,11 @@ x-webhooks: type: string enum: - reopened - alert: *677 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + alert: *676 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -207406,11 +207040,11 @@ x-webhooks: type: string enum: - resolved - alert: *677 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + alert: *676 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -207488,11 +207122,11 @@ x-webhooks: type: string enum: - validated - alert: *677 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + alert: *676 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -207568,11 +207202,11 @@ x-webhooks: type: string enum: - published - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 - security_advisory: &679 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 + security_advisory: &678 description: The details of the security advisory, including summary, description, and severity. type: object @@ -207588,7 +207222,7 @@ x-webhooks: required: - vector_string - score - cvss_severities: *46 + cvss_severities: *43 cwes: type: array items: @@ -207755,11 +207389,11 @@ x-webhooks: type: string enum: - updated - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 - security_advisory: *679 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 + security_advisory: *678 sender: *19 required: - action @@ -207832,10 +207466,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -207852,7 +207486,7 @@ x-webhooks: required: - vector_string - score - cvss_severities: *46 + cvss_severities: *43 cwes: type: array items: @@ -208019,11 +207653,11 @@ x-webhooks: from: type: object properties: - security_and_analysis: *220 - enterprise: *618 - installation: *619 - organization: *620 - repository: *266 + security_and_analysis: *214 + enterprise: *617 + installation: *618 + organization: *619 + repository: *265 sender: *19 required: - changes @@ -208101,12 +207735,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 - sponsorship: &680 + sponsorship: &679 type: object properties: created_at: @@ -208407,12 +208041,12 @@ x-webhooks: type: string enum: - created - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 - sponsorship: *680 + sponsorship: *679 required: - action - sponsorship @@ -208500,12 +208134,12 @@ x-webhooks: type: string required: - from - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 - sponsorship: *680 + sponsorship: *679 required: - action - changes @@ -208582,17 +208216,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &681 + effective_date: &680 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: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 - sponsorship: *680 + sponsorship: *679 required: - action - sponsorship @@ -208666,7 +208300,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &682 + changes: &681 type: object properties: tier: @@ -208710,13 +208344,13 @@ x-webhooks: - from required: - tier - effective_date: *681 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + effective_date: *680 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 - sponsorship: *680 + sponsorship: *679 required: - action - changes @@ -208793,13 +208427,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *682 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + changes: *681 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 - sponsorship: *680 + sponsorship: *679 required: - action - changes @@ -208873,10 +208507,10 @@ x-webhooks: type: string enum: - created - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 starred_at: description: 'The time the star was created. This is a timestamp @@ -208959,10 +208593,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 starred_at: description: 'The time the star was created. This is a timestamp @@ -209381,15 +209015,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *618 + enterprise: *617 id: description: The unique identifier of the status. type: integer - installation: *619 + installation: *618 name: type: string - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 sha: description: The Commit SHA. @@ -209498,15 +209132,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *75 - parent_issue_repo: *58 + parent_issue: *70 + parent_issue_repo: *53 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *75 - installation: *619 - organization: *620 - repository: *621 + sub_issue: *70 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -209590,15 +209224,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *75 - parent_issue_repo: *58 + parent_issue: *70 + parent_issue_repo: *53 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *75 - installation: *619 - organization: *620 - repository: *621 + sub_issue: *70 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -209682,15 +209316,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *75 - sub_issue_repo: *58 + sub_issue: *70 + sub_issue_repo: *53 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *75 - installation: *619 - organization: *620 - repository: *621 + parent_issue: *70 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -209774,15 +209408,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *75 - sub_issue_repo: *58 + sub_issue: *70 + sub_issue_repo: *53 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *75 - installation: *619 - organization: *620 - repository: *621 + parent_issue: *70 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -209859,12 +209493,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 - team: &683 + team: &682 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -210054,9 +209688,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 repository: title: Repository description: A git repository @@ -210514,7 +210148,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *683 + team: *682 required: - action - team @@ -210590,9 +210224,9 @@ x-webhooks: type: string enum: - created - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 repository: title: Repository description: A git repository @@ -211050,7 +210684,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *683 + team: *682 required: - action - team @@ -211127,9 +210761,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 repository: title: Repository description: A git repository @@ -211587,7 +211221,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *683 + team: *682 required: - action - team @@ -211731,9 +211365,9 @@ x-webhooks: - from required: - permissions - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 repository: title: Repository description: A git repository @@ -212191,7 +211825,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *683 + team: *682 required: - action - changes @@ -212269,9 +211903,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 repository: title: Repository description: A git repository @@ -212729,7 +212363,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *683 + team: *682 required: - action - team @@ -212805,10 +212439,10 @@ x-webhooks: type: string enum: - started - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -212881,16 +212515,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *618 + enterprise: *617 inputs: type: object nullable: true additionalProperties: true - installation: *619 - organization: *620 + installation: *618 + organization: *619 ref: type: string - repository: *621 + repository: *620 sender: *19 workflow: type: string @@ -212972,10 +212606,10 @@ x-webhooks: type: string enum: - completed - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 workflow_job: allOf: @@ -213212,7 +212846,7 @@ x-webhooks: type: string required: - conclusion - deployment: *410 + deployment: *409 required: - action - repository @@ -213291,10 +212925,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 workflow_job: allOf: @@ -213554,7 +213188,7 @@ x-webhooks: required: - status - steps - deployment: *410 + deployment: *409 required: - action - repository @@ -213633,10 +213267,10 @@ x-webhooks: type: string enum: - queued - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 workflow_job: type: object @@ -213771,7 +213405,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *410 + deployment: *409 required: - action - repository @@ -213850,10 +213484,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 workflow_job: type: object @@ -213989,7 +213623,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *410 + deployment: *409 required: - action - repository @@ -214069,12 +213703,12 @@ x-webhooks: type: string enum: - completed - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 - workflow: *633 + workflow: *632 workflow_run: title: Workflow Run type: object @@ -215073,12 +214707,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 - workflow: *633 + workflow: *632 workflow_run: title: Workflow Run type: object @@ -216062,12 +215696,12 @@ x-webhooks: type: string enum: - requested - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 - workflow: *633 + workflow: *632 workflow_run: title: Workflow Run type: object diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.deref.json index 1bc6929d2..f79bad2a5 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -15926,1747 +15926,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": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ], - "nullable": true - }, - "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", - "nullable": true - }, - "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", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "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", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], - "nullable": true - } - }, - "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", - "example": "disabled | all" - }, - "group_id": { - "nullable": true, - "type": "string", - "example": "62ab9291-fae2-468e-974b-7e45096d5021" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "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" - ] - } - ], - "nullable": true - }, - "pending_cancellation_date": { - "type": "string", - "format": "date", - "nullable": true, - "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", - "format": "date-time", - "nullable": true, - "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." - }, - "last_activity_editor": { - "type": "string", - "nullable": true, - "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", - "description": "Usage metrics for Copilot editor code completions in the IDE.", - "nullable": true, - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." - }, - "languages": { - "type": "array", - "description": "Code completion metrics for active languages.", - "items": { - "type": "object", - "description": "Usage metrics for a given language for the given editor for Copilot code completions.", - "properties": { - "name": { - "type": "string", - "description": "Name of the language used for Copilot code completion suggestions." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." - } - } - } - }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot code completion metrics for active editors.", - "additionalProperties": true, - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the 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", - "nullable": true, - "description": "The training date for the custom model." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." - }, - "languages": { - "type": "array", - "description": "Code completion metrics for active languages, for the given editor.", - "items": { - "type": "object", - "description": "Usage metrics for a given language for the given editor for Copilot code completions.", - "properties": { - "name": { - "type": "string", - "description": "Name of the language used for Copilot code completion suggestions, for the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." - }, - "total_code_suggestions": { - "type": "integer", - "description": "The number of Copilot code suggestions generated for the given editor, for the given language." - }, - "total_code_acceptances": { - "type": "integer", - "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." - }, - "total_code_lines_suggested": { - "type": "integer", - "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." - }, - "total_code_lines_accepted": { - "type": "integer", - "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." - } - } - } - } - } - } - } - } - } - } - } - }, - "copilot_ide_chat": { - "type": "object", - "description": "Usage metrics for Copilot Chat in the IDE.", - "nullable": true, - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat in the IDE." - }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot Chat metrics, for active editors.", - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the specified editor." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the 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", - "nullable": true, - "description": "The training date for the custom model." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the given editor and model." - }, - "total_chats": { - "type": "integer", - "description": "The total number of chats initiated by users in the given editor and model." - }, - "total_chat_insertion_events": { - "type": "integer", - "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." - }, - "total_chat_copy_events": { - "type": "integer", - "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." - } - } - } - } - } - } - } - } - }, - "copilot_dotcom_chat": { - "type": "object", - "description": "Usage metrics for Copilot Chat in github.com", - "nullable": true, - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once." - }, - "models": { - "type": "array", - "description": "List of model metrics for a custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the 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", - "description": "The training date for the custom model (if applicable).", - "nullable": true - }, - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." - }, - "total_chats": { - "type": "integer", - "description": "Total number of chats initiated by users on github.com." - } - } - } - } - } - }, - "copilot_dotcom_pull_requests": { - "type": "object", - "description": "Usage metrics for Copilot for pull requests.", - "nullable": true, - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." - }, - "repositories": { - "type": "array", - "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Repository name" - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the 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", - "nullable": true, - "description": "The training date for the custom model." - }, - "total_pr_summaries_created": { - "type": "integer", - "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." - } - } - } - } - } - } - } - } - } - }, - "required": [ - "date" - ], - "additionalProperties": true - } - }, - "examples": { - "default": { - "value": [ - { - "date": "2024-06-24", - "total_active_users": 24, - "total_engaged_users": 20, - "copilot_ide_code_completions": { - "total_engaged_users": 20, - "languages": [ - { - "name": "python", - "total_engaged_users": 10 - }, - { - "name": "ruby", - "total_engaged_users": 10 - } - ], - "editors": [ - { - "name": "vscode", - "total_engaged_users": 13, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 13, - "languages": [ - { - "name": "python", - "total_engaged_users": 6, - "total_code_suggestions": 249, - "total_code_acceptances": 123, - "total_code_lines_suggested": 225, - "total_code_lines_accepted": 135 - }, - { - "name": "ruby", - "total_engaged_users": 7, - "total_code_suggestions": 496, - "total_code_acceptances": 253, - "total_code_lines_suggested": 520, - "total_code_lines_accepted": 270 - } - ] - } - ] - }, - { - "name": "neovim", - "total_engaged_users": 7, - "models": [ - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "languages": [ - { - "name": "typescript", - "total_engaged_users": 3, - "total_code_suggestions": 112, - "total_code_acceptances": 56, - "total_code_lines_suggested": 143, - "total_code_lines_accepted": 61 - }, - { - "name": "go", - "total_engaged_users": 4, - "total_code_suggestions": 132, - "total_code_acceptances": 67, - "total_code_lines_suggested": 154, - "total_code_lines_accepted": 72 - } - ] - } - ] - } - ] - }, - "copilot_ide_chat": { - "total_engaged_users": 13, - "editors": [ - { - "name": "vscode", - "total_engaged_users": 13, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 12, - "total_chats": 45, - "total_chat_insertion_events": 12, - "total_chat_copy_events": 16 - }, - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "total_engaged_users": 1, - "total_chats": 10, - "total_chat_insertion_events": 11, - "total_chat_copy_events": 3 - } - ] - } - ] - }, - "copilot_dotcom_chat": { - "total_engaged_users": 14, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 14, - "total_chats": 38 - } - ] - }, - "copilot_dotcom_pull_requests": { - "total_engaged_users": 12, - "repositories": [ - { - "name": "demo/repo1", - "total_engaged_users": 8, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_pr_summaries_created": 6, - "total_engaged_users": 8 - } - ] - }, - { - "name": "demo/repo2", - "total_engaged_users": 4, - "models": [ - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "total_pr_summaries_created": 10, - "total_engaged_users": 4 - } - ] - } - ] - } - } - ] - } - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-metrics" - } - } - }, - "/enterprises/{enterprise}/copilot/usage": { - "get": { - "summary": "Get a summary of Copilot usage for enterprise members", - "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", - "description": "Breakdown of Copilot code completions usage by language and editor", - "nullable": true, - "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", @@ -20400,6 +18659,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -20582,6 +18846,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", @@ -20673,6 +18938,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, @@ -20750,1022 +19016,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", - "description": "Usage metrics for Copilot editor code completions in the IDE.", - "nullable": true, - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." - }, - "languages": { - "type": "array", - "description": "Code completion metrics for active languages.", - "items": { - "type": "object", - "description": "Usage metrics for a given language for the given editor for Copilot code completions.", - "properties": { - "name": { - "type": "string", - "description": "Name of the language used for Copilot code completion suggestions." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." - } - } - } - }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot code completion metrics for active editors.", - "additionalProperties": true, - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the 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", - "nullable": true, - "description": "The training date for the custom model." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." - }, - "languages": { - "type": "array", - "description": "Code completion metrics for active languages, for the given editor.", - "items": { - "type": "object", - "description": "Usage metrics for a given language for the given editor for Copilot code completions.", - "properties": { - "name": { - "type": "string", - "description": "Name of the language used for Copilot code completion suggestions, for the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." - }, - "total_code_suggestions": { - "type": "integer", - "description": "The number of Copilot code suggestions generated for the given editor, for the given language." - }, - "total_code_acceptances": { - "type": "integer", - "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." - }, - "total_code_lines_suggested": { - "type": "integer", - "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." - }, - "total_code_lines_accepted": { - "type": "integer", - "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." - } - } - } - } - } - } - } - } - } - } - } - }, - "copilot_ide_chat": { - "type": "object", - "description": "Usage metrics for Copilot Chat in the IDE.", - "nullable": true, - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat in the IDE." - }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot Chat metrics, for active editors.", - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the specified editor." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the 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", - "nullable": true, - "description": "The training date for the custom model." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the given editor and model." - }, - "total_chats": { - "type": "integer", - "description": "The total number of chats initiated by users in the given editor and model." - }, - "total_chat_insertion_events": { - "type": "integer", - "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." - }, - "total_chat_copy_events": { - "type": "integer", - "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." - } - } - } - } - } - } - } - } - }, - "copilot_dotcom_chat": { - "type": "object", - "description": "Usage metrics for Copilot Chat in github.com", - "nullable": true, - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once." - }, - "models": { - "type": "array", - "description": "List of model metrics for a custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the 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", - "description": "The training date for the custom model (if applicable).", - "nullable": true - }, - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." - }, - "total_chats": { - "type": "integer", - "description": "Total number of chats initiated by users on github.com." - } - } - } - } - } - }, - "copilot_dotcom_pull_requests": { - "type": "object", - "description": "Usage metrics for Copilot for pull requests.", - "nullable": true, - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." - }, - "repositories": { - "type": "array", - "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Repository name" - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the 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", - "nullable": true, - "description": "The training date for the custom model." - }, - "total_pr_summaries_created": { - "type": "integer", - "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." - } - } - } - } - } - } - } - } - } - }, - "required": [ - "date" - ], - "additionalProperties": true - } - }, - "examples": { - "default": { - "value": [ - { - "date": "2024-06-24", - "total_active_users": 24, - "total_engaged_users": 20, - "copilot_ide_code_completions": { - "total_engaged_users": 20, - "languages": [ - { - "name": "python", - "total_engaged_users": 10 - }, - { - "name": "ruby", - "total_engaged_users": 10 - } - ], - "editors": [ - { - "name": "vscode", - "total_engaged_users": 13, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 13, - "languages": [ - { - "name": "python", - "total_engaged_users": 6, - "total_code_suggestions": 249, - "total_code_acceptances": 123, - "total_code_lines_suggested": 225, - "total_code_lines_accepted": 135 - }, - { - "name": "ruby", - "total_engaged_users": 7, - "total_code_suggestions": 496, - "total_code_acceptances": 253, - "total_code_lines_suggested": 520, - "total_code_lines_accepted": 270 - } - ] - } - ] - }, - { - "name": "neovim", - "total_engaged_users": 7, - "models": [ - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "languages": [ - { - "name": "typescript", - "total_engaged_users": 3, - "total_code_suggestions": 112, - "total_code_acceptances": 56, - "total_code_lines_suggested": 143, - "total_code_lines_accepted": 61 - }, - { - "name": "go", - "total_engaged_users": 4, - "total_code_suggestions": 132, - "total_code_acceptances": 67, - "total_code_lines_suggested": 154, - "total_code_lines_accepted": 72 - } - ] - } - ] - } - ] - }, - "copilot_ide_chat": { - "total_engaged_users": 13, - "editors": [ - { - "name": "vscode", - "total_engaged_users": 13, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 12, - "total_chats": 45, - "total_chat_insertion_events": 12, - "total_chat_copy_events": 16 - }, - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "total_engaged_users": 1, - "total_chats": 10, - "total_chat_insertion_events": 11, - "total_chat_copy_events": 3 - } - ] - } - ] - }, - "copilot_dotcom_chat": { - "total_engaged_users": 14, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 14, - "total_chats": 38 - } - ] - }, - "copilot_dotcom_pull_requests": { - "total_engaged_users": 12, - "repositories": [ - { - "name": "demo/repo1", - "total_engaged_users": 8, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_pr_summaries_created": 6, - "total_engaged_users": 8 - } - ] - }, - { - "name": "demo/repo2", - "total_engaged_users": 4, - "models": [ - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "total_pr_summaries_created": 10, - "total_engaged_users": 4 - } - ] - } - ] - } - } - ] - } - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-metrics" - } - } - }, - "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { - "get": { - "summary": "Get a summary of Copilot usage for an enterprise team", - "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", - "description": "Breakdown of Copilot code completions usage by language and editor", - "nullable": true, - "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", @@ -60247,6 +57497,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -111064,6 +108317,8 @@ "content": { "application/json": { "schema": { + "title": "Custom Property Set Payload", + "description": "Custom property set payload", "type": "object", "properties": { "value_type": { @@ -117132,7 +114387,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -117140,7 +114396,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -117263,7 +114520,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", @@ -117730,6 +114987,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." @@ -118474,7 +115738,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ], "default": "branch" }, @@ -118529,7 +115794,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", @@ -118995,6 +116260,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." @@ -119668,7 +116940,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -119676,7 +116949,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -119799,7 +117073,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", @@ -120266,6 +117540,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." @@ -121580,7 +118861,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -121588,7 +118870,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -121711,7 +118994,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", @@ -122178,6 +119461,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." @@ -122948,7 +120238,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "enforcement": { @@ -123002,7 +120293,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", @@ -123468,6 +120759,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." @@ -124137,7 +121435,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -124145,7 +121444,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -124268,7 +121568,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", @@ -124735,6 +122035,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." @@ -126449,135 +123756,140 @@ ], "nullable": true }, - "push_protection_bypassed_at": { + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypass_request_reviewer_comment": { "type": "string", - "format": "date-time", - "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true - }, - "push_protection_bypass_request_reviewer": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], + "description": "An optional comment when reviewing a push protection bypass.", "nullable": true }, "push_protection_bypass_request_comment": { @@ -126762,6 +124074,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", @@ -126853,6 +124166,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, @@ -147999,6 +145313,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": [ @@ -148099,6 +145437,12 @@ "used": 0, "remaining": 10, "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 } }, "rate": { @@ -178141,6 +175485,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -390305,6 +387652,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." @@ -391175,7 +388529,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -391183,7 +388538,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -391306,7 +388662,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", @@ -391773,6 +389129,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." @@ -392829,6 +390192,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." @@ -393492,7 +390862,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -393500,7 +390871,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -393623,7 +390995,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", @@ -394090,6 +391462,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." @@ -395423,7 +392802,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -395431,7 +392811,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -395554,7 +392935,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", @@ -396021,6 +393402,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." @@ -397092,6 +394480,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." @@ -397751,7 +395146,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -397759,7 +395155,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -397882,7 +395279,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", @@ -398349,6 +395746,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." @@ -399788,6 +397192,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -399898,6 +397307,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", @@ -399922,6 +397332,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, @@ -400482,6 +397893,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -400533,6 +397949,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, @@ -401140,6 +398557,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -401210,6 +398632,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", @@ -498649,6 +496072,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -1022119,7 +1019545,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -1022127,7 +1019554,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -1022250,7 +1019678,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", @@ -1022717,6 +1020145,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." @@ -1024950,7 +1022385,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -1024958,7 +1022394,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -1025081,7 +1022518,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", @@ -1025548,6 +1022985,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." @@ -1027781,7 +1025225,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -1027789,7 +1025234,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -1027912,7 +1025358,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", @@ -1028379,6 +1025825,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." @@ -1029363,6 +1026816,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." @@ -1030175,6 +1027635,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." @@ -1030990,6 +1028457,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." @@ -1042833,6 +1040307,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -1044931,6 +1042410,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -1047445,6 +1044929,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -1049543,6 +1047032,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -1051641,6 +1049135,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -1053739,6 +1051238,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml index 9a366ad7d..5df73191b 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/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 - - &43 + - &40 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 - - &44 + - &41 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 - - &42 + - &39 name: direction description: The direction to sort the results by. in: query @@ -667,7 +667,7 @@ paths: required: - vector_string - score - cvss_severities: &46 + cvss_severities: &43 type: object nullable: true properties: @@ -838,7 +838,7 @@ paths: - subscriptions_url - type - url - type: &238 + type: &232 type: string description: The type of credit the user is receiving. enum: @@ -971,7 +971,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &98 + schema: &91 title: Validation Error Simple description: Validation Error Simple type: object @@ -1004,7 +1004,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &551 + - &550 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1122,7 +1122,7 @@ paths: GitHub. type: object nullable: true - properties: &59 + properties: &54 id: description: Unique identifier of the GitHub app example: 37 @@ -1211,7 +1211,7 @@ paths: type: string example: '"-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n"' - required: &60 + required: &55 - id - node_id - owner @@ -1516,7 +1516,7 @@ paths: schema: type: integer default: 30 - - &159 + - &152 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 @@ -1532,7 +1532,7 @@ paths: application/json: schema: type: array - items: &160 + items: &153 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1609,7 +1609,7 @@ paths: - installation_id - repository_id examples: - default: &161 + default: &154 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1668,7 +1668,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &97 + schema: &90 title: Validation Error description: Validation Error type: object @@ -1737,7 +1737,7 @@ paths: description: Response content: application/json: - schema: &162 + schema: &155 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1851,7 +1851,7 @@ paths: - request - response examples: - default: &163 + default: &156 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1911,7 +1911,7 @@ paths: parameters: - *17 responses: - '202': &99 + '202': &92 description: Accepted content: application/json: @@ -2106,7 +2106,7 @@ paths: parameters: - *18 - *20 - - &65 + - &60 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) @@ -2639,7 +2639,7 @@ paths: suspended_at: suspended_by: headers: - Link: &39 + Link: &51 example: ; rel="next", ; rel="last" schema: @@ -2828,11 +2828,11 @@ paths: - selected repositories: type: array - items: &58 + items: &53 title: Repository description: A repository on GitHub. type: object - properties: &218 + properties: &212 id: description: Unique identifier of the repository example: 42 @@ -2852,7 +2852,7 @@ paths: title: License Simple description: License Simple type: object - properties: &76 + properties: &71 key: type: string example: mit @@ -2874,7 +2874,7 @@ paths: html_url: type: string format: uri - required: &77 + required: &72 - key - name - url @@ -3261,7 +3261,7 @@ paths: type: boolean description: Whether anonymous git access is enabled for this repository - required: &219 + required: &213 - archive_url - assignees_url - blobs_url @@ -6903,1138 +6903,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: - - &40 - 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 - - *20 - - 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: &140 - title: Copilot Business Seat Detail - description: Information about a Copilot Business seat assignment - for a user, team, or organization. - type: object - properties: - assignee: *19 - organization: - title: Organization Simple - description: A GitHub organization. - type: object - properties: &92 - login: - type: string - example: github - id: - type: integer - example: 1 - node_id: - type: string - example: MDEyOk9yZ2FuaXphdGlvbjE= - url: - type: string - format: uri - example: https://api.github.com/orgs/github - repos_url: - type: string - format: uri - example: https://api.github.com/orgs/github/repos - events_url: - type: string - format: uri - example: https://api.github.com/orgs/github/events - hooks_url: - type: string - example: https://api.github.com/orgs/github/hooks - issues_url: - type: string - example: https://api.github.com/orgs/github/issues - members_url: - type: string - example: https://api.github.com/orgs/github/members{/member} - public_members_url: - type: string - example: https://api.github.com/orgs/github/public_members{/member} - avatar_url: - type: string - example: https://github.com/images/error/octocat_happy.gif - description: - type: string - example: A great organization - nullable: true - required: &93 - - login - - url - - id - - node_id - - repos_url - - events_url - - hooks_url - - issues_url - - members_url - - public_members_url - - avatar_url - - description - nullable: true - assigning_team: - description: The team through which the assignee is granted - access to GitHub Copilot, if applicable. - oneOf: - - &181 - 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 - nullable: true - 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 - example: https://github.com/orgs/rails/teams/core - members_url: - type: string - repositories_url: - type: string - format: uri - parent: - title: Team Simple - description: Groups of organization members that gives - permissions on specified repositories. - type: object - properties: &196 - id: - description: Unique identifier of the team - type: integer - example: 1 - node_id: - type: string - example: MDQ6VGVhbTE= - url: - description: URL for the team - type: string - format: uri - example: https://api.github.com/organizations/1/team/1 - members_url: - type: string - example: https://api.github.com/organizations/1/team/1/members{/member} - name: - description: Name of the team - type: string - example: Justice League - description: - description: Description of the team - type: string - nullable: true - example: A great team. - permission: - description: Permission that the team will have - for its repositories - type: string - example: admin - privacy: - description: The level of privacy this team should - have - type: string - example: closed - notification_setting: - description: The notification setting the team - has set - type: string - example: notifications_enabled - html_url: - type: string - format: uri - example: https://github.com/orgs/rails/teams/core - repositories_url: - type: string - format: uri - example: https://api.github.com/organizations/1/team/1/repos - slug: - type: string - example: justice-league - ldap_dn: - description: Distinguished Name (DN) that team - maps to within LDAP environment - example: uid=example,ou=users,dc=github,dc=com - type: string - required: &197 - - id - - node_id - - url - - members_url - - name - - description - - permission - - html_url - - repositories_url - - slug - nullable: true - 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 - example: disabled | all - group_id: - nullable: true - type: string - example: 62ab9291-fae2-468e-974b-7e45096d5021 - html_url: - type: string - format: uri - example: 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 - nullable: true - pending_cancellation_date: - type: string - format: date - nullable: true - 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 - format: date-time - nullable: true - description: Timestamp of user's last GitHub Copilot activity, - in ISO 8601 format. - last_activity_editor: - type: string - nullable: true - 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: &141 - 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: *39 - '500': &41 - description: Internal Error - content: - application/json: - schema: *3 - '401': *25 - '403': *29 - '404': *7 - 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: - - *40 - - name: since - description: Show usage metrics since this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). - Maximum value is 28 days ago. - in: query - required: false - schema: - type: string - - name: until - description: Show usage metrics until this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) - and should not preceed the `since` date if it is passed. - in: query - required: false - schema: - type: string - - *20 - - name: per_page - description: The number of days of metrics to display per page (max 28). For - more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 28 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &53 - title: Copilot Usage Metrics - description: Copilot usage metrics for a given day. - type: object - properties: - date: - type: string - format: date - description: The date for which the usage metrics are aggregated, - in `YYYY-MM-DD` format. - total_active_users: - type: integer - description: The total number of Copilot users with activity - belonging to any Copilot feature, globally, for the given - day. Includes passive activity such as receiving a code suggestion, - as well as engagement activity such as accepting a code suggestion - or prompting chat. Does not include authentication events. - Is not limited to the individual features detailed on the - endpoint. - total_engaged_users: - type: integer - description: The total number of Copilot users who engaged with - any Copilot feature, for the given day. Examples include but - are not limited to accepting a code suggestion, prompting - Copilot chat, or triggering a PR Summary. Does not include - authentication events. Is not limited to the individual features - detailed on the endpoint. - copilot_ide_code_completions: - type: object - description: Usage metrics for Copilot editor code completions - in the IDE. - nullable: true - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: Number of users who accepted at least one Copilot - code suggestion, across all active editors. Includes both - full and partial acceptances. - languages: - type: array - description: Code completion metrics for active languages. - items: - type: object - description: Usage metrics for a given language for the - given editor for Copilot code completions. - properties: - name: - type: string - description: Name of the language used for Copilot - code completion suggestions. - total_engaged_users: - type: integer - description: Number of users who accepted at least - one Copilot code completion suggestion for the given - language. Includes both full and partial acceptances. - editors: - type: array - items: - type: object - description: Copilot code completion metrics for active - editors. - additionalProperties: true - properties: - name: - type: string - description: Name of the given editor. - total_engaged_users: - type: integer - description: Number of users who accepted at least - one Copilot code completion suggestion for the given - editor. Includes both full and partial acceptances. - models: - type: array - description: List of model metrics for custom models - and the default model. - items: - type: object - properties: - name: - type: string - description: Name of the 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 - nullable: true - description: The training date for the custom - model. - total_engaged_users: - type: integer - description: Number of users who accepted at - least one Copilot code completion suggestion - for the given editor, for the given language - and model. Includes both full and partial - acceptances. - languages: - type: array - description: Code completion metrics for active - languages, for the given editor. - items: - type: object - description: Usage metrics for a given language - for the given editor for Copilot code completions. - properties: - name: - type: string - description: Name of the language used - for Copilot code completion suggestions, - for the given editor. - total_engaged_users: - type: integer - description: Number of users who accepted - at least one Copilot code completion - suggestion for the given editor, for - the given language. Includes both full - and partial acceptances. - total_code_suggestions: - type: integer - description: The number of Copilot code - suggestions generated for the given - editor, for the given language. - total_code_acceptances: - type: integer - description: The number of Copilot code - suggestions accepted for the given editor, - for the given language. Includes both - full and partial acceptances. - total_code_lines_suggested: - type: integer - description: The number of lines of code - suggested by Copilot code completions - for the given editor, for the given - language. - total_code_lines_accepted: - type: integer - description: The number of lines of code - accepted from Copilot code suggestions - for the given editor, for the given - language. - copilot_ide_chat: - type: object - description: Usage metrics for Copilot Chat in the IDE. - nullable: true - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: Total number of users who prompted Copilot - Chat in the IDE. - editors: - type: array - items: - type: object - description: Copilot Chat metrics, for active editors. - properties: - name: - type: string - description: Name of the given editor. - total_engaged_users: - type: integer - description: The number of users who prompted Copilot - Chat in the specified editor. - models: - type: array - description: List of model metrics for custom models - and the default model. - items: - type: object - properties: - name: - type: string - description: Name of the 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 - nullable: true - description: The training date for the custom - model. - total_engaged_users: - type: integer - description: The number of users who prompted - Copilot Chat in the given editor and model. - total_chats: - type: integer - description: The total number of chats initiated - by users in the given editor and model. - total_chat_insertion_events: - type: integer - description: The number of times users accepted - a code suggestion from Copilot Chat using - the 'Insert Code' UI element, for the given - editor. - total_chat_copy_events: - type: integer - description: The number of times users copied - a code suggestion from Copilot Chat using - the keyboard, or the 'Copy' UI element, for - the given editor. - copilot_dotcom_chat: - type: object - description: Usage metrics for Copilot Chat in github.com - nullable: true - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: Total number of users who prompted Copilot - Chat on github.com at least once. - models: - type: array - description: List of model metrics for a custom models and - the default model. - items: - type: object - properties: - name: - type: string - description: Name of the 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 - description: The training date for the custom model - (if applicable). - nullable: true - total_engaged_users: - type: integer - description: Total number of users who prompted Copilot - Chat on github.com at least once for each model. - total_chats: - type: integer - description: Total number of chats initiated by users - on github.com. - copilot_dotcom_pull_requests: - type: object - description: Usage metrics for Copilot for pull requests. - nullable: true - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: The number of users who used Copilot for Pull - Requests on github.com to generate a pull request summary - at least once. - repositories: - type: array - description: Repositories in which users used Copilot for - Pull Requests to generate pull request summaries - items: - type: object - properties: - name: - type: string - description: Repository name - total_engaged_users: - type: integer - description: The number of users who generated pull - request summaries using Copilot for Pull Requests - in the given repository. - models: - type: array - description: List of model metrics for custom models - and the default model. - items: - type: object - properties: - name: - type: string - description: Name of the 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 - nullable: true - description: The training date for the custom - model. - total_pr_summaries_created: - type: integer - description: The number of pull request summaries - generated using Copilot for Pull Requests - in the given repository. - total_engaged_users: - type: integer - description: The number of users who generated - pull request summaries using Copilot for Pull - Requests in the given repository and model. - required: - - date - additionalProperties: true - examples: - default: &54 - value: - - date: '2024-06-24' - total_active_users: 24 - total_engaged_users: 20 - copilot_ide_code_completions: - total_engaged_users: 20 - languages: - - name: python - total_engaged_users: 10 - - name: ruby - total_engaged_users: 10 - editors: - - name: vscode - total_engaged_users: 13 - models: - - name: default - is_custom_model: false - custom_model_training_date: - total_engaged_users: 13 - languages: - - name: python - total_engaged_users: 6 - total_code_suggestions: 249 - total_code_acceptances: 123 - total_code_lines_suggested: 225 - total_code_lines_accepted: 135 - - name: ruby - total_engaged_users: 7 - total_code_suggestions: 496 - total_code_acceptances: 253 - total_code_lines_suggested: 520 - total_code_lines_accepted: 270 - - name: neovim - total_engaged_users: 7 - models: - - name: a-custom-model - is_custom_model: true - custom_model_training_date: '2024-02-01' - languages: - - name: typescript - total_engaged_users: 3 - total_code_suggestions: 112 - total_code_acceptances: 56 - total_code_lines_suggested: 143 - total_code_lines_accepted: 61 - - name: go - total_engaged_users: 4 - total_code_suggestions: 132 - total_code_acceptances: 67 - total_code_lines_suggested: 154 - total_code_lines_accepted: 72 - copilot_ide_chat: - total_engaged_users: 13 - editors: - - name: vscode - total_engaged_users: 13 - models: - - name: default - is_custom_model: false - custom_model_training_date: - total_engaged_users: 12 - total_chats: 45 - total_chat_insertion_events: 12 - total_chat_copy_events: 16 - - name: a-custom-model - is_custom_model: true - custom_model_training_date: '2024-02-01' - total_engaged_users: 1 - total_chats: 10 - total_chat_insertion_events: 11 - total_chat_copy_events: 3 - copilot_dotcom_chat: - total_engaged_users: 14 - models: - - name: default - is_custom_model: false - custom_model_training_date: - total_engaged_users: 14 - total_chats: 38 - copilot_dotcom_pull_requests: - total_engaged_users: 12 - repositories: - - name: demo/repo1 - total_engaged_users: 8 - models: - - name: default - is_custom_model: false - custom_model_training_date: - total_pr_summaries_created: 6 - total_engaged_users: 8 - - name: demo/repo2 - total_engaged_users: 4 - models: - - name: a-custom-model - is_custom_model: true - custom_model_training_date: '2024-02-01' - total_pr_summaries_created: 10 - total_engaged_users: 4 - '500': *41 - '403': *29 - '404': *7 - '422': &55 - description: Copilot Usage Merics API setting is disabled at the organization - or enterprise level. - content: - application/json: - schema: *3 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-metrics - "/enterprises/{enterprise}/copilot/usage": - get: - summary: Get a summary of Copilot usage for enterprise members - 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: - - *40 - - name: since - description: Show usage metrics since this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). - Maximum value is 28 days ago. - in: query - required: false - schema: - type: string - - name: until - description: Show usage metrics until this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) - and should not preceed the `since` date if it is passed. - in: query - required: false - schema: - type: string - - *20 - - name: per_page - description: The number of days of metrics to display per page (max 28). For - more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 28 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &56 - 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 - description: Breakdown of Copilot code completions usage by - language and editor - nullable: true - 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': *41 - '401': *25 - '403': *29 - '404': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-usage "/enterprises/{enterprise}/dependabot/alerts": get: summary: List Dependabot alerts for an enterprise @@ -8053,8 +6921,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - - *40 - - &143 + - &45 + 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 + - &136 name: state in: query description: |- @@ -8063,7 +6938,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &144 + - &137 name: severity in: query description: |- @@ -8072,7 +6947,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &145 + - &138 name: ecosystem in: query description: |- @@ -8081,14 +6956,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &146 + - &139 name: package in: query description: A comma-separated list of package names. If specified, only alerts for these packages will be returned. schema: type: string - - &147 + - &140 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -8098,7 +6973,7 @@ paths: enum: - development - runtime - - &148 + - &141 name: sort in: query description: |- @@ -8111,10 +6986,10 @@ paths: - created - updated default: created - - *42 - - *43 - - *44 - - &149 + - *39 + - *40 + - *41 + - &142 name: first description: |- **Deprecated**. The number of results per page (max 100), starting from the first matching result. @@ -8127,7 +7002,7 @@ paths: minimum: 1 maximum: 100 default: 30 - - &150 + - &143 name: last description: |- **Deprecated**. The number of results per page (max 100), starting from the last matching result. @@ -8147,11 +7022,11 @@ paths: application/json: schema: type: array - items: &151 + items: &144 type: object description: A Dependabot alert. properties: - number: &48 + number: &46 type: integer description: The security alert number. readOnly: true @@ -8169,7 +7044,7 @@ paths: description: Details for the vulnerable dependency. readOnly: true properties: - package: &45 + package: &42 type: object description: Details for the vulnerable package. readOnly: true @@ -8200,7 +7075,7 @@ paths: enum: - development - runtime - security_advisory: &402 + security_advisory: &401 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -8230,13 +7105,13 @@ paths: description: Vulnerable version range information for the advisory. readOnly: true - items: &47 + items: &44 type: object description: Details pertaining to one vulnerable version range for the advisory. readOnly: true properties: - package: *45 + package: *42 severity: type: string description: The severity of the vulnerability. @@ -8302,7 +7177,7 @@ paths: - score - vector_string additionalProperties: false - cvss_severities: *46 + cvss_severities: *43 cwes: type: array description: Details for the advisory pertaining to Common @@ -8401,30 +7276,30 @@ paths: - updated_at - withdrawn_at additionalProperties: false - security_vulnerability: *47 - url: &50 + security_vulnerability: *44 + url: &48 type: string description: The REST API URL of the alert resource. format: uri readOnly: true - html_url: &51 + html_url: &49 type: string description: The GitHub URL of the alert resource. format: uri readOnly: true - created_at: &49 + created_at: &47 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: &127 + updated_at: &120 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: &129 + dismissed_at: &122 type: string description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -8454,21 +7329,21 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: &128 + fixed_at: &121 type: string description: 'The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - auto_dismissed_at: &403 + auto_dismissed_at: &402 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - repository: &52 + repository: &50 title: Simple Repository description: A GitHub repository. type: object @@ -8764,7 +7639,7 @@ paths: - repository additionalProperties: false examples: - default: &152 + default: &145 value: - number: 2 state: dismissed @@ -9107,8 +7982,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - - *40 - - &229 + - *45 + - &223 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -9119,7 +7994,7 @@ paths: enum: - open - resolved - - &230 + - &224 name: secret_type in: query description: |- @@ -9129,7 +8004,7 @@ paths: required: false schema: type: string - - &231 + - &225 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -9138,7 +8013,7 @@ paths: required: false schema: type: string - - &232 + - &226 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. @@ -9150,11 +8025,11 @@ paths: - created - updated default: created - - *42 + - *39 - *18 - - *43 - - *44 - - &233 + - *40 + - *41 + - &227 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -9163,7 +8038,7 @@ paths: required: false schema: type: string - - &234 + - &228 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -9172,7 +8047,7 @@ paths: schema: type: boolean default: false - - &235 + - &229 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -9188,11 +8063,11 @@ paths: application/json: schema: type: array - items: &236 + items: &230 type: object properties: - number: *48 - created_at: *49 + number: *46 + created_at: *47 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -9200,21 +8075,21 @@ paths: format: date-time readOnly: true nullable: true - url: *50 - html_url: *51 + url: *48 + html_url: *49 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: &543 + state: &542 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: &544 + resolution: &543 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -9248,7 +8123,7 @@ paths: secret: type: string description: The secret that was detected. - repository: *52 + repository: *50 push_protection_bypassed: type: boolean description: Whether push protection was bypassed for the detected @@ -9274,6 +8149,11 @@ paths: properties: *4 required: *5 nullable: true + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection + bypass. + nullable: true push_protection_bypass_request_comment: type: string description: An optional comment when requesting a push protection @@ -9306,7 +8186,7 @@ paths: repositories in the same organization or enterprise. nullable: true examples: - default: &237 + default: &231 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -9443,6 +8323,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 @@ -9530,6 +8411,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: @@ -9537,9 +8419,9 @@ paths: publicly_leaked: false multi_repo: false headers: - Link: *39 + Link: *51 '404': *7 - '503': &63 + '503': &58 description: Service unavailable content: application/json: @@ -9557,225 +8439,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: - - *40 - - name: team_slug - description: The slug of the enterprise team name. - in: path - required: true - schema: - type: string - - name: since - description: Show usage metrics since this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). - Maximum value is 28 days ago. - in: query - required: false - schema: - type: string - - name: until - description: Show usage metrics until this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) - and should not preceed the `since` date if it is passed. - in: query - required: false - schema: - type: string - - *20 - - name: per_page - description: The number of days of metrics to display per page (max 28). For - more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 28 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *53 - examples: - default: *54 - '500': *41 - '403': *29 - '404': *7 - '422': *55 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-metrics - "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": - get: - summary: Get a summary of Copilot usage for an enterprise team - 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: - - *40 - - &193 - 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 - - *20 - - name: per_page - description: The number of days of metrics to display per page (max 28). For - more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 28 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *56 - examples: - default: &142 - 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': *41 - '401': *25 - '403': *29 - '404': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-usage "/events": get: summary: List public events @@ -9798,7 +8461,7 @@ paths: application/json: schema: type: array - items: &87 + items: &82 title: Event description: Event type: object @@ -9808,7 +8471,7 @@ paths: type: type: string nullable: true - actor: &57 + actor: &52 title: Actor description: Actor type: object @@ -9848,18 +8511,18 @@ paths: - id - name - url - org: *57 + org: *52 payload: type: object properties: action: type: string - issue: &75 + issue: &70 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &451 + properties: &450 id: type: integer format: int64 @@ -9970,7 +8633,7 @@ paths: description: A collection of related issues and pull requests. type: object - properties: &387 + properties: &386 url: type: string format: uri @@ -10040,7 +8703,7 @@ paths: format: date-time example: '2012-10-09T23:39:01Z' nullable: true - required: &388 + required: &387 - closed_issues - creator - description @@ -10119,7 +8782,7 @@ paths: timeline_url: type: string format: uri - repository: *58 + repository: *53 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -10129,9 +8792,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 - author_association: &61 + properties: *54 + required: *55 + author_association: &56 title: author_association type: string example: OWNER @@ -10145,7 +8808,7 @@ paths: - MEMBER - NONE - OWNER - reactions: &62 + reactions: &57 title: Reaction Rollup type: object properties: @@ -10195,7 +8858,7 @@ paths: - total - completed - percent_completed - required: &452 + required: &451 - assignee - closed_at - comments @@ -10217,7 +8880,7 @@ paths: - author_association - created_at - updated_at - comment: &449 + comment: &448 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -10265,7 +8928,7 @@ paths: issue_url: type: string format: uri - author_association: *61 + author_association: *56 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -10275,9 +8938,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 - reactions: *62 + properties: *54 + required: *55 + reactions: *57 required: - id - node_id @@ -10372,7 +9035,7 @@ paths: created_at: '2022-06-07T07:50:26Z' '304': *37 '403': *29 - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -10453,7 +9116,7 @@ paths: _links: type: object properties: - timeline: &64 + timeline: &59 title: Link With Type description: Hypermedia Link with Type type: object @@ -10465,17 +9128,17 @@ paths: required: - href - type - user: *64 - security_advisories: *64 - current_user: *64 - current_user_public: *64 - current_user_actor: *64 - current_user_organization: *64 + user: *59 + security_advisories: *59 + current_user: *59 + current_user_public: *59 + current_user_actor: *59 + current_user_organization: *59 current_user_organizations: type: array - items: *64 - repository_discussions: *64 - repository_discussions_category: *64 + items: *59 + repository_discussions: *59 + repository_discussions_category: *59 required: - timeline - user @@ -10537,7 +9200,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *65 + - *60 - *18 - *20 responses: @@ -10547,7 +9210,7 @@ paths: application/json: schema: type: array - items: &66 + items: &61 title: Base Gist description: Base Gist type: object @@ -10644,7 +9307,7 @@ paths: - created_at - updated_at examples: - default: &67 + default: &62 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -10689,7 +9352,7 @@ paths: site_admin: false truncated: false headers: - Link: *39 + Link: *51 '304': *37 '403': *29 x-github: @@ -10765,7 +9428,7 @@ paths: description: Response content: application/json: - schema: &68 + schema: &63 title: Gist Simple description: Gist Simple type: object @@ -10782,7 +9445,7 @@ paths: url: type: string format: uri - user: &574 + user: &573 title: Public User description: Public User type: object @@ -11140,7 +9803,7 @@ paths: truncated: type: boolean examples: - default: &69 + default: &64 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -11243,7 +9906,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-public-gists parameters: - - *65 + - *60 - *18 - *20 responses: @@ -11253,11 +9916,11 @@ paths: application/json: schema: type: array - items: *66 + items: *61 examples: - default: *67 + default: *62 headers: - Link: *39 + Link: *51 '422': *16 '304': *37 '403': *29 @@ -11277,7 +9940,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-starred-gists parameters: - - *65 + - *60 - *18 - *20 responses: @@ -11287,11 +9950,11 @@ paths: application/json: schema: type: array - items: *66 + items: *61 examples: - default: *67 + default: *62 headers: - Link: *39 + Link: *51 '401': *25 '304': *37 '403': *29 @@ -11317,7 +9980,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist parameters: - - &70 + - &65 name: gist_id description: The unique identifier of the gist. in: path @@ -11329,10 +9992,10 @@ paths: description: Response content: application/json: - schema: *68 + schema: *63 examples: - default: *69 - '403': &73 + default: *64 + '403': &68 description: Forbidden Gist content: application/json: @@ -11380,7 +10043,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#update-a-gist parameters: - - *70 + - *65 requestBody: required: true content: @@ -11440,9 +10103,9 @@ paths: description: Response content: application/json: - schema: *68 + schema: *63 examples: - updateGist: *69 + updateGist: *64 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -11600,7 +10263,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#delete-a-gist parameters: - - *70 + - *65 responses: '204': description: Response @@ -11629,7 +10292,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#list-gist-comments parameters: - - *70 + - *65 - *18 - *20 responses: @@ -11639,7 +10302,7 @@ paths: application/json: schema: type: array - items: &71 + items: &66 title: Gist Comment description: A comment made to a gist. type: object @@ -11674,7 +10337,7 @@ paths: type: string format: date-time example: '2011-04-18T23:23:56Z' - author_association: *61 + author_association: *56 required: - url - id @@ -11714,7 +10377,7 @@ paths: updated_at: '2011-04-18T23:23:56Z' author_association: COLLABORATOR headers: - Link: *39 + Link: *51 '304': *37 '404': *7 '403': *29 @@ -11739,7 +10402,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#create-a-gist-comment parameters: - - *70 + - *65 requestBody: required: true content: @@ -11764,9 +10427,9 @@ paths: description: Response content: application/json: - schema: *71 + schema: *66 examples: - default: &72 + default: &67 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -11824,8 +10487,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#get-a-gist-comment parameters: - - *70 - - &74 + - *65 + - &69 name: comment_id description: The unique identifier of the comment. in: path @@ -11838,12 +10501,12 @@ paths: description: Response content: application/json: - schema: *71 + schema: *66 examples: - default: *72 + default: *67 '304': *37 '404': *7 - '403': *73 + '403': *68 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -11865,8 +10528,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#update-a-gist-comment parameters: - - *70 - - *74 + - *65 + - *69 requestBody: required: true content: @@ -11891,9 +10554,9 @@ paths: description: Response content: application/json: - schema: *71 + schema: *66 examples: - default: *72 + default: *67 '404': *7 x-github: githubCloudOnly: false @@ -11910,8 +10573,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#delete-a-gist-comment parameters: - - *70 - - *74 + - *65 + - *69 responses: '204': description: Response @@ -11934,7 +10597,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-commits parameters: - - *70 + - *65 - *18 - *20 responses: @@ -12035,7 +10698,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-forks parameters: - - *70 + - *65 - *18 - *20 responses: @@ -12045,7 +10708,7 @@ paths: application/json: schema: type: array - items: *68 + items: *63 examples: default: value: @@ -12091,7 +10754,7 @@ paths: type: User site_admin: false headers: - Link: *39 + Link: *51 '404': *7 '304': *37 '403': *29 @@ -12110,13 +10773,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#fork-a-gist parameters: - - *70 + - *65 responses: '201': description: Response content: application/json: - schema: *66 + schema: *61 examples: default: value: @@ -12187,7 +10850,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#check-if-a-gist-is-starred parameters: - - *70 + - *65 responses: '204': description: Response if gist is starred @@ -12217,7 +10880,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#star-a-gist parameters: - - *70 + - *65 responses: '204': description: Response @@ -12239,7 +10902,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#unstar-a-gist parameters: - - *70 + - *65 responses: '204': description: Response @@ -12268,7 +10931,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist-revision parameters: - - *70 + - *65 - name: sha in: path required: true @@ -12279,9 +10942,9 @@ paths: description: Response content: application/json: - schema: *68 + schema: *63 examples: - default: *69 + default: *64 '422': *16 '404': *7 '403': *29 @@ -12440,7 +11103,7 @@ paths: type: integer repositories: type: array - items: *58 + items: *53 repository_selection: type: string example: selected @@ -12563,7 +11226,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *39 + Link: *51 '403': *29 '304': *37 '401': *25 @@ -12647,7 +11310,7 @@ paths: - closed - all default: open - - &182 + - &175 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -12665,8 +11328,8 @@ paths: - updated - comments default: created - - *42 - - *65 + - *39 + - *60 - name: collab in: query required: false @@ -12696,9 +11359,9 @@ paths: application/json: schema: type: array - items: *75 + items: *70 examples: - default: &183 + default: &176 value: - id: 1 node_id: MDU6SXNzdWUx @@ -12943,7 +11606,7 @@ paths: watchers: 1 author_association: COLLABORATOR headers: - Link: *39 + Link: *51 '422': *16 '304': *37 '404': *7 @@ -12982,8 +11645,8 @@ paths: title: License Simple description: License Simple type: object - properties: *76 - required: *77 + properties: *71 + required: *72 examples: default: value: @@ -13267,7 +11930,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &78 + X-CommonMarker-Version: &73 example: 0.17.4 schema: type: string @@ -13322,7 +11985,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *78 + X-CommonMarker-Version: *73 content: text/html: schema: @@ -13351,7 +12014,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account parameters: - - &81 + - &76 name: account_id description: account_id parameter in: path @@ -13363,7 +12026,7 @@ paths: description: Response content: application/json: - schema: &80 + schema: &75 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -13393,7 +12056,7 @@ paths: nullable: true id: type: integer - plan: &79 + plan: &74 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -13482,7 +12145,7 @@ paths: nullable: true updated_at: type: string - plan: *79 + plan: *74 required: - url - id @@ -13490,7 +12153,7 @@ paths: - login - marketplace_purchase examples: - default: &82 + default: &77 value: url: https://api.github.com/orgs/github type: Organization @@ -13575,9 +12238,9 @@ paths: application/json: schema: type: array - items: *79 + items: *74 examples: - default: &83 + default: &78 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -13595,7 +12258,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *39 + Link: *51 '404': *7 '401': *25 x-github: @@ -13617,14 +12280,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &84 + - &79 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &85 + - &80 name: sort description: The property to sort the results by. in: query @@ -13654,9 +12317,9 @@ paths: application/json: schema: type: array - items: *80 + items: *75 examples: - default: &86 + default: &81 value: - url: https://api.github.com/orgs/github type: Organization @@ -13707,7 +12370,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *39 + Link: *51 '404': *7 '422': *16 '401': *25 @@ -13730,15 +12393,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed parameters: - - *81 + - *76 responses: '200': description: Response content: application/json: - schema: *80 + schema: *75 examples: - default: *82 + default: *77 '404': description: Not Found when the account has not purchased the listing '401': *25 @@ -13770,11 +12433,11 @@ paths: application/json: schema: type: array - items: *79 + items: *74 examples: - default: *83 + default: *78 headers: - Link: *39 + Link: *51 '401': *25 x-github: githubCloudOnly: false @@ -13795,8 +12458,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *84 - - *85 + - *79 + - *80 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -13816,11 +12479,11 @@ paths: application/json: schema: type: array - items: *80 + items: *75 examples: - default: *86 + default: *81 headers: - Link: *39 + Link: *51 '401': *25 x-github: githubCloudOnly: false @@ -14067,14 +12730,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &255 + - &254 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &256 + - &255 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -14091,7 +12754,7 @@ paths: application/json: schema: type: array - items: *87 + items: *82 examples: default: value: @@ -14145,7 +12808,7 @@ paths: '404': *7 '403': *29 '304': *37 - '301': &267 + '301': &266 description: Moved permanently content: application/json: @@ -14167,7 +12830,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &481 + - &480 name: all description: If `true`, show notifications marked as read. in: query @@ -14175,7 +12838,7 @@ paths: schema: type: boolean default: false - - &482 + - &481 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -14184,8 +12847,8 @@ paths: schema: type: boolean default: false - - *65 - - &483 + - *60 + - &482 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: @@ -14210,18 +12873,18 @@ paths: application/json: schema: type: array - items: &88 + items: &83 title: Thread description: Thread type: object properties: id: type: string - repository: &113 + repository: &106 title: Minimal Repository description: Minimal Repository type: object - properties: &154 + properties: &147 id: type: integer format: int64 @@ -14497,7 +13160,7 @@ paths: web_commit_signoff_required: type: boolean example: false - security_and_analysis: &220 + security_and_analysis: &214 nullable: true type: object properties: @@ -14553,7 +13216,7 @@ paths: enum: - enabled - disabled - required: &155 + required: &148 - archive_url - assignees_url - blobs_url @@ -14641,7 +13304,7 @@ paths: - url - subscription_url examples: - default: &484 + default: &483 value: - id: '1' repository: @@ -14723,7 +13386,7 @@ paths: url: https://api.github.com/notifications/threads/1 subscription_url: https://api.github.com/notifications/threads/1/subscription headers: - Link: *39 + Link: *51 '304': *37 '403': *29 '401': *25 @@ -14807,7 +13470,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread parameters: - - &89 + - &84 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 @@ -14821,7 +13484,7 @@ paths: description: Response content: application/json: - schema: *88 + schema: *83 examples: default: value: @@ -14923,7 +13586,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-read parameters: - - *89 + - *84 responses: '205': description: Reset Content @@ -14945,7 +13608,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-done parameters: - - *89 + - *84 responses: '204': description: No content @@ -14968,13 +13631,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user parameters: - - *89 + - *84 responses: '200': description: Response content: application/json: - schema: &90 + schema: &85 title: Thread Subscription description: Thread Subscription type: object @@ -15011,7 +13674,7 @@ paths: - url - subscribed examples: - default: &91 + default: &86 value: subscribed: true ignored: false @@ -15042,7 +13705,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#set-a-thread-subscription parameters: - - *89 + - *84 requestBody: required: false content: @@ -15063,9 +13726,9 @@ paths: description: Response content: application/json: - schema: *90 + schema: *85 examples: - default: *91 + default: *86 '304': *37 '403': *29 '401': *25 @@ -15088,7 +13751,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription parameters: - - *89 + - *84 responses: '204': description: Response @@ -15183,14 +13846,66 @@ paths: application/json: schema: type: array - items: &188 + items: &182 title: Organization Simple description: A GitHub organization. type: object - properties: *92 - required: *93 + properties: &134 + login: + type: string + example: github + id: + type: integer + example: 1 + node_id: + type: string + example: MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + example: https://api.github.com/orgs/github + repos_url: + type: string + format: uri + example: https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + example: https://api.github.com/orgs/github/events + hooks_url: + type: string + example: https://api.github.com/orgs/github/hooks + issues_url: + type: string + example: https://api.github.com/orgs/github/issues + members_url: + type: string + example: https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + example: https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + example: https://github.com/images/error/octocat_happy.gif + description: + type: string + example: A great organization + nullable: true + required: &135 + - login + - url + - id + - node_id + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url + - description examples: - default: &592 + default: &591 value: - login: github id: 1 @@ -15229,7 +13944,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization parameters: - - &94 + - &87 name: org description: The organization name. The name is not case sensitive. in: path @@ -15339,8 +14054,12 @@ paths: repositoryName: github/example '400': *15 '403': *29 - '500': *41 - '503': *63 + '500': &132 + description: Internal Error + content: + application/json: + schema: *3 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15366,13 +14085,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#get-an-organization parameters: - - *94 + - *87 responses: '200': description: Response content: application/json: - schema: &95 + schema: &88 title: Organization Full description: Organization Full type: object @@ -15661,7 +14380,7 @@ paths: - updated_at - archived_at examples: - default-response: &96 + default-response: &89 value: login: github id: 1 @@ -15752,7 +14471,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#update-an-organization parameters: - - *94 + - *87 requestBody: required: false content: @@ -15968,18 +14687,18 @@ paths: description: Response content: application/json: - schema: *95 + schema: *88 examples: - default: *96 + default: *89 '422': description: Validation failed content: application/json: schema: oneOf: - - *97 - - *98 - '409': &134 + - *90 + - *91 + '409': &127 description: Conflict content: application/json: @@ -16006,9 +14725,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#delete-an-organization parameters: - - *94 + - *87 responses: - '202': *99 + '202': *92 '404': *7 '403': *29 x-github: @@ -16031,7 +14750,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization parameters: - - *94 + - *87 responses: '200': description: Response @@ -16057,7 +14776,7 @@ paths: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16078,7 +14797,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: - - *94 + - *87 - *18 - *20 responses: @@ -16096,7 +14815,7 @@ paths: type: integer repository_cache_usages: type: array - items: &272 + items: &271 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -16131,7 +14850,7 @@ paths: active_caches_size_in_bytes: 1022142 active_caches_count: 2 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16151,13 +14870,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: - - *94 + - *87 responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &100 + schema: &93 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -16171,7 +14890,7 @@ paths: required: - include_claim_keys examples: - default: &101 + default: &94 value: include_claim_keys: - repo @@ -16193,20 +14912,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: - - *94 + - *87 requestBody: required: true content: application/json: - schema: *100 + schema: *93 examples: - default: *101 + default: *94 responses: '201': description: Empty response content: application/json: - schema: &122 + schema: &115 title: Empty Object description: An object without any properties. type: object @@ -16236,7 +14955,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization parameters: - - *94 + - *87 responses: '200': description: Response @@ -16245,7 +14964,7 @@ paths: schema: type: object properties: - enabled_repositories: &102 + enabled_repositories: &95 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -16258,7 +14977,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: &103 + allowed_actions: &96 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -16266,7 +14985,7 @@ paths: - all - local_only - selected - selected_actions_url: &278 + selected_actions_url: &277 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` @@ -16297,7 +15016,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization parameters: - - *94 + - *87 responses: '204': description: Response @@ -16308,8 +15027,8 @@ paths: schema: type: object properties: - enabled_repositories: *102 - allowed_actions: *103 + enabled_repositories: *95 + allowed_actions: *96 required: - enabled_repositories examples: @@ -16336,7 +15055,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: - - *94 + - *87 - *18 - *20 responses: @@ -16354,9 +15073,9 @@ paths: type: number repositories: type: array - items: *58 + items: *53 examples: - default: &586 + default: &585 value: total_count: 1 repositories: @@ -16496,7 +15215,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: - - *94 + - *87 responses: '204': description: Response @@ -16540,8 +15259,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: - - *94 - - &104 + - *87 + - &97 name: repository_id description: The unique identifier of the repository. in: path @@ -16569,8 +15288,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: - - *94 - - *104 + - *87 + - *97 responses: '204': description: Response @@ -16593,13 +15312,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *94 + - *87 responses: '200': description: Response content: application/json: - schema: &105 + schema: &98 type: object properties: github_owned_allowed: @@ -16621,7 +15340,7 @@ paths: items: type: string examples: - default: &106 + default: &99 value: github_owned_allowed: true verified_allowed: false @@ -16646,7 +15365,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *94 + - *87 responses: '204': description: Response @@ -16654,9 +15373,9 @@ paths: required: false content: application/json: - schema: *105 + schema: *98 examples: - selected_actions: *106 + selected_actions: *99 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -16678,23 +15397,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization parameters: - - *94 + - *87 responses: '200': description: Response content: application/json: - schema: &282 + schema: &281 type: object properties: - default_workflow_permissions: &107 + default_workflow_permissions: &100 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &108 + can_approve_pull_request_reviews: &101 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -16702,7 +15421,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &109 + default: &102 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -16727,7 +15446,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization parameters: - - *94 + - *87 responses: '204': description: Success response @@ -16735,13 +15454,13 @@ paths: required: false content: application/json: - schema: &283 + schema: &282 type: object properties: - default_workflow_permissions: *107 - can_approve_pull_request_reviews: *108 + default_workflow_permissions: *100 + can_approve_pull_request_reviews: *101 examples: - default: *109 + default: *102 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16761,7 +15480,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: - - *94 + - *87 - *18 - *20 - name: visible_to_repository @@ -16786,7 +15505,7 @@ paths: type: number runner_groups: type: array - items: &110 + items: &103 type: object properties: id: @@ -16898,7 +15617,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: - - *94 + - *87 requestBody: required: true content: @@ -16967,9 +15686,9 @@ paths: description: Response content: application/json: - schema: *110 + schema: *103 examples: - default: &112 + default: &105 value: id: 2 name: octo-runner-group @@ -17004,8 +15723,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: - - *94 - - &111 + - *87 + - &104 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -17017,7 +15736,7 @@ paths: description: Response content: application/json: - schema: *110 + schema: *103 examples: default: value: @@ -17053,8 +15772,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: - - *94 - - *111 + - *87 + - *104 requestBody: required: true content: @@ -17104,9 +15823,9 @@ paths: description: Response content: application/json: - schema: *110 + schema: *103 examples: - default: *112 + default: *105 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -17125,8 +15844,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: - - *94 - - *111 + - *87 + - *104 responses: '204': description: Response @@ -17149,8 +15868,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: - - *94 - - *111 + - *87 + - *104 - *20 - *18 responses: @@ -17168,9 +15887,9 @@ paths: type: number repositories: type: array - items: *113 + items: *106 examples: - default: &577 + default: &576 value: total_count: 1 repositories: @@ -17422,8 +16141,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: - - *94 - - *111 + - *87 + - *104 requestBody: required: true content: @@ -17467,9 +16186,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: - - *94 - - *111 + - *87 - *104 + - *97 responses: '204': description: Response @@ -17491,9 +16210,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: - - *94 - - *111 + - *87 - *104 + - *97 responses: '204': description: Response @@ -17516,8 +16235,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: - - *94 - - *111 + - *87 + - *104 - *18 - *20 responses: @@ -17535,7 +16254,7 @@ paths: type: number runners: type: array - items: &115 + items: &108 title: Self hosted runners description: A self hosted runner type: object @@ -17564,7 +16283,7 @@ paths: type: boolean labels: type: array - items: &118 + items: &111 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -17592,7 +16311,7 @@ paths: - busy - labels examples: - default: &116 + default: &109 value: total_count: 2 runners: @@ -17630,7 +16349,7 @@ paths: name: no-gpu type: custom headers: - Link: *39 + Link: *51 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -17649,8 +16368,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: - - *94 - - *111 + - *87 + - *104 requestBody: required: true content: @@ -17694,9 +16413,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: - - *94 - - *111 - - &114 + - *87 + - *104 + - &107 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -17724,9 +16443,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: - - *94 - - *111 - - *114 + - *87 + - *104 + - *107 responses: '204': description: Response @@ -17756,7 +16475,7 @@ paths: in: query schema: type: string - - *94 + - *87 - *18 - *20 responses: @@ -17774,11 +16493,11 @@ paths: type: integer runners: type: array - items: *115 + items: *108 examples: - default: *116 + default: *109 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17800,7 +16519,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization parameters: - - *94 + - *87 responses: '200': description: Response @@ -17808,7 +16527,7 @@ paths: application/json: schema: type: array - items: &284 + items: &283 title: Runner Application description: Runner Application type: object @@ -17833,7 +16552,7 @@ paths: - download_url - filename examples: - default: &285 + default: &284 value: - os: osx architecture: x64 @@ -17876,7 +16595,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: - - *94 + - *87 requestBody: required: true content: @@ -17919,7 +16638,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &286 + '201': &285 description: Response content: application/json: @@ -17929,7 +16648,7 @@ paths: - runner - encoded_jit_config properties: - runner: *115 + runner: *108 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -17985,13 +16704,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization parameters: - - *94 + - *87 responses: '201': description: Response content: application/json: - schema: &117 + schema: &110 title: Authentication Token description: Authentication Token type: object @@ -18013,7 +16732,7 @@ paths: repositories: description: The repositories this token has access to type: array - items: *58 + items: *53 single_file: type: string example: config.yaml @@ -18029,7 +16748,7 @@ paths: - token - expires_at examples: - default: &287 + default: &286 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -18060,15 +16779,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization parameters: - - *94 + - *87 responses: '201': description: Response content: application/json: - schema: *117 + schema: *110 examples: - default: &288 + default: &287 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -18093,16 +16812,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: - - *94 - - *114 + - *87 + - *107 responses: '200': description: Response content: application/json: - schema: *115 + schema: *108 examples: - default: &289 + default: &288 value: id: 23 name: MBP @@ -18142,8 +16861,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: - - *94 - - *114 + - *87 + - *107 responses: '204': description: Response @@ -18168,10 +16887,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: - - *94 - - *114 + - *87 + - *107 responses: - '200': &119 + '200': &112 description: Response content: application/json: @@ -18185,7 +16904,7 @@ paths: type: integer labels: type: array - items: *118 + items: *111 examples: default: value: @@ -18224,8 +16943,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: - - *94 - - *114 + - *87 + - *107 requestBody: required: true content: @@ -18249,7 +16968,7 @@ paths: - gpu - accelerated responses: - '200': *119 + '200': *112 '404': *7 '422': *8 x-github: @@ -18273,8 +16992,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: - - *94 - - *114 + - *87 + - *107 requestBody: required: true content: @@ -18299,7 +17018,7 @@ paths: - gpu - accelerated responses: - '200': *119 + '200': *112 '404': *7 '422': *8 x-github: @@ -18323,10 +17042,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: - - *94 - - *114 + - *87 + - *107 responses: - '200': &290 + '200': &289 description: Response content: application/json: @@ -18340,7 +17059,7 @@ paths: type: integer labels: type: array - items: *118 + items: *111 examples: default: value: @@ -18381,9 +17100,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: - - *94 - - *114 - - &291 + - *87 + - *107 + - &290 name: name description: The name of a self-hosted runner's custom label. in: path @@ -18391,7 +17110,7 @@ paths: schema: type: string responses: - '200': *119 + '200': *112 '404': *7 '422': *8 x-github: @@ -18416,7 +17135,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-organization-secrets parameters: - - *94 + - *87 - *18 - *20 responses: @@ -18434,7 +17153,7 @@ paths: type: integer secrets: type: array - items: &120 + items: &113 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -18484,7 +17203,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18507,13 +17226,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-public-key parameters: - - *94 + - *87 responses: '200': description: Response content: application/json: - schema: &303 + schema: &302 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -18542,7 +17261,7 @@ paths: - key_id - key examples: - default: &304 + default: &303 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -18567,8 +17286,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-secret parameters: - - *94 - - &121 + - *87 + - &114 name: secret_name description: The name of the secret. in: path @@ -18580,7 +17299,7 @@ paths: description: Response content: application/json: - schema: *120 + schema: *113 examples: default: value: @@ -18610,8 +17329,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 requestBody: required: true content: @@ -18666,7 +17385,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -18692,8 +17411,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 responses: '204': description: Response @@ -18719,8 +17438,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 - *20 - *18 responses: @@ -18738,9 +17457,9 @@ paths: type: integer repositories: type: array - items: *113 + items: *106 examples: - default: &125 + default: &118 value: total_count: 1 repositories: @@ -18832,8 +17551,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 requestBody: required: true content: @@ -18885,8 +17604,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 - name: repository_id in: path required: true @@ -18919,8 +17638,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 - name: repository_id in: path required: true @@ -18952,8 +17671,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - - *94 - - &277 + - *87 + - &276 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)." @@ -18977,7 +17696,7 @@ paths: type: integer variables: type: array - items: &123 + items: &116 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -19041,7 +17760,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19062,7 +17781,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-organization-variable parameters: - - *94 + - *87 requestBody: required: true content: @@ -19110,7 +17829,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -19135,8 +17854,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-organization-variable parameters: - - *94 - - &124 + - *87 + - &117 name: name description: The name of the variable. in: path @@ -19148,7 +17867,7 @@ paths: description: Response content: application/json: - schema: *123 + schema: *116 examples: default: value: @@ -19178,8 +17897,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-organization-variable parameters: - - *94 - - *124 + - *87 + - *117 requestBody: required: true content: @@ -19241,8 +17960,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-organization-variable parameters: - - *94 - - *124 + - *87 + - *117 responses: '204': description: Response @@ -19268,8 +17987,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - - *94 - - *124 + - *87 + - *117 - *20 - *18 responses: @@ -19287,9 +18006,9 @@ paths: type: integer repositories: type: array - items: *113 + items: *106 examples: - default: *125 + default: *118 '409': description: Response when the visibility of the variable is not set to `selected` @@ -19315,8 +18034,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - - *94 - - *124 + - *87 + - *117 requestBody: required: true content: @@ -19365,8 +18084,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - - *94 - - *124 + - *87 + - *117 - name: repository_id in: path required: true @@ -19400,8 +18119,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - - *94 - - *124 + - *87 + - *117 - name: repository_id in: path required: true @@ -19435,9 +18154,9 @@ paths: url: https://docs.github.com/rest/orgs/orgs#list-attestations parameters: - *18 - - *43 - - *44 - - *94 + - *40 + - *41 + - *87 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -19477,8 +18196,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: &317 + default: &316 value: attestations: - bundle: @@ -19585,7 +18306,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *94 + - *87 - *18 - *20 responses: @@ -19597,7 +18318,7 @@ paths: type: array items: *19 examples: - default: &184 + default: &177 value: - login: octocat id: 1 @@ -19635,8 +18356,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization parameters: - - *94 - - &126 + - *87 + - &119 name: username description: The handle for the GitHub user account. in: path @@ -19667,8 +18388,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization parameters: - - *94 - - *126 + - *87 + - *119 responses: '204': description: Response @@ -19688,8 +18409,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - - *94 - - *126 + - *87 + - *119 responses: '204': description: Response @@ -19714,18 +18435,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - - *94 - - &343 + - *87 + - &342 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: &130 + schema: &123 type: string description: The name of the tool used to generate the code scanning analysis. - - &344 + - &343 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 @@ -19733,22 +18454,22 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &131 + schema: &124 nullable: true type: string description: The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. - - *43 - - *44 + - *40 + - *41 - *20 - *18 - - *42 + - *39 - name: state description: If specified, only code scanning alerts with this state will be returned. in: query required: false - schema: &346 + schema: &345 type: string description: State of a code scanning alert. enum: @@ -19771,7 +18492,7 @@ paths: be returned. in: query required: false - schema: &347 + schema: &346 type: string description: Severity of a code scanning alert. enum: @@ -19792,18 +18513,18 @@ paths: items: type: object properties: - number: *48 - created_at: *49 - updated_at: *127 - url: *50 - html_url: *51 - instances_url: &348 + number: *46 + created_at: *47 + updated_at: *120 + url: *48 + html_url: *49 + instances_url: &347 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &132 + state: &125 type: string description: State of a code scanning alert. nullable: true @@ -19811,7 +18532,7 @@ paths: - open - dismissed - fixed - fixed_at: *128 + fixed_at: *121 dismissed_by: title: Simple User description: A GitHub user. @@ -19819,8 +18540,8 @@ paths: properties: *4 required: *5 nullable: true - dismissed_at: *129 - dismissed_reason: &349 + dismissed_at: *122 + dismissed_reason: &348 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -19829,13 +18550,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &350 + dismissed_comment: &349 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &351 + rule: &350 type: object properties: id: @@ -19888,25 +18609,25 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &352 + tool: &351 type: object properties: - name: *130 + name: *123 version: nullable: true type: string description: The version of the tool used to generate the code scanning analysis. - guid: *131 - most_recent_instance: &353 + guid: *124 + most_recent_instance: &352 type: object properties: - ref: &345 + ref: &344 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &359 + analysis_key: &358 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -19917,13 +18638,13 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &360 + category: &359 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: *132 + state: *125 commit_sha: type: string message: @@ -19962,7 +18683,7 @@ paths: - generated - test - library - repository: *52 + repository: *50 required: - number - created_at @@ -20207,9 +18928,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: *39 + Link: *51 '404': *7 - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20231,7 +18952,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization parameters: - - *94 + - *87 - name: target_type in: query description: The target type of the code security configuration @@ -20250,8 +18971,8 @@ paths: schema: type: integer default: 30 - - *43 - - *44 + - *40 + - *41 responses: '200': description: Response @@ -20259,7 +18980,7 @@ paths: application/json: schema: type: array - items: &133 + items: &126 type: object description: A code security configuration properties: @@ -20517,7 +19238,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration parameters: - - *94 + - *87 requestBody: required: true content: @@ -20590,7 +19311,7 @@ paths: - disabled - not_set default: disabled - code_scanning_default_setup_options: &137 + code_scanning_default_setup_options: &130 type: object description: Feature options for code scanning default setup nullable: true @@ -20707,9 +19428,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *133 + schema: *126 examples: - default: &135 + default: &128 value: id: 1325 target_type: organization @@ -20758,7 +19479,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations parameters: - - *94 + - *87 responses: '200': description: Response @@ -20778,7 +19499,7 @@ paths: description: The visibility of newly created repositories for which the code security configuration will be applied to by default - configuration: *133 + configuration: *126 examples: default: value: @@ -20868,7 +19589,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *94 + - *87 requestBody: required: true content: @@ -20891,12 +19612,12 @@ paths: - 32 - 91 responses: - '204': &138 + '204': &131 description: A header with no content is returned. '400': *15 '403': *29 '404': *7 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20918,8 +19639,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration parameters: - - *94 - - &136 + - *87 + - &129 name: configuration_id description: The unique identifier of the code security configuration. in: path @@ -20931,9 +19652,9 @@ paths: description: Response content: application/json: - schema: *133 + schema: *126 examples: - default: *135 + default: *128 '304': *37 '403': *29 '404': *7 @@ -20957,8 +19678,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration parameters: - - *94 - - *136 + - *87 + - *129 requestBody: required: true content: @@ -21024,7 +19745,7 @@ paths: - enabled - disabled - not_set - code_scanning_default_setup_options: *137 + code_scanning_default_setup_options: *130 secret_scanning: type: string description: The enablement status of secret scanning @@ -21111,7 +19832,7 @@ paths: description: Response when a configuration is updated content: application/json: - schema: *133 + schema: *126 examples: default: value: @@ -21165,14 +19886,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *94 - - *136 + - *87 + - *129 responses: - '204': *138 + '204': *131 '400': *15 '403': *29 '404': *7 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21196,8 +19917,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *94 - - *136 + - *87 + - *129 requestBody: required: true content: @@ -21236,7 +19957,7 @@ paths: - 32 - 91 responses: - '202': *99 + '202': *92 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21260,8 +19981,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: - - *94 - - *136 + - *87 + - *129 requestBody: required: true content: @@ -21301,12 +20022,12 @@ paths: - none - private_and_internal - public - configuration: *133 + configuration: *126 examples: default: value: default_for_new_repos: all - configuration: *135 + configuration: *128 '403': *29 '404': *7 x-github: @@ -21330,8 +20051,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration parameters: - - *94 - - *136 + - *87 + - *129 - 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)." @@ -21340,8 +20061,8 @@ paths: schema: type: integer default: 30 - - *43 - - *44 + - *40 + - *41 - name: status description: |- A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. @@ -21377,7 +20098,7 @@ paths: - failed - updating - removed_by_enterprise - repository: *52 + repository: *50 examples: default: summary: Example of code security configuration repositories @@ -21474,7 +20195,7 @@ paths: parameters: - *18 - *20 - - *94 + - *87 responses: '200': description: Response @@ -21490,7 +20211,7 @@ paths: type: integer codespaces: type: array - items: &185 + items: &178 type: object title: Codespace description: A codespace. @@ -21515,12 +20236,12 @@ paths: nullable: true owner: *19 billable_owner: *19 - repository: *113 + repository: *106 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &373 + properties: &372 name: type: string description: The name of the machine. @@ -21562,7 +20283,7 @@ paths: - ready - in_progress nullable: true - required: &374 + required: &373 - name - display_name - operating_system @@ -21767,7 +20488,7 @@ paths: - pulls_url - recent_folders examples: - default: &186 + default: &179 value: total_count: 3 codespaces: @@ -22177,7 +20898,7 @@ paths: stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop recent_folders: [] '304': *37 - '500': *41 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -22199,7 +20920,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *94 + - *87 deprecated: true requestBody: required: true @@ -22243,7 +20964,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *7 '422': *16 - '500': *41 + '500': *132 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -22266,7 +20987,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization parameters: - - *94 + - *87 deprecated: true requestBody: required: true @@ -22298,7 +21019,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *7 '422': *16 - '500': *41 + '500': *132 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -22321,7 +21042,7 @@ paths: url: https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *94 + - *87 requestBody: required: true content: @@ -22352,7 +21073,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *7 '422': *16 - '500': *41 + '500': *132 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -22373,7 +21094,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *94 + - *87 - *18 - *20 responses: @@ -22391,7 +21112,7 @@ paths: type: integer secrets: type: array - items: &139 + items: &133 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -22430,7 +21151,7 @@ paths: - updated_at - visibility examples: - default: &375 + default: &374 value: total_count: 2 secrets: @@ -22443,7 +21164,7 @@ paths: updated_at: '2020-01-11T11:59:22Z' visibility: all headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -22462,13 +21183,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *94 + - *87 responses: '200': description: Response content: application/json: - schema: &376 + schema: &375 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -22497,7 +21218,7 @@ paths: - key_id - key examples: - default: &377 + default: &376 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -22520,23 +21241,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 responses: '200': description: Response content: application/json: - schema: *139 + schema: *133 examples: - default: &379 + default: &378 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' updated_at: '2020-01-10T14:59:22Z' visibility: all headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -22556,8 +21277,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 requestBody: required: true content: @@ -22612,7 +21333,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -22638,8 +21359,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 responses: '204': description: Response @@ -22664,8 +21385,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 - *20 - *18 responses: @@ -22683,9 +21404,9 @@ paths: type: integer repositories: type: array - items: *113 + items: *106 examples: - default: *125 + default: *118 '404': *7 x-github: githubCloudOnly: false @@ -22707,8 +21428,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 requestBody: required: true content: @@ -22758,8 +21479,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 - name: repository_id in: path required: true @@ -22792,8 +21513,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 - name: repository_id in: path required: true @@ -22832,7 +21553,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: - - *94 + - *87 responses: '200': description: OK @@ -22943,7 +21664,7 @@ paths: cli: enabled public_code_suggestions: block plan_type: business - '500': *41 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -22975,7 +21696,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: - - *94 + - *87 - *20 - name: per_page description: The number of results per page (max 100). For more information, @@ -22998,12 +21719,324 @@ paths: currently being billed. seats: type: array - items: *140 + items: &181 + title: Copilot Business Seat Detail + description: Information about a Copilot Business seat assignment + for a user, team, or organization. + type: object + properties: + assignee: *19 + organization: + title: Organization Simple + description: A GitHub organization. + type: object + properties: *134 + required: *135 + nullable: true + assigning_team: + description: The team through which the assignee is granted + access to GitHub Copilot, if applicable. + oneOf: + - &174 + 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 + nullable: true + 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 + example: https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + parent: + title: Team Simple + description: Groups of organization members that gives + permissions on specified repositories. + type: object + properties: &190 + id: + description: Unique identifier of the team + type: integer + example: 1 + node_id: + type: string + example: MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + example: https://api.github.com/organizations/1/team/1 + members_url: + type: string + example: https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + example: Justice League + description: + description: Description of the team + type: string + nullable: true + example: A great team. + permission: + description: Permission that the team will have + for its repositories + type: string + example: admin + privacy: + description: The level of privacy this team should + have + type: string + example: closed + notification_setting: + description: The notification setting the team + has set + type: string + example: notifications_enabled + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/1/repos + slug: + type: string + example: justice-league + ldap_dn: + description: Distinguished Name (DN) that team + maps to within LDAP environment + example: uid=example,ou=users,dc=github,dc=com + type: string + required: &191 + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + nullable: true + 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 + example: disabled | all + group_id: + nullable: true + type: string + example: 62ab9291-fae2-468e-974b-7e45096d5021 + html_url: + type: string + format: uri + example: 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 + nullable: true + pending_cancellation_date: + type: string + format: date + nullable: true + 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 + format: date-time + nullable: true + description: Timestamp of user's last GitHub Copilot activity, + in ISO 8601 format. + last_activity_editor: + type: string + nullable: true + 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: *141 + 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: *39 - '500': *41 + Link: *51 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -23036,7 +22069,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: - - *94 + - *87 requestBody: content: application/json: @@ -23078,7 +22111,7 @@ paths: default: value: seats_created: 5 - '500': *41 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -23114,7 +22147,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: - - *94 + - *87 requestBody: content: application/json: @@ -23156,7 +22189,7 @@ paths: default: value: seats_cancelled: 5 - '500': *41 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -23194,7 +22227,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: - - *94 + - *87 requestBody: content: application/json: @@ -23235,7 +22268,7 @@ paths: default: value: seats_created: 5 - '500': *41 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -23271,7 +22304,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: - - *94 + - *87 requestBody: content: application/json: @@ -23313,7 +22346,7 @@ paths: default: value: seats_cancelled: 5 - '500': *41 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -23352,7 +22385,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization parameters: - - *94 + - *87 - 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`). @@ -23384,13 +22417,422 @@ paths: application/json: schema: type: array - items: *53 + items: &234 + title: Copilot Usage Metrics + description: Copilot usage metrics for a given day. + type: object + properties: + date: + type: string + format: date + description: The date for which the usage metrics are aggregated, + in `YYYY-MM-DD` format. + total_active_users: + type: integer + description: The total number of Copilot users with activity + belonging to any Copilot feature, globally, for the given + day. Includes passive activity such as receiving a code suggestion, + as well as engagement activity such as accepting a code suggestion + or prompting chat. Does not include authentication events. + Is not limited to the individual features detailed on the + endpoint. + total_engaged_users: + type: integer + description: The total number of Copilot users who engaged with + any Copilot feature, for the given day. Examples include but + are not limited to accepting a code suggestion, prompting + Copilot chat, or triggering a PR Summary. Does not include + authentication events. Is not limited to the individual features + detailed on the endpoint. + copilot_ide_code_completions: + type: object + description: Usage metrics for Copilot editor code completions + in the IDE. + nullable: true + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot + code suggestion, across all active editors. Includes both + full and partial acceptances. + languages: + type: array + description: Code completion metrics for active languages. + items: + type: object + description: Usage metrics for a given language for the + given editor for Copilot code completions. + properties: + name: + type: string + description: Name of the language used for Copilot + code completion suggestions. + total_engaged_users: + type: integer + description: Number of users who accepted at least + one Copilot code completion suggestion for the given + language. Includes both full and partial acceptances. + editors: + type: array + items: + type: object + description: Copilot code completion metrics for active + editors. + additionalProperties: true + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted at least + one Copilot code completion suggestion for the given + editor. Includes both full and partial acceptances. + models: + type: array + description: List of model metrics for custom models + and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the 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 + nullable: true + description: The training date for the custom + model. + total_engaged_users: + type: integer + description: Number of users who accepted at + least one Copilot code completion suggestion + for the given editor, for the given language + and model. Includes both full and partial + acceptances. + languages: + type: array + description: Code completion metrics for active + languages, for the given editor. + items: + type: object + description: Usage metrics for a given language + for the given editor for Copilot code completions. + properties: + name: + type: string + description: Name of the language used + for Copilot code completion suggestions, + for the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted + at least one Copilot code completion + suggestion for the given editor, for + the given language. Includes both full + and partial acceptances. + total_code_suggestions: + type: integer + description: The number of Copilot code + suggestions generated for the given + editor, for the given language. + total_code_acceptances: + type: integer + description: The number of Copilot code + suggestions accepted for the given editor, + for the given language. Includes both + full and partial acceptances. + total_code_lines_suggested: + type: integer + description: The number of lines of code + suggested by Copilot code completions + for the given editor, for the given + language. + total_code_lines_accepted: + type: integer + description: The number of lines of code + accepted from Copilot code suggestions + for the given editor, for the given + language. + copilot_ide_chat: + type: object + description: Usage metrics for Copilot Chat in the IDE. + nullable: true + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot + Chat in the IDE. + editors: + type: array + items: + type: object + description: Copilot Chat metrics, for active editors. + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: The number of users who prompted Copilot + Chat in the specified editor. + models: + type: array + description: List of model metrics for custom models + and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the 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 + nullable: true + description: The training date for the custom + model. + total_engaged_users: + type: integer + description: The number of users who prompted + Copilot Chat in the given editor and model. + total_chats: + type: integer + description: The total number of chats initiated + by users in the given editor and model. + total_chat_insertion_events: + type: integer + description: The number of times users accepted + a code suggestion from Copilot Chat using + the 'Insert Code' UI element, for the given + editor. + total_chat_copy_events: + type: integer + description: The number of times users copied + a code suggestion from Copilot Chat using + the keyboard, or the 'Copy' UI element, for + the given editor. + copilot_dotcom_chat: + type: object + description: Usage metrics for Copilot Chat in github.com + nullable: true + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot + Chat on github.com at least once. + models: + type: array + description: List of model metrics for a custom models and + the default model. + items: + type: object + properties: + name: + type: string + description: Name of the 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 + description: The training date for the custom model + (if applicable). + nullable: true + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot + Chat on github.com at least once for each model. + total_chats: + type: integer + description: Total number of chats initiated by users + on github.com. + copilot_dotcom_pull_requests: + type: object + description: Usage metrics for Copilot for pull requests. + nullable: true + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: The number of users who used Copilot for Pull + Requests on github.com to generate a pull request summary + at least once. + repositories: + type: array + description: Repositories in which users used Copilot for + Pull Requests to generate pull request summaries + items: + type: object + properties: + name: + type: string + description: Repository name + total_engaged_users: + type: integer + description: The number of users who generated pull + request summaries using Copilot for Pull Requests + in the given repository. + models: + type: array + description: List of model metrics for custom models + and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the 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 + nullable: true + description: The training date for the custom + model. + total_pr_summaries_created: + type: integer + description: The number of pull request summaries + generated using Copilot for Pull Requests + in the given repository. + total_engaged_users: + type: integer + description: The number of users who generated + pull request summaries using Copilot for Pull + Requests in the given repository and model. + required: + - date + additionalProperties: true examples: - default: *54 - '500': *41 + default: &235 + 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': *132 '403': *29 '404': *7 - '422': *55 + '422': &236 + 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 @@ -23421,7 +22863,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: - - *94 + - *87 - 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`). @@ -23453,10 +22895,158 @@ paths: application/json: schema: type: array - items: *56 + items: &237 + 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 + description: Breakdown of Copilot code completions usage by + language and editor + nullable: true + 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: *142 - '500': *41 + default: &238 + 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': *132 '401': *25 '403': *29 '404': *7 @@ -23481,18 +23071,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *94 + - *87 + - *136 + - *137 + - *138 + - *139 + - *140 + - *141 + - *39 + - *40 + - *41 + - *142 - *143 - - *144 - - *145 - - *146 - - *147 - - *148 - - *42 - - *43 - - *44 - - *149 - - *150 - *18 responses: '200': @@ -23501,9 +23091,9 @@ paths: application/json: schema: type: array - items: *151 + items: *144 examples: - default: *152 + default: *145 '304': *37 '400': *15 '403': *29 @@ -23529,7 +23119,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-organization-secrets parameters: - - *94 + - *87 - *18 - *20 responses: @@ -23547,7 +23137,7 @@ paths: type: integer secrets: type: array - items: &153 + items: &146 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -23597,7 +23187,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23618,13 +23208,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key parameters: - - *94 + - *87 responses: '200': description: Response content: application/json: - schema: &406 + schema: &405 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -23641,7 +23231,7 @@ paths: - key_id - key examples: - default: &407 + default: &406 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -23664,14 +23254,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 responses: '200': description: Response content: application/json: - schema: *153 + schema: *146 examples: default: value: @@ -23699,8 +23289,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 requestBody: required: true content: @@ -23755,7 +23345,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -23779,8 +23369,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 responses: '204': description: Response @@ -23804,8 +23394,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 - *20 - *18 responses: @@ -23823,9 +23413,9 @@ paths: type: integer repositories: type: array - items: *113 + items: *106 examples: - default: *125 + default: *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23846,8 +23436,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 requestBody: required: true content: @@ -23897,8 +23487,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 - name: repository_id in: path required: true @@ -23929,8 +23519,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *94 - - *121 + - *87 + - *114 - name: repository_id in: path required: true @@ -23960,7 +23550,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: - - *94 + - *87 responses: '200': description: Response @@ -23968,7 +23558,7 @@ paths: application/json: schema: type: array - items: &199 + items: &193 title: Package description: A software package type: object @@ -24018,8 +23608,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *154 - required: *155 + properties: *147 + required: *148 nullable: true created_at: type: string @@ -24038,7 +23628,7 @@ paths: - created_at - updated_at examples: - default: &200 + default: &194 value: - id: 197 name: hello_docker @@ -24116,7 +23706,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-organization-events parameters: - - *94 + - *87 - *18 - *20 responses: @@ -24126,7 +23716,7 @@ paths: application/json: schema: type: array - items: *87 + items: *82 examples: 200-response: value: @@ -24195,7 +23785,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-failed-organization-invitations parameters: - - *94 + - *87 - *18 - *20 responses: @@ -24205,7 +23795,7 @@ paths: application/json: schema: type: array - items: &178 + items: &171 title: Organization Invitation description: Organization Invitation type: object @@ -24252,7 +23842,7 @@ paths: - invitation_teams_url - node_id examples: - default: &179 + default: &172 value: - id: 1 login: monalisa @@ -24285,7 +23875,7 @@ paths: invitation_teams_url: https://api.github.com/organizations/2/invitations/1/teams invitation_source: member headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -24309,7 +23899,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks parameters: - - *94 + - *87 - *18 - *20 responses: @@ -24319,7 +23909,7 @@ paths: application/json: schema: type: array - items: &156 + items: &149 title: Org Hook description: Org Hook type: object @@ -24407,7 +23997,7 @@ paths: created_at: '2011-09-06T17:26:27Z' type: Organization headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -24430,7 +24020,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook parameters: - - *94 + - *87 requestBody: required: true content: @@ -24490,9 +24080,9 @@ paths: description: Response content: application/json: - schema: *156 + schema: *149 examples: - default: &157 + default: &150 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -24539,8 +24129,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - - *94 - - &158 + - *87 + - &151 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. @@ -24553,9 +24143,9 @@ paths: description: Response content: application/json: - schema: *156 + schema: *149 examples: - default: *157 + default: *150 '404': *7 x-github: githubCloudOnly: false @@ -24582,8 +24172,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - - *94 - - *158 + - *87 + - *151 requestBody: required: false content: @@ -24628,7 +24218,7 @@ paths: description: Response content: application/json: - schema: *156 + schema: *149 examples: default: value: @@ -24669,8 +24259,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *94 - - *158 + - *87 + - *151 responses: '204': description: Response @@ -24697,8 +24287,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - - *94 - - *158 + - *87 + - *151 responses: '200': description: Response @@ -24728,8 +24318,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - - *94 - - *158 + - *87 + - *151 requestBody: required: false content: @@ -24779,10 +24369,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *94 - - *158 + - *87 + - *151 - *18 - - *159 + - *152 responses: '200': description: Response @@ -24790,9 +24380,9 @@ paths: application/json: schema: type: array - items: *160 + items: *153 examples: - default: *161 + default: *154 '400': *15 '422': *16 x-github: @@ -24817,17 +24407,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - - *94 - - *158 + - *87 + - *151 - *17 responses: '200': description: Response content: application/json: - schema: *162 + schema: *155 examples: - default: *163 + default: *156 '400': *15 '422': *16 x-github: @@ -24852,11 +24442,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - - *94 - - *158 + - *87 + - *151 - *17 responses: - '202': *99 + '202': *92 '400': *15 '422': *16 x-github: @@ -24882,8 +24472,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *94 - - *158 + - *87 + - *151 responses: '204': description: Response @@ -24905,8 +24495,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor parameters: - - *94 - - &168 + - *87 + - &161 name: actor_type in: path description: The type of the actor @@ -24919,14 +24509,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &169 + - &162 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &164 + - &157 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`.' @@ -24934,7 +24524,7 @@ paths: required: true schema: type: string - - &165 + - &158 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) @@ -24945,7 +24535,7 @@ paths: type: string - *20 - *18 - - *42 + - *39 - name: sort description: The property to sort the results by. in: query @@ -25027,13 +24617,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats parameters: - - *94 - - *164 - - *165 + - *87 + - *157 + - *158 - *20 - *18 - - *42 - - &174 + - *39 + - &167 name: sort description: The property to sort the results by. in: query @@ -25111,15 +24701,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats parameters: - - *94 - - *164 - - *165 + - *87 + - *157 + - *158 responses: '200': description: Response content: application/json: - schema: &166 + schema: &159 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -25135,7 +24725,7 @@ paths: type: integer format: int64 examples: - default: &167 + default: &160 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -25155,24 +24745,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user parameters: - - *94 - - &170 + - *87 + - &163 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *164 - - *165 + - *157 + - *158 responses: '200': description: Response content: application/json: - schema: *166 + schema: *159 examples: - default: *167 + default: *160 x-github: enabledForGitHubApps: true category: orgs @@ -25190,19 +24780,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor parameters: - - *94 - - *164 - - *165 - - *168 - - *169 + - *87 + - *157 + - *158 + - *161 + - *162 responses: '200': description: Response content: application/json: - schema: *166 + schema: *159 examples: - default: *167 + default: *160 x-github: enabledForGitHubApps: true category: orgs @@ -25219,10 +24809,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats parameters: - - *94 - - *164 - - *165 - - &171 + - *87 + - *157 + - *158 + - &164 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -25235,7 +24825,7 @@ paths: description: Response content: application/json: - schema: &172 + schema: &165 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -25251,7 +24841,7 @@ paths: type: integer format: int64 examples: - default: &173 + default: &166 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -25287,19 +24877,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user parameters: - - *94 - - *170 + - *87 + - *163 + - *157 + - *158 - *164 - - *165 - - *171 responses: '200': description: Response content: application/json: - schema: *172 + schema: *165 examples: - default: *173 + default: *166 x-github: enabledForGitHubApps: true category: orgs @@ -25316,20 +24906,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor parameters: - - *94 - - *168 - - *169 + - *87 + - *161 + - *162 + - *157 + - *158 - *164 - - *165 - - *171 responses: '200': description: Response content: application/json: - schema: *172 + schema: *165 examples: - default: *173 + default: *166 x-github: enabledForGitHubApps: true category: orgs @@ -25346,14 +24936,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-user-stats parameters: - - *94 - - *170 - - *164 - - *165 + - *87 + - *163 + - *157 + - *158 - *20 - *18 - - *42 - - *174 + - *39 + - *167 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -25426,7 +25016,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app parameters: - - *94 + - *87 responses: '200': description: Response @@ -25434,7 +25024,7 @@ paths: application/json: schema: *22 examples: - default: &445 + default: &444 value: id: 1 account: @@ -25503,7 +25093,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *94 + - *87 - *18 - *20 responses: @@ -25573,7 +25163,7 @@ paths: suspended_at: suspended_by: headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25592,7 +25182,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *94 + - *87 responses: '200': description: Response @@ -25600,12 +25190,12 @@ paths: application/json: schema: anyOf: - - &176 + - &169 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &175 + limit: &168 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -25630,7 +25220,7 @@ paths: properties: {} additionalProperties: false examples: - default: &177 + default: &170 value: limit: collaborators_only origin: organization @@ -25654,18 +25244,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *94 + - *87 requestBody: required: true content: application/json: - schema: &446 + schema: &445 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *175 + limit: *168 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -25689,9 +25279,9 @@ paths: description: Response content: application/json: - schema: *176 + schema: *169 examples: - default: *177 + default: *170 '422': *16 x-github: githubCloudOnly: false @@ -25709,7 +25299,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *94 + - *87 responses: '204': description: Response @@ -25733,7 +25323,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-pending-organization-invitations parameters: - - *94 + - *87 - *18 - *20 - name: role @@ -25767,11 +25357,11 @@ paths: application/json: schema: type: array - items: *178 + items: *171 examples: - default: *179 + default: *172 headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -25792,7 +25382,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#create-an-organization-invitation parameters: - - *94 + - *87 requestBody: required: false content: @@ -25846,7 +25436,7 @@ paths: description: Response content: application/json: - schema: *178 + schema: *171 examples: default: value: @@ -25900,8 +25490,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - - *94 - - &180 + - *87 + - &173 name: invitation_id description: The unique identifier of the invitation. in: path @@ -25931,8 +25521,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - - *94 - - *180 + - *87 + - *173 - *18 - *20 responses: @@ -25942,9 +25532,9 @@ paths: application/json: schema: type: array - items: *181 + items: *174 examples: - default: &198 + default: &192 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -25960,7 +25550,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos parent: headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -25989,7 +25579,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user parameters: - - *94 + - *87 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -26019,7 +25609,7 @@ paths: - closed - all default: open - - *182 + - *175 - name: sort description: What to sort results by. in: query @@ -26031,8 +25621,8 @@ paths: - updated - comments default: created - - *42 - - *65 + - *39 + - *60 - *18 - *20 responses: @@ -26042,11 +25632,11 @@ paths: application/json: schema: type: array - items: *75 + items: *70 examples: - default: *183 + default: *176 headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -26066,7 +25656,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-members parameters: - - *94 + - *87 - 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) @@ -26102,9 +25692,9 @@ paths: type: array items: *19 examples: - default: *184 + default: *177 headers: - Link: *39 + Link: *51 '422': *16 x-github: githubCloudOnly: false @@ -26122,8 +25712,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-organization-membership-for-a-user parameters: - - *94 - - *126 + - *87 + - *119 responses: '204': description: Response if requester is an organization member and user is @@ -26154,8 +25744,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-an-organization-member parameters: - - *94 - - *126 + - *87 + - *119 responses: '204': description: Response @@ -26181,8 +25771,8 @@ paths: parameters: - *18 - *20 - - *94 - - *126 + - *87 + - *119 responses: '200': description: Response @@ -26198,11 +25788,11 @@ paths: type: integer codespaces: type: array - items: *185 + items: *178 examples: - default: *186 + default: *179 '304': *37 - '500': *41 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -26225,9 +25815,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - - *94 - - *126 - - &187 + - *87 + - *119 + - &180 name: codespace_name in: path required: true @@ -26235,9 +25825,9 @@ paths: schema: type: string responses: - '202': *99 + '202': *92 '304': *37 - '500': *41 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -26260,17 +25850,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user parameters: - - *94 - - *126 - - *187 + - *87 + - *119 + - *180 responses: '200': description: Response content: application/json: - schema: *185 + schema: *178 examples: - default: &372 + default: &371 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -26412,7 +26002,7 @@ paths: recent_folders: [] template: '304': *37 - '500': *41 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -26443,14 +26033,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: - - *94 - - *126 + - *87 + - *119 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *140 + schema: *181 examples: default: value: @@ -26493,7 +26083,7 @@ paths: members_url: https://api.github.com/teams/1/members{/member} repositories_url: https://api.github.com/teams/1/repos parent: - '500': *41 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -26518,14 +26108,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user parameters: - - *94 - - *126 + - *87 + - *119 responses: '200': description: Response content: application/json: - schema: &189 + schema: &183 title: Org Membership description: Org Membership type: object @@ -26554,7 +26144,7 @@ paths: type: string format: uri example: https://api.github.com/orgs/octocat - organization: *188 + organization: *182 user: title: Simple User description: A GitHub user. @@ -26577,7 +26167,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &190 + response-if-user-has-an-active-admin-membership-with-organization: &184 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -26645,8 +26235,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user parameters: - - *94 - - *126 + - *87 + - *119 requestBody: required: false content: @@ -26674,9 +26264,9 @@ paths: description: Response content: application/json: - schema: *189 + schema: *183 examples: - response-if-user-already-had-membership-with-organization: *190 + response-if-user-already-had-membership-with-organization: *184 '422': *16 '403': *29 x-github: @@ -26697,8 +26287,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-organization-membership-for-a-user parameters: - - *94 - - *126 + - *87 + - *119 responses: '204': description: Response @@ -26723,7 +26313,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-organization-migrations parameters: - - *94 + - *87 - *18 - *20 - name: exclude @@ -26744,7 +26334,7 @@ paths: application/json: schema: type: array - items: &191 + items: &185 title: Migration description: A migration. type: object @@ -26785,7 +26375,7 @@ paths: type: array description: The repositories included in the migration. Only returned for export migrations. - items: *58 + items: *53 url: type: string format: uri @@ -26981,7 +26571,7 @@ paths: updated_at: '2015-07-06T15:33:38-07:00' node_id: MDQ6VXNlcjE= headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -26997,7 +26587,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#start-an-organization-migration parameters: - - *94 + - *87 requestBody: required: true content: @@ -27073,7 +26663,7 @@ paths: description: Response content: application/json: - schema: *191 + schema: *185 examples: default: value: @@ -27251,8 +26841,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status parameters: - - *94 - - &192 + - *87 + - &186 name: migration_id description: The unique identifier of the migration. in: path @@ -27279,7 +26869,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *191 + schema: *185 examples: default: value: @@ -27448,8 +27038,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *94 - - *192 + - *87 + - *186 responses: '302': description: Response @@ -27470,8 +27060,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *94 - - *192 + - *87 + - *186 responses: '204': description: Response @@ -27494,9 +27084,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository parameters: - - *94 - - *192 - - &591 + - *87 + - *186 + - &590 name: repo_name description: repo_name parameter in: path @@ -27523,8 +27113,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *94 - - *192 + - *87 + - *186 - *18 - *20 responses: @@ -27534,9 +27124,9 @@ paths: application/json: schema: type: array - items: *113 + items: *106 examples: - default: &205 + default: &199 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -27647,7 +27237,7 @@ paths: secret_scanning_non_provider_patterns: status: disabled headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -27673,7 +27263,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization parameters: - - *94 + - *87 responses: '200': description: Response - list of organization roles @@ -27689,7 +27279,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &195 + items: &189 title: Organization Role description: Organization roles type: object @@ -27836,8 +27426,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - - *94 - - *193 + - *87 + - &187 + name: team_slug + description: The slug of the team name. + in: path + required: true + schema: + type: string responses: '204': description: Response @@ -27862,9 +27458,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - - *94 - - *193 - - &194 + - *87 + - *187 + - &188 name: role_id description: The unique identifier of the role. in: path @@ -27899,9 +27495,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - - *94 - - *193 - - *194 + - *87 + - *187 + - *188 responses: '204': description: Response @@ -27926,8 +27522,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user parameters: - - *94 - - *126 + - *87 + - *119 responses: '204': description: Response @@ -27952,9 +27548,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-user parameters: - - *94 - - *126 - - *194 + - *87 + - *119 + - *188 responses: '204': description: Response @@ -27984,9 +27580,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-user parameters: - - *94 - - *126 - - *194 + - *87 + - *119 + - *188 responses: '204': description: Response @@ -28014,14 +27610,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role parameters: - - *94 - - *194 + - *87 + - *188 responses: '200': description: Response content: application/json: - schema: *195 + schema: *189 examples: default: value: @@ -28071,8 +27667,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: - - *94 - - *194 + - *87 + - *188 - *18 - *20 responses: @@ -28150,8 +27746,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *196 - required: *197 + properties: *190 + required: *191 nullable: true required: - id @@ -28166,9 +27762,9 @@ paths: - slug - parent examples: - default: *198 + default: *192 headers: - Link: *39 + Link: *51 '404': description: Response if the organization or role does not exist. '422': @@ -28195,8 +27791,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: - - *94 - - *194 + - *87 + - *188 - *18 - *20 responses: @@ -28224,13 +27820,13 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: &239 + items: &233 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *196 - required: *197 + properties: *190 + required: *191 name: nullable: true type: string @@ -28325,9 +27921,9 @@ paths: - type - url examples: - default: *184 + default: *177 headers: - Link: *39 + Link: *51 '404': description: Response if the organization or role does not exist. '422': @@ -28349,7 +27945,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization parameters: - - *94 + - *87 - 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) @@ -28373,9 +27969,9 @@ paths: type: array items: *19 examples: - default: *184 + default: *177 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28398,8 +27994,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator parameters: - - *94 - - *126 + - *87 + - *119 requestBody: required: false content: @@ -28456,8 +28052,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization parameters: - - *94 - - *126 + - *87 + - *119 responses: '204': description: Response @@ -28514,8 +28110,8 @@ paths: - docker - nuget - container - - *94 - - &593 + - *87 + - &592 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -28551,12 +28147,12 @@ paths: application/json: schema: type: array - items: *199 + items: *193 examples: - default: *200 + default: *194 '403': *29 '401': *25 - '400': &595 + '400': &594 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -28578,7 +28174,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization parameters: - - &201 + - &195 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 @@ -28596,20 +28192,20 @@ paths: - docker - nuget - container - - &202 + - &196 name: package_name description: The name of the package. in: path required: true schema: type: string - - *94 + - *87 responses: '200': description: Response content: application/json: - schema: *199 + schema: *193 examples: default: value: @@ -28661,9 +28257,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization parameters: - - *201 - - *202 - - *94 + - *195 + - *196 + - *87 responses: '204': description: Response @@ -28695,9 +28291,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization parameters: - - *201 - - *202 - - *94 + - *195 + - *196 + - *87 - name: token description: package token schema: @@ -28729,9 +28325,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: - - *201 - - *202 - - *94 + - *195 + - *196 + - *87 - *20 - *18 - name: state @@ -28751,7 +28347,7 @@ paths: application/json: schema: type: array - items: &203 + items: &197 title: Package Version description: A version of a software package type: object @@ -28876,10 +28472,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *201 - - *202 - - *94 - - &204 + - *195 + - *196 + - *87 + - &198 name: package_version_id description: Unique identifier of the package version. in: path @@ -28891,7 +28487,7 @@ paths: description: Response content: application/json: - schema: *203 + schema: *197 examples: default: value: @@ -28927,10 +28523,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization parameters: - - *201 - - *202 - - *94 - - *204 + - *195 + - *196 + - *87 + - *198 responses: '204': description: Response @@ -28962,10 +28558,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization parameters: - - *201 - - *202 - - *94 - - *204 + - *195 + - *196 + - *87 + - *198 responses: '204': description: Response @@ -28992,10 +28588,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: - - *94 + - *87 - *18 - *20 - - &206 + - &200 name: sort description: The property by which to sort the results. in: query @@ -29005,8 +28601,8 @@ paths: enum: - created_at default: created_at - - *42 - - &207 + - *39 + - &201 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -29017,7 +28613,7 @@ paths: items: type: string example: owner[]=octocat1,owner[]=octocat2 - - &208 + - &202 name: repository description: The name of the repository to use to filter the results. in: query @@ -29025,7 +28621,7 @@ paths: schema: type: string example: Hello-World - - &209 + - &203 name: permission description: The permission to use to filter the results. in: query @@ -29033,7 +28629,7 @@ paths: schema: type: string example: issues_read - - &210 + - &204 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) @@ -29043,7 +28639,7 @@ paths: schema: type: string format: date-time - - &211 + - &205 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) @@ -29054,7 +28650,7 @@ paths: type: string format: date-time responses: - '500': *41 + '500': *132 '422': *16 '404': *7 '403': *29 @@ -29186,7 +28782,7 @@ paths: token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29206,7 +28802,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: - - *94 + - *87 requestBody: required: true content: @@ -29247,11 +28843,11 @@ paths: action: deny reason: Access is too broad. responses: - '500': *41 + '500': *132 '422': *16 '404': *7 '403': *29 - '202': *99 + '202': *92 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29272,7 +28868,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: - - *94 + - *87 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -29308,11 +28904,11 @@ paths: action: deny reason: This request is denied because the access is too broad. responses: - '500': *41 + '500': *132 '422': *16 '404': *7 '403': *29 - '204': *138 + '204': *131 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29333,7 +28929,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: - - *94 + - *87 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -29344,7 +28940,7 @@ paths: - *18 - *20 responses: - '500': *41 + '500': *132 '404': *7 '403': *29 '200': @@ -29353,11 +28949,11 @@ paths: application/json: schema: type: array - items: *113 + items: *106 examples: - default: *205 + default: *199 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29378,18 +28974,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: - - *94 + - *87 - *18 - *20 - - *206 - - *42 - - *207 - - *208 - - *209 - - *210 - - *211 + - *200 + - *39 + - *201 + - *202 + - *203 + - *204 + - *205 responses: - '500': *41 + '500': *132 '422': *16 '404': *7 '403': *29 @@ -29516,7 +29112,7 @@ paths: token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29536,7 +29132,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: - - *94 + - *87 requestBody: required: true content: @@ -29571,9 +29167,9 @@ paths: - 1296269 - 1296280 responses: - '500': *41 + '500': *132 '404': *7 - '202': *99 + '202': *92 '403': *29 '422': *16 x-github: @@ -29596,7 +29192,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: - - *94 + - *87 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -29624,9 +29220,9 @@ paths: value: action: revoke responses: - '500': *41 + '500': *132 '404': *7 - '204': *138 + '204': *131 '403': *29 '422': *16 x-github: @@ -29648,7 +29244,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: - - *94 + - *87 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -29658,7 +29254,7 @@ paths: - *18 - *20 responses: - '500': *41 + '500': *132 '404': *7 '403': *29 '200': @@ -29667,11 +29263,11 @@ paths: application/json: schema: type: array - items: *113 + items: *106 examples: - default: *205 + default: *199 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29691,7 +29287,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-organization-projects parameters: - - *94 + - *87 - name: state description: Indicates the state of the projects to return. in: query @@ -29712,7 +29308,7 @@ paths: application/json: schema: type: array - items: &212 + items: &206 title: Project description: Projects are a way to organize columns and cards of work. @@ -29836,7 +29432,7 @@ paths: organization_permission: write private: true headers: - Link: *39 + Link: *51 '422': *8 x-github: githubCloudOnly: false @@ -29856,7 +29452,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#create-an-organization-project parameters: - - *94 + - *87 requestBody: required: true content: @@ -29882,7 +29478,7 @@ paths: description: Response content: application/json: - schema: *212 + schema: *206 examples: default: value: @@ -29920,7 +29516,7 @@ paths: '401': *25 '403': *29 '404': *7 - '410': &264 + '410': &263 description: Gone content: application/json: @@ -29944,7 +29540,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization parameters: - - *94 + - *87 responses: '200': description: Response @@ -29952,7 +29548,7 @@ paths: application/json: schema: type: array - items: &213 + items: &207 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -30018,7 +29614,7 @@ paths: - property_name - value_type examples: - default: &214 + default: &208 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -30062,7 +29658,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization parameters: - - *94 + - *87 requestBody: required: true content: @@ -30073,7 +29669,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *213 + items: *207 minItems: 1 maxItems: 100 required: @@ -30103,9 +29699,9 @@ paths: application/json: schema: type: array - items: *213 + items: *207 examples: - default: *214 + default: *208 '403': *29 '404': *7 x-github: @@ -30126,8 +29722,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - - *94 - - &215 + - *87 + - &209 name: custom_property_name description: The custom property name in: path @@ -30139,9 +29735,9 @@ paths: description: Response content: application/json: - schema: *213 + schema: *207 examples: - default: &216 + default: &210 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -30175,13 +29771,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: - - *94 - - *215 + - *87 + - *209 requestBody: required: true content: application/json: schema: + title: Custom Property Set Payload + description: Custom property set payload type: object properties: value_type: @@ -30235,9 +29833,9 @@ paths: description: Response content: application/json: - schema: *213 + schema: *207 examples: - default: *216 + default: *210 '403': *29 '404': *7 x-github: @@ -30260,10 +29858,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - - *94 - - *215 + - *87 + - *209 responses: - '204': *138 + '204': *131 '403': *29 '404': *7 x-github: @@ -30284,7 +29882,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories parameters: - - *94 + - *87 - *18 - *20 - name: repository_query @@ -30322,7 +29920,7 @@ paths: example: octocat/Hello-World properties: type: array - items: &217 + items: &211 title: Custom Property Value description: Custom property name and associated value type: object @@ -30361,7 +29959,7 @@ paths: - property_name: team value: octocat headers: - Link: *39 + Link: *51 '403': *29 '404': *7 x-github: @@ -30389,7 +29987,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: - - *94 + - *87 requestBody: required: true content: @@ -30409,7 +30007,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *217 + items: *211 required: - repository_names - properties @@ -30450,7 +30048,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-public-organization-members parameters: - - *94 + - *87 - *18 - *20 responses: @@ -30462,9 +30060,9 @@ paths: type: array items: *19 examples: - default: *184 + default: *177 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30481,8 +30079,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-public-organization-membership-for-a-user parameters: - - *94 - - *126 + - *87 + - *119 responses: '204': description: Response if user is a public member @@ -30506,8 +30104,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user parameters: - - *94 - - *126 + - *87 + - *119 responses: '204': description: Response @@ -30528,8 +30126,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user parameters: - - *94 - - *126 + - *87 + - *119 responses: '204': description: Response @@ -30553,7 +30151,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-organization-repositories parameters: - - *94 + - *87 - name: type description: Specifies the types of repositories you want returned. in: query @@ -30599,11 +30197,11 @@ paths: application/json: schema: type: array - items: *113 + items: *106 examples: - default: *205 + default: *199 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30622,7 +30220,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-organization-repository parameters: - - *94 + - *87 requestBody: required: true content: @@ -30803,7 +30401,7 @@ paths: description: Response content: application/json: - schema: &266 + schema: &265 title: Full Repository description: Full Repository type: object @@ -31080,8 +30678,8 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: *218 - required: *219 + properties: *212 + required: *213 nullable: true temp_clone_token: type: string @@ -31168,8 +30766,8 @@ paths: title: License Simple description: License Simple type: object - properties: *76 - required: *77 + properties: *71 + required: *72 nullable: true organization: title: Simple User @@ -31178,8 +30776,8 @@ paths: properties: *4 required: *5 nullable: true - parent: *58 - source: *58 + parent: *53 + source: *53 forks: type: integer master_branch: @@ -31196,7 +30794,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &394 + properties: &393 url: type: string format: uri @@ -31212,12 +30810,12 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &395 + required: &394 - url - key - name - html_url - security_and_analysis: *220 + security_and_analysis: *214 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -31301,7 +30899,7 @@ paths: - network_count - subscribers_count examples: - default: &268 + default: &267 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -31819,10 +31417,10 @@ paths: category: orgs subcategory: rules parameters: - - *94 + - *87 - *18 - *20 - - &530 + - &529 name: targets description: | A comma-separated list of rule targets to filter by. @@ -31840,7 +31438,7 @@ paths: application/json: schema: type: array - items: &227 + items: &221 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -31864,16 +31462,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: &223 + enforcement: &217 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins @@ -31886,7 +31486,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &224 + items: &218 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -31951,7 +31551,7 @@ paths: conditions: nullable: true anyOf: - - &221 + - &215 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name @@ -31975,20 +31575,21 @@ paths: match. items: type: string - - &225 + - &219 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: - - *221 + - *215 - title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -32022,7 +31623,7 @@ paths: description: Conditions to target repositories by id and refs by name allOf: - - *221 + - *215 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -32044,7 +31645,7 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *221 + - *215 - title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -32057,7 +31658,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &222 + items: &216 title: Repository ruleset property targeting definition type: object @@ -32090,17 +31691,17 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *222 + items: *216 required: - repository_property rules: type: array - items: &226 + items: &220 title: Repository Rule type: object description: A repository rule. oneOf: - - &512 + - &511 title: creation description: Only allow users with bypass permission to create matching refs. @@ -32112,7 +31713,7 @@ paths: type: string enum: - creation - - &513 + - &512 title: update description: Only allow users with bypass permission to update matching refs. @@ -32133,7 +31734,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &515 + - &514 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -32145,7 +31746,7 @@ paths: type: string enum: - deletion - - &516 + - &515 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -32157,7 +31758,7 @@ paths: type: string enum: - required_linear_history - - &517 + - &516 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -32235,7 +31836,7 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - &518 + - &517 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that @@ -32259,7 +31860,7 @@ paths: type: string required: - required_deployment_environments - - &519 + - &518 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -32271,7 +31872,7 @@ paths: type: string enum: - required_signatures - - &520 + - &519 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can @@ -32287,6 +31888,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 @@ -32317,7 +31925,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &521 + - &520 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be @@ -32365,7 +31973,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &522 + - &521 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -32377,7 +31985,7 @@ paths: type: string enum: - non_fast_forward - - &523 + - &522 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -32413,7 +32021,7 @@ paths: required: - operator - pattern - - &524 + - &523 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -32449,7 +32057,7 @@ paths: required: - operator - pattern - - &525 + - &524 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -32485,7 +32093,7 @@ paths: required: - operator - pattern - - &526 + - &525 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -32521,7 +32129,7 @@ paths: required: - operator - pattern - - &527 + - &526 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -32647,7 +32255,7 @@ paths: maximum: 100 required: - max_file_size - - &528 + - &527 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -32697,7 +32305,7 @@ paths: - repository_id required: - workflows - - &529 + - &528 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, @@ -32794,7 +32402,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *7 - '500': *41 + '500': *132 post: summary: Create an organization repository ruleset description: Create a repository ruleset for an organization. @@ -32810,7 +32418,7 @@ paths: category: orgs subcategory: rules parameters: - - *94 + - *87 requestBody: description: Request body required: true @@ -32829,17 +32437,18 @@ paths: - branch - tag - push + - repository default: branch - enforcement: *223 + enforcement: *217 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *224 - conditions: *225 + items: *218 + conditions: *219 rules: type: array description: An array of rules within the ruleset. - items: *226 + items: *220 required: - name - enforcement @@ -32877,9 +32486,9 @@ paths: description: Response content: application/json: - schema: *227 + schema: *221 examples: - default: &228 + default: &222 value: id: 21 name: super cool ruleset @@ -32919,7 +32528,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *7 - '500': *41 + '500': *132 "/orgs/{org}/rulesets/rule-suites": get: summary: List organization rule suites @@ -32933,8 +32542,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *94 - - &531 + - *87 + - &530 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 @@ -32949,7 +32558,7 @@ paths: in: query schema: type: string - - &532 + - &531 name: time_period description: |- The time period to filter by. @@ -32965,14 +32574,14 @@ paths: - week - month default: day - - &533 + - &532 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 - - &534 + - &533 name: rule_suite_result description: The rule results to filter on. When specified, only suites with this result will be returned. @@ -32992,7 +32601,7 @@ paths: description: Response content: application/json: - schema: &535 + schema: &534 title: Rule Suites description: Response type: array @@ -33047,7 +32656,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &536 + default: &535 value: - id: 21 actor_id: 12 @@ -33071,7 +32680,7 @@ paths: result: pass evaluation_result: fail '404': *7 - '500': *41 + '500': *132 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33090,8 +32699,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *94 - - &537 + - *87 + - &536 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -33107,7 +32716,7 @@ paths: description: Response content: application/json: - schema: &538 + schema: &537 title: Rule Suite description: Response type: object @@ -33206,7 +32815,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &539 + default: &538 value: id: 21 actor_id: 12 @@ -33241,7 +32850,7 @@ paths: result: fail rule_type: commit_message_pattern '404': *7 - '500': *41 + '500': *132 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33267,7 +32876,7 @@ paths: category: orgs subcategory: rules parameters: - - *94 + - *87 - name: ruleset_id description: The ID of the ruleset. in: path @@ -33279,11 +32888,11 @@ paths: description: Response content: application/json: - schema: *227 + schema: *221 examples: - default: *228 + default: *222 '404': *7 - '500': *41 + '500': *132 put: summary: Update an organization repository ruleset description: Update a ruleset for an organization. @@ -33299,7 +32908,7 @@ paths: category: orgs subcategory: rules parameters: - - *94 + - *87 - name: ruleset_id description: The ID of the ruleset. in: path @@ -33324,16 +32933,17 @@ paths: - branch - tag - push - enforcement: *223 + - repository + enforcement: *217 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *224 - conditions: *225 + items: *218 + conditions: *219 rules: description: An array of rules within the ruleset. type: array - items: *226 + items: *220 examples: default: value: @@ -33368,11 +32978,11 @@ paths: description: Response content: application/json: - schema: *227 + schema: *221 examples: - default: *228 + default: *222 '404': *7 - '500': *41 + '500': *132 delete: summary: Delete an organization repository ruleset description: Delete a ruleset for an organization. @@ -33388,7 +32998,7 @@ paths: category: orgs subcategory: rules parameters: - - *94 + - *87 - name: ruleset_id description: The ID of the ruleset. in: path @@ -33399,7 +33009,7 @@ paths: '204': description: Response '404': *7 - '500': *41 + '500': *132 "/orgs/{org}/secret-scanning/alerts": get: summary: List secret scanning alerts for an organization @@ -33416,15 +33026,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - - *94 - - *229 - - *230 - - *231 - - *232 - - *42 + - *87 + - *223 + - *224 + - *225 + - *226 + - *39 - *20 - *18 - - &541 + - &540 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 @@ -33434,7 +33044,7 @@ paths: required: false schema: type: string - - &542 + - &541 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 @@ -33444,9 +33054,9 @@ paths: required: false schema: type: string - - *233 - - *234 - - *235 + - *227 + - *228 + - *229 responses: '200': description: Response @@ -33454,13 +33064,13 @@ paths: application/json: schema: type: array - items: *236 + items: *230 examples: - default: *237 + default: *231 headers: - Link: *39 + Link: *51 '404': *7 - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33482,8 +33092,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization parameters: - - *94 - - *42 + - *87 + - *39 - name: sort description: The property to sort the results by. in: query @@ -33495,8 +33105,8 @@ paths: - updated - published default: created - - *43 - - *44 + - *40 + - *41 - 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)." @@ -33526,7 +33136,7 @@ paths: application/json: schema: type: array - items: &549 + items: &548 description: A repository security advisory. type: object properties: @@ -33713,7 +33323,7 @@ paths: required: - vector_string - score - cvss_severities: *46 + cvss_severities: *43 cwes: type: array nullable: true @@ -33746,7 +33356,7 @@ paths: login: type: string description: The username of the user credited. - type: *238 + type: *232 credits_detailed: type: array nullable: true @@ -33756,7 +33366,7 @@ paths: type: object properties: user: *19 - type: *238 + type: *232 state: type: string description: The state of the user's acceptance of the @@ -33780,14 +33390,14 @@ paths: type: array description: A list of teams that collaborate on the advisory. nullable: true - items: *181 + items: *174 private_fork: readOnly: true nullable: true description: A temporary private fork of the advisory's repository for collaborating on a fix. allOf: - - *52 + - *50 required: - ghsa_id - cve_id @@ -33817,7 +33427,7 @@ paths: - private_fork additionalProperties: false examples: - default: &550 + default: &549 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -34199,7 +33809,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams parameters: - - *94 + - *87 responses: '200': description: Response @@ -34207,9 +33817,9 @@ paths: application/json: schema: type: array - items: *239 + items: *233 examples: - default: *198 + default: *192 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34232,8 +33842,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team parameters: - - *94 - - *193 + - *87 + - *187 responses: '204': description: Response @@ -34258,8 +33868,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *94 - - *193 + - *87 + - *187 responses: '204': description: Response @@ -34285,13 +33895,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-an-organization parameters: - - *94 + - *87 responses: '200': description: Response content: application/json: - schema: &609 + schema: &608 type: object properties: total_minutes_used: @@ -34361,7 +33971,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &610 + default: &609 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -34391,13 +34001,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-an-organization parameters: - - *94 + - *87 responses: '200': description: Response content: application/json: - schema: &611 + schema: &610 type: object properties: total_gigabytes_bandwidth_used: @@ -34415,7 +34025,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &612 + default: &611 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -34441,13 +34051,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-an-organization parameters: - - *94 + - *87 responses: '200': description: Response content: application/json: - schema: &613 + schema: &612 type: object properties: days_left_in_billing_cycle: @@ -34465,7 +34075,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &614 + default: &613 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -34499,8 +34109,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - - *94 - - *193 + - *87 + - *187 - 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`). @@ -34532,13 +34142,13 @@ paths: application/json: schema: type: array - items: *53 + items: *234 examples: - default: *54 - '500': *41 + default: *235 + '500': *132 '403': *29 '404': *7 - '422': *55 + '422': *236 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34572,8 +34182,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: - - *94 - - *193 + - *87 + - *187 - 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`). @@ -34605,10 +34215,10 @@ paths: application/json: schema: type: array - items: *56 + items: *237 examples: - default: *142 - '500': *41 + default: *238 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -34629,7 +34239,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-teams parameters: - - *94 + - *87 - *18 - *20 responses: @@ -34639,11 +34249,11 @@ paths: application/json: schema: type: array - items: *181 + items: *174 examples: - default: *198 + default: *192 headers: - Link: *39 + Link: *51 '403': *29 x-github: githubCloudOnly: false @@ -34663,7 +34273,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#create-a-team parameters: - - *94 + - *87 requestBody: required: true content: @@ -34735,7 +34345,7 @@ paths: description: Response content: application/json: - schema: &240 + schema: &239 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -34798,8 +34408,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *196 - required: *197 + properties: *190 + required: *191 nullable: true members_count: type: integer @@ -35045,7 +34655,7 @@ paths: - repos_count - organization examples: - default: &241 + default: &240 value: id: 1 node_id: MDQ6VGVhbTE= @@ -35115,16 +34725,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-by-name parameters: - - *94 - - *193 + - *87 + - *187 responses: '200': description: Response content: application/json: - schema: *240 + schema: *239 examples: - default: *241 + default: *240 '404': *7 x-github: githubCloudOnly: false @@ -35145,8 +34755,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team parameters: - - *94 - - *193 + - *87 + - *187 requestBody: required: false content: @@ -35208,16 +34818,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *240 + schema: *239 examples: - default: *241 + default: *240 '201': description: Response content: application/json: - schema: *240 + schema: *239 examples: - default: *241 + default: *240 '404': *7 '422': *16 '403': *29 @@ -35242,8 +34852,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team parameters: - - *94 - - *193 + - *87 + - *187 responses: '204': description: Response @@ -35269,9 +34879,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions parameters: - - *94 - - *193 - - *42 + - *87 + - *187 + - *39 - *18 - *20 - name: pinned @@ -35287,7 +34897,7 @@ paths: application/json: schema: type: array - items: &242 + items: &241 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -35366,7 +34976,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *62 + reactions: *57 required: - author - body @@ -35386,7 +34996,7 @@ paths: - updated_at - url examples: - default: &564 + default: &563 value: - author: login: octocat @@ -35436,7 +35046,7 @@ paths: eyes: 1 rocket: 1 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35460,8 +35070,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion parameters: - - *94 - - *193 + - *87 + - *187 requestBody: required: true content: @@ -35495,9 +35105,9 @@ paths: description: Response content: application/json: - schema: *242 + schema: *241 examples: - default: &243 + default: &242 value: author: login: octocat @@ -35569,9 +35179,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion parameters: - - *94 - - *193 - - &244 + - *87 + - *187 + - &243 name: discussion_number description: The number that identifies the discussion. in: path @@ -35583,9 +35193,9 @@ paths: description: Response content: application/json: - schema: *242 + schema: *241 examples: - default: *243 + default: *242 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35607,9 +35217,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion parameters: - - *94 - - *193 - - *244 + - *87 + - *187 + - *243 requestBody: required: false content: @@ -35632,9 +35242,9 @@ paths: description: Response content: application/json: - schema: *242 + schema: *241 examples: - default: &565 + default: &564 value: author: login: octocat @@ -35704,9 +35314,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion parameters: - - *94 - - *193 - - *244 + - *87 + - *187 + - *243 responses: '204': description: Response @@ -35732,10 +35342,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments parameters: - - *94 - - *193 - - *244 - - *42 + - *87 + - *187 + - *243 + - *39 - *18 - *20 responses: @@ -35745,7 +35355,7 @@ paths: application/json: schema: type: array - items: &245 + items: &244 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -35802,7 +35412,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *62 + reactions: *57 required: - author - body @@ -35817,7 +35427,7 @@ paths: - updated_at - url examples: - default: &566 + default: &565 value: - author: login: octocat @@ -35861,7 +35471,7 @@ paths: eyes: 1 rocket: 1 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35885,9 +35495,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment parameters: - - *94 - - *193 - - *244 + - *87 + - *187 + - *243 requestBody: required: true content: @@ -35909,9 +35519,9 @@ paths: description: Response content: application/json: - schema: *245 + schema: *244 examples: - default: &246 + default: &245 value: author: login: octocat @@ -35977,10 +35587,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment parameters: - - *94 - - *193 - - *244 - - &247 + - *87 + - *187 + - *243 + - &246 name: comment_number description: The number that identifies the comment. in: path @@ -35992,9 +35602,9 @@ paths: description: Response content: application/json: - schema: *245 + schema: *244 examples: - default: *246 + default: *245 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36016,10 +35626,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment parameters: - - *94 - - *193 - - *244 - - *247 + - *87 + - *187 + - *243 + - *246 requestBody: required: true content: @@ -36041,9 +35651,9 @@ paths: description: Response content: application/json: - schema: *245 + schema: *244 examples: - default: &567 + default: &566 value: author: login: octocat @@ -36107,10 +35717,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment parameters: - - *94 - - *193 - - *244 - - *247 + - *87 + - *187 + - *243 + - *246 responses: '204': description: Response @@ -36136,10 +35746,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment parameters: - - *94 - - *193 - - *244 - - *247 + - *87 + - *187 + - *243 + - *246 - 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. @@ -36165,7 +35775,7 @@ paths: application/json: schema: type: array - items: &248 + items: &247 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -36208,7 +35818,7 @@ paths: - content - created_at examples: - default: &250 + default: &249 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -36234,7 +35844,7 @@ paths: content: heart created_at: '2016-05-20T20:09:31Z' headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36258,10 +35868,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment parameters: - - *94 - - *193 - - *244 - - *247 + - *87 + - *187 + - *243 + - *246 requestBody: required: true content: @@ -36294,9 +35904,9 @@ paths: team discussion comment content: application/json: - schema: *248 + schema: *247 examples: - default: &249 + default: &248 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -36325,9 +35935,9 @@ paths: description: Response content: application/json: - schema: *248 + schema: *247 examples: - default: *249 + default: *248 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36350,11 +35960,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - - *94 - - *193 - - *244 - - *247 - - &251 + - *87 + - *187 + - *243 + - *246 + - &250 name: reaction_id description: The unique identifier of the reaction. in: path @@ -36386,9 +35996,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - - *94 - - *193 - - *244 + - *87 + - *187 + - *243 - 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. @@ -36414,11 +36024,11 @@ paths: application/json: schema: type: array - items: *248 + items: *247 examples: - default: *250 + default: *249 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36442,9 +36052,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - - *94 - - *193 - - *244 + - *87 + - *187 + - *243 requestBody: required: true content: @@ -36476,16 +36086,16 @@ paths: description: Response content: application/json: - schema: *248 + schema: *247 examples: - default: *249 + default: *248 '201': description: Response content: application/json: - schema: *248 + schema: *247 examples: - default: *249 + default: *248 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -36508,10 +36118,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction parameters: - - *94 - - *193 - - *244 - - *251 + - *87 + - *187 + - *243 + - *250 responses: '204': description: Response @@ -36535,8 +36145,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations parameters: - - *94 - - *193 + - *87 + - *187 - *18 - *20 responses: @@ -36546,11 +36156,11 @@ paths: application/json: schema: type: array - items: *178 + items: *171 examples: - default: *179 + default: *172 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36570,8 +36180,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members parameters: - - *94 - - *193 + - *87 + - *187 - name: role description: Filters members returned by their role in the team. in: query @@ -36594,9 +36204,9 @@ paths: type: array items: *19 examples: - default: *184 + default: *177 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36624,15 +36234,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user parameters: - - *94 - - *193 - - *126 + - *87 + - *187 + - *119 responses: '200': description: Response content: application/json: - schema: &252 + schema: &251 title: Team Membership description: Team Membership type: object @@ -36659,7 +36269,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &568 + response-if-user-is-a-team-maintainer: &567 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -36695,9 +36305,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user parameters: - - *94 - - *193 - - *126 + - *87 + - *187 + - *119 requestBody: required: false content: @@ -36722,9 +36332,9 @@ paths: description: Response content: application/json: - schema: *252 + schema: *251 examples: - response-if-users-membership-with-team-is-now-pending: &569 + response-if-users-membership-with-team-is-now-pending: &568 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -36759,9 +36369,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user parameters: - - *94 - - *193 - - *126 + - *87 + - *187 + - *119 responses: '204': description: Response @@ -36787,8 +36397,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects parameters: - - *94 - - *193 + - *87 + - *187 - *18 - *20 responses: @@ -36798,7 +36408,7 @@ paths: application/json: schema: type: array - items: &253 + items: &252 title: Team Project description: A team's access to a project. type: object @@ -36866,7 +36476,7 @@ paths: - updated_at - permissions examples: - default: &570 + default: &569 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -36906,7 +36516,7 @@ paths: write: true admin: false headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36927,9 +36537,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project parameters: - - *94 - - *193 - - &254 + - *87 + - *187 + - &253 name: project_id description: The unique identifier of the project. in: path @@ -36941,9 +36551,9 @@ paths: description: Response content: application/json: - schema: *253 + schema: *252 examples: - default: &571 + default: &570 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -37003,9 +36613,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions parameters: - - *94 - - *193 - - *254 + - *87 + - *187 + - *253 requestBody: required: false content: @@ -37069,9 +36679,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team parameters: - - *94 - - *193 - - *254 + - *87 + - *187 + - *253 responses: '204': description: Response @@ -37095,8 +36705,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories parameters: - - *94 - - *193 + - *87 + - *187 - *18 - *20 responses: @@ -37106,11 +36716,11 @@ paths: application/json: schema: type: array - items: *113 + items: *106 examples: - default: *205 + default: *199 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37137,16 +36747,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *94 - - *193 + - *87 + - *187 + - *254 - *255 - - *256 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &572 + schema: &571 title: Team Repository description: A team's access to a repository. type: object @@ -37169,8 +36779,8 @@ paths: title: License Simple description: License Simple type: object - properties: *76 - required: *77 + properties: *71 + required: *72 nullable: true forks: type: integer @@ -37715,10 +37325,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *94 - - *193 + - *87 + - *187 + - *254 - *255 - - *256 requestBody: required: false content: @@ -37763,10 +37373,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team parameters: - - *94 - - *193 + - *87 + - *187 + - *254 - *255 - - *256 responses: '204': description: Response @@ -37790,8 +37400,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams parameters: - - *94 - - *193 + - *87 + - *187 - *18 - *20 responses: @@ -37801,9 +37411,9 @@ paths: application/json: schema: type: array - items: *181 + items: *174 examples: - response-if-child-teams-exist: &573 + response-if-child-teams-exist: &572 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -37831,7 +37441,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos html_url: https://github.com/orgs/rails/teams/core headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37856,7 +37466,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization parameters: - - *94 + - *87 - name: security_product in: path description: The security feature to enable or disable. @@ -37927,7 +37537,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#get-a-project-card parameters: - - &257 + - &256 name: card_id description: The unique identifier of the card. in: path @@ -37939,7 +37549,7 @@ paths: description: Response content: application/json: - schema: &258 + schema: &257 title: Project Card description: Project cards represent a scope of work. type: object @@ -38006,7 +37616,7 @@ paths: - created_at - updated_at examples: - default: &259 + default: &258 value: url: https://api.github.com/projects/columns/cards/1478 id: 1478 @@ -38056,7 +37666,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#update-an-existing-project-card parameters: - - *257 + - *256 requestBody: required: false content: @@ -38083,9 +37693,9 @@ paths: description: Response content: application/json: - schema: *258 + schema: *257 examples: - default: *259 + default: *258 '304': *37 '403': *29 '401': *25 @@ -38106,7 +37716,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#delete-a-project-card parameters: - - *257 + - *256 responses: '204': description: Response @@ -38144,7 +37754,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#move-a-project-card parameters: - - *257 + - *256 requestBody: required: true content: @@ -38249,7 +37859,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#get-a-project-column parameters: - - &260 + - &259 name: column_id description: The unique identifier of the column. in: path @@ -38261,7 +37871,7 @@ paths: description: Response content: application/json: - schema: &261 + schema: &260 title: Project Column description: Project columns contain cards of work. type: object @@ -38307,7 +37917,7 @@ paths: - created_at - updated_at examples: - default: &262 + default: &261 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -38336,7 +37946,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#update-an-existing-project-column parameters: - - *260 + - *259 requestBody: required: true content: @@ -38360,9 +37970,9 @@ paths: description: Response content: application/json: - schema: *261 + schema: *260 examples: - default: *262 + default: *261 '304': *37 '403': *29 '401': *25 @@ -38381,7 +37991,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#delete-a-project-column parameters: - - *260 + - *259 responses: '204': description: Response @@ -38404,7 +38014,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#list-project-cards parameters: - - *260 + - *259 - name: archived_state description: Filters the project cards that are returned by the card's state. in: query @@ -38425,7 +38035,7 @@ paths: application/json: schema: type: array - items: *258 + items: *257 examples: default: value: @@ -38459,7 +38069,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: *39 + Link: *51 '304': *37 '403': *29 '401': *25 @@ -38478,7 +38088,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#create-a-project-card parameters: - - *260 + - *259 requestBody: required: true content: @@ -38518,9 +38128,9 @@ paths: description: Response content: application/json: - schema: *258 + schema: *257 examples: - default: *259 + default: *258 '304': *37 '403': *29 '401': *25 @@ -38530,8 +38140,8 @@ paths: application/json: schema: oneOf: - - *97 - - *98 + - *90 + - *91 '503': description: Response content: @@ -38570,7 +38180,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#move-a-project-column parameters: - - *260 + - *259 requestBody: required: true content: @@ -38626,15 +38236,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-a-project parameters: - - *254 + - *253 responses: '200': description: Response content: application/json: - schema: *212 + schema: *206 examples: - default: &263 + default: &262 value: owner_url: https://api.github.com/repos/api-playground/projects-test url: https://api.github.com/projects/1002604 @@ -38687,7 +38297,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#update-a-project parameters: - - *254 + - *253 requestBody: required: false content: @@ -38733,9 +38343,9 @@ paths: description: Response content: application/json: - schema: *212 + schema: *206 examples: - default: *263 + default: *262 '404': description: Not Found if the authenticated user does not have access to the project @@ -38756,7 +38366,7 @@ paths: items: type: string '401': *25 - '410': *264 + '410': *263 '422': *8 x-github: githubCloudOnly: false @@ -38774,7 +38384,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#delete-a-project parameters: - - *254 + - *253 responses: '204': description: Delete Success @@ -38795,7 +38405,7 @@ paths: items: type: string '401': *25 - '410': *264 + '410': *263 '404': *7 x-github: githubCloudOnly: false @@ -38818,7 +38428,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/collaborators#list-project-collaborators parameters: - - *254 + - *253 - 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 @@ -38845,9 +38455,9 @@ paths: type: array items: *19 examples: - default: *184 + default: *177 headers: - Link: *39 + Link: *51 '404': *7 '422': *16 '304': *37 @@ -38870,8 +38480,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/collaborators#add-project-collaborator parameters: - - *254 - - *126 + - *253 + - *119 requestBody: required: false content: @@ -38918,8 +38528,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/collaborators#remove-user-as-a-collaborator parameters: - - *254 - - *126 + - *253 + - *119 responses: '204': description: Response @@ -38947,8 +38557,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/collaborators#get-project-permission-for-a-user parameters: - - *254 - - *126 + - *253 + - *119 responses: '200': description: Response @@ -39015,7 +38625,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#list-project-columns parameters: - - *254 + - *253 - *18 - *20 responses: @@ -39025,7 +38635,7 @@ paths: application/json: schema: type: array - items: *261 + items: *260 examples: default: value: @@ -39038,7 +38648,7 @@ paths: created_at: '2016-09-05T14:18:44Z' updated_at: '2016-09-05T14:22:28Z' headers: - Link: *39 + Link: *51 '304': *37 '403': *29 '401': *25 @@ -39057,7 +38667,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#create-a-project-column parameters: - - *254 + - *253 requestBody: required: true content: @@ -39080,7 +38690,7 @@ paths: description: Response content: application/json: - schema: *261 + schema: *260 examples: default: value: @@ -39141,7 +38751,7 @@ paths: resources: type: object properties: - core: &265 + core: &264 title: Rate Limit type: object properties: @@ -39158,19 +38768,20 @@ paths: - remaining - reset - used - graphql: *265 - search: *265 - code_search: *265 - source_import: *265 - integration_manifest: *265 - code_scanning_upload: *265 - actions_runner_registration: *265 - scim: *265 - dependency_snapshots: *265 + graphql: *264 + search: *264 + code_search: *264 + source_import: *264 + integration_manifest: *264 + code_scanning_upload: *264 + actions_runner_registration: *264 + scim: *264 + dependency_snapshots: *264 + code_scanning_autofix: *264 required: - core - search - rate: *265 + rate: *264 required: - rate - resources @@ -39228,6 +38839,11 @@ paths: used: 0 remaining: 10 reset: 1691591091 + code_scanning_autofix: + limit: 10 + used: 0 + remaining: 10 + reset: 1691591091 rate: limit: 5000 used: 1 @@ -39269,14 +38885,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: + - *254 - *255 - - *256 responses: '200': description: Response content: application/json: - schema: *266 + schema: *265 examples: default-response: summary: Default response @@ -39777,7 +39393,7 @@ paths: status: disabled '403': *29 '404': *7 - '301': *267 + '301': *266 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39795,8 +39411,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: + - *254 - *255 - - *256 requestBody: required: false content: @@ -40032,10 +39648,10 @@ paths: description: Response content: application/json: - schema: *266 + schema: *265 examples: - default: *268 - '307': &269 + default: *267 + '307': &268 description: Temporary Redirect content: application/json: @@ -40064,8 +39680,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: + - *254 - *255 - - *256 responses: '204': description: Response @@ -40087,7 +39703,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *269 + '307': *268 '404': *7 x-github: githubCloudOnly: false @@ -40110,11 +39726,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: + - *254 - *255 - - *256 - *18 - *20 - - &295 + - &294 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -40137,7 +39753,7 @@ paths: type: integer artifacts: type: array - items: &270 + items: &269 title: Artifact description: An artifact type: object @@ -40208,7 +39824,7 @@ paths: - expires_at - updated_at examples: - default: &296 + default: &295 value: total_count: 2 artifacts: @@ -40245,7 +39861,7 @@ paths: head_branch: main head_sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40267,9 +39883,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: + - *254 - *255 - - *256 - - &271 + - &270 name: artifact_id description: The unique identifier of the artifact. in: path @@ -40281,7 +39897,7 @@ paths: description: Response content: application/json: - schema: *270 + schema: *269 examples: default: value: @@ -40318,9 +39934,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: + - *254 - *255 - - *256 - - *271 + - *270 responses: '204': description: Response @@ -40344,9 +39960,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: + - *254 - *255 - - *256 - - *271 + - *270 - name: archive_format in: path required: true @@ -40360,7 +39976,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': *264 + '410': *263 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40383,14 +39999,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: + - *254 - *255 - - *256 responses: '200': description: Response content: application/json: - schema: *272 + schema: *271 examples: default: value: @@ -40416,11 +40032,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: + - *254 - *255 - - *256 - *18 - *20 - - &273 + - &272 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 @@ -40448,13 +40064,13 @@ paths: - last_accessed_at - size_in_bytes default: last_accessed_at - - *42 + - *39 responses: '200': description: Response content: application/json: - schema: &274 + schema: &273 title: Repository actions caches description: Repository actions caches type: object @@ -40496,7 +40112,7 @@ paths: - total_count - actions_caches examples: - default: &275 + default: &274 value: total_count: 1 actions_caches: @@ -40508,7 +40124,7 @@ paths: created_at: '2019-01-24T22:45:36.000Z' size_in_bytes: 1024 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40528,23 +40144,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: + - *254 - *255 - - *256 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *273 + - *272 responses: '200': description: Response content: application/json: - schema: *274 + schema: *273 examples: - default: *275 + default: *274 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40564,8 +40180,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: + - *254 - *255 - - *256 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -40596,9 +40212,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: + - *254 - *255 - - *256 - - &276 + - &275 name: job_id description: The unique identifier of the job. in: path @@ -40610,7 +40226,7 @@ paths: description: Response content: application/json: - schema: &299 + schema: &298 title: Job description: Information of a job execution in a workflow run type: object @@ -40917,9 +40533,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: + - *254 - *255 - - *256 - - *276 + - *275 responses: '302': description: Response @@ -40947,9 +40563,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: + - *254 - *255 - - *256 - - *276 + - *275 requestBody: required: false content: @@ -40970,7 +40586,7 @@ paths: description: Response content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -40994,8 +40610,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: + - *254 - *255 - - *256 responses: '200': description: Status response @@ -41045,8 +40661,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: + - *254 - *255 - - *256 requestBody: required: true content: @@ -41080,7 +40696,7 @@ paths: description: Empty response content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -41109,8 +40725,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -41128,7 +40744,7 @@ paths: type: integer secrets: type: array - items: &301 + items: &300 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -41148,7 +40764,7 @@ paths: - created_at - updated_at examples: - default: &302 + default: &301 value: total_count: 2 secrets: @@ -41159,7 +40775,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41181,9 +40797,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: + - *254 - *255 - - *256 - - *277 + - *276 - *20 responses: '200': @@ -41200,7 +40816,7 @@ paths: type: integer variables: type: array - items: &305 + items: &304 title: Actions Variable type: object properties: @@ -41230,7 +40846,7 @@ paths: - created_at - updated_at examples: - default: &306 + default: &305 value: total_count: 2 variables: @@ -41243,7 +40859,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41263,8 +40879,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: + - *254 - *255 - - *256 responses: '200': description: Response @@ -41273,11 +40889,11 @@ paths: schema: type: object properties: - enabled: &279 + enabled: &278 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *103 - selected_actions_url: *278 + allowed_actions: *96 + selected_actions_url: *277 required: - enabled examples: @@ -41304,8 +40920,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: + - *254 - *255 - - *256 responses: '204': description: Response @@ -41316,8 +40932,8 @@ paths: schema: type: object properties: - enabled: *279 - allowed_actions: *103 + enabled: *278 + allowed_actions: *96 required: - enabled examples: @@ -41346,14 +40962,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: + - *254 - *255 - - *256 responses: '200': description: Response content: application/json: - schema: &280 + schema: &279 type: object properties: access_level: @@ -41370,7 +40986,7 @@ paths: required: - access_level examples: - default: &281 + default: &280 value: access_level: organization x-github: @@ -41394,15 +41010,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: + - *254 - *255 - - *256 requestBody: required: true content: application/json: - schema: *280 + schema: *279 examples: - default: *281 + default: *280 responses: '204': description: Response @@ -41426,16 +41042,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: + - *254 - *255 - - *256 responses: '200': description: Response content: application/json: - schema: *105 + schema: *98 examples: - default: *106 + default: *99 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -41454,8 +41070,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: + - *254 - *255 - - *256 responses: '204': description: Response @@ -41463,9 +41079,9 @@ paths: required: false content: application/json: - schema: *105 + schema: *98 examples: - selected_actions: *106 + selected_actions: *99 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -41487,16 +41103,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: + - *254 - *255 - - *256 responses: '200': description: Response content: application/json: - schema: *282 + schema: *281 examples: - default: *109 + default: *102 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41517,8 +41133,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: + - *254 - *255 - - *256 responses: '204': description: Success response @@ -41529,9 +41145,9 @@ paths: required: true content: application/json: - schema: *283 + schema: *282 examples: - default: *109 + default: *102 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41558,8 +41174,8 @@ paths: in: query schema: type: string + - *254 - *255 - - *256 - *18 - *20 responses: @@ -41577,11 +41193,11 @@ paths: type: integer runners: type: array - items: *115 + items: *108 examples: - default: *116 + default: *109 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41603,8 +41219,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: + - *254 - *255 - - *256 responses: '200': description: Response @@ -41612,9 +41228,9 @@ paths: application/json: schema: type: array - items: *284 + items: *283 examples: - default: *285 + default: *284 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41636,8 +41252,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: + - *254 - *255 - - *256 requestBody: required: true content: @@ -41680,7 +41296,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *286 + '201': *285 '404': *7 '422': *8 x-github: @@ -41710,16 +41326,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: + - *254 - *255 - - *256 responses: '201': description: Response content: application/json: - schema: *117 + schema: *110 examples: - default: *287 + default: *286 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41747,16 +41363,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: + - *254 - *255 - - *256 responses: '201': description: Response content: application/json: - schema: *117 + schema: *110 examples: - default: *288 + default: *287 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41778,17 +41394,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: + - *254 - *255 - - *256 - - *114 + - *107 responses: '200': description: Response content: application/json: - schema: *115 + schema: *108 examples: - default: *289 + default: *288 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41809,9 +41425,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: + - *254 - *255 - - *256 - - *114 + - *107 responses: '204': description: Response @@ -41836,11 +41452,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: + - *254 - *255 - - *256 - - *114 + - *107 responses: - '200': *119 + '200': *112 '404': *7 x-github: githubCloudOnly: false @@ -41862,9 +41478,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: + - *254 - *255 - - *256 - - *114 + - *107 requestBody: required: true content: @@ -41888,7 +41504,7 @@ paths: - gpu - accelerated responses: - '200': *119 + '200': *112 '404': *7 '422': *8 x-github: @@ -41912,9 +41528,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: + - *254 - *255 - - *256 - - *114 + - *107 requestBody: required: true content: @@ -41939,7 +41555,7 @@ paths: - gpu - accelerated responses: - '200': *119 + '200': *112 '404': *7 '422': *8 x-github: @@ -41963,11 +41579,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: + - *254 - *255 - - *256 - - *114 + - *107 responses: - '200': *290 + '200': *289 '404': *7 x-github: githubCloudOnly: false @@ -41994,12 +41610,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: + - *254 - *255 - - *256 - - *114 - - *291 + - *107 + - *290 responses: - '200': *119 + '200': *112 '404': *7 '422': *8 x-github: @@ -42025,9 +41641,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: + - *254 - *255 - - *256 - - &309 + - &308 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. @@ -42035,7 +41651,7 @@ paths: required: false schema: type: string - - &310 + - &309 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -42043,7 +41659,7 @@ paths: required: false schema: type: string - - &311 + - &310 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -42052,7 +41668,7 @@ paths: required: false schema: type: string - - &312 + - &311 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 @@ -42079,7 +41695,7 @@ paths: - pending - *18 - *20 - - &313 + - &312 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)." @@ -42088,7 +41704,7 @@ paths: schema: type: string format: date-time - - &292 + - &291 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -42097,13 +41713,13 @@ paths: schema: type: boolean default: false - - &314 + - &313 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &315 + - &314 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -42126,7 +41742,7 @@ paths: type: integer workflow_runs: type: array - items: &293 + items: &292 title: Workflow Run description: An invocation of a workflow type: object @@ -42221,7 +41837,7 @@ paths: that triggered the run. type: array nullable: true - items: &334 + items: &333 title: Pull Request Minimal type: object properties: @@ -42340,7 +41956,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &338 + properties: &337 id: type: string description: SHA for the commit @@ -42391,7 +42007,7 @@ paths: - name - email nullable: true - required: &339 + required: &338 - id - tree_id - message @@ -42399,8 +42015,8 @@ paths: - author - committer nullable: true - repository: *113 - head_repository: *113 + repository: *106 + head_repository: *106 head_repository_id: type: integer example: 5 @@ -42438,7 +42054,7 @@ paths: - workflow_url - pull_requests examples: - default: &316 + default: &315 value: total_count: 1 workflow_runs: @@ -42652,7 +42268,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: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42674,24 +42290,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: + - *254 - *255 - - *256 - - &294 + - &293 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *292 + - *291 responses: '200': description: Response content: application/json: - schema: *293 + schema: *292 examples: - default: &297 + default: &296 value: id: 30433642 name: Build @@ -42932,9 +42548,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: + - *254 - *255 - - *256 - - *294 + - *293 responses: '204': description: Response @@ -42957,9 +42573,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: + - *254 - *255 - - *256 - - *294 + - *293 responses: '200': description: Response @@ -43078,15 +42694,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: + - *254 - *255 - - *256 - - *294 + - *293 responses: '201': description: Response content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -43113,12 +42729,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: + - *254 - *255 - - *256 - - *294 + - *293 - *18 - *20 - - *295 + - *294 responses: '200': description: Response @@ -43134,11 +42750,11 @@ paths: type: integer artifacts: type: array - items: *270 + items: *269 examples: - default: *296 + default: *295 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43160,25 +42776,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: + - *254 - *255 - - *256 - - *294 - - &298 + - *293 + - &297 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *292 + - *291 responses: '200': description: Response content: application/json: - schema: *293 + schema: *292 examples: - default: *297 + default: *296 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43201,10 +42817,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: + - *254 - *255 - - *256 - - *294 - - *298 + - *293 + - *297 - *18 - *20 responses: @@ -43222,9 +42838,9 @@ paths: type: integer jobs: type: array - items: *299 + items: *298 examples: - default: &300 + default: &299 value: total_count: 1 jobs: @@ -43313,7 +42929,7 @@ paths: workflow_name: CI head_branch: main headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -43337,10 +42953,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: + - *254 - *255 - - *256 - - *294 - - *298 + - *293 + - *297 responses: '302': description: Response @@ -43368,19 +42984,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: + - *254 - *255 - - *256 - - *294 + - *293 responses: '202': description: Response content: application/json: - schema: *122 + schema: *115 examples: default: value: - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43403,9 +43019,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: + - *254 - *255 - - *256 - - *294 + - *293 requestBody: required: true content: @@ -43472,19 +43088,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: + - *254 - *255 - - *256 - - *294 + - *293 responses: '202': description: Response content: application/json: - schema: *122 + schema: *115 examples: default: value: - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43507,9 +43123,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: + - *254 - *255 - - *256 - - *294 + - *293 - 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 @@ -43539,11 +43155,11 @@ paths: type: integer jobs: type: array - items: *299 + items: *298 examples: - default: *300 + default: *299 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43566,9 +43182,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: + - *254 - *255 - - *256 - - *294 + - *293 responses: '302': description: Response @@ -43595,14 +43211,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: + - *254 - *255 - - *256 - - *294 + - *293 responses: '204': description: Response '403': *29 - '500': *41 + '500': *132 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43624,9 +43240,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: + - *254 - *255 - - *256 - - *294 + - *293 responses: '200': description: Response @@ -43686,7 +43302,7 @@ paths: items: type: object properties: - type: &415 + type: &414 type: string description: The type of reviewer. enum: @@ -43696,7 +43312,7 @@ paths: reviewer: anyOf: - *19 - - *181 + - *174 required: - environment - wait_timer @@ -43771,9 +43387,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: + - *254 - *255 - - *256 - - *294 + - *293 requestBody: required: true content: @@ -43820,7 +43436,7 @@ paths: application/json: schema: type: array - items: &410 + items: &409 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -43908,8 +43524,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 required: - id - node_id @@ -43926,7 +43542,7 @@ paths: - created_at - updated_at examples: - default: &411 + default: &410 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -43982,9 +43598,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: + - *254 - *255 - - *256 - - *294 + - *293 requestBody: required: false content: @@ -44005,7 +43621,7 @@ paths: description: Response content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -44028,9 +43644,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: + - *254 - *255 - - *256 - - *294 + - *293 requestBody: required: false content: @@ -44051,7 +43667,7 @@ paths: description: Response content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -44076,9 +43692,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: + - *254 - *255 - - *256 - - *294 + - *293 responses: '200': description: Response @@ -44215,8 +43831,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -44234,11 +43850,11 @@ paths: type: integer secrets: type: array - items: *301 + items: *300 examples: - default: *302 + default: *301 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44261,16 +43877,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: + - *254 - *255 - - *256 responses: '200': description: Response content: application/json: - schema: *303 + schema: *302 examples: - default: *304 + default: *303 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44292,17 +43908,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: + - *254 - *255 - - *256 - - *121 + - *114 responses: '200': description: Response content: application/json: - schema: *301 + schema: *300 examples: - default: &428 + default: &427 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -44328,9 +43944,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: + - *254 - *255 - - *256 - - *121 + - *114 requestBody: required: true content: @@ -44358,7 +43974,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -44384,9 +44000,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: + - *254 - *255 - - *256 - - *121 + - *114 responses: '204': description: Response @@ -44411,9 +44027,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: + - *254 - *255 - - *256 - - *277 + - *276 - *20 responses: '200': @@ -44430,11 +44046,11 @@ paths: type: integer variables: type: array - items: *305 + items: *304 examples: - default: *306 + default: *305 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44455,8 +44071,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -44483,7 +44099,7 @@ paths: description: Response content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -44508,17 +44124,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: + - *254 - *255 - - *256 - - *124 + - *117 responses: '200': description: Response content: application/json: - schema: *305 + schema: *304 examples: - default: &429 + default: &428 value: name: USERNAME value: octocat @@ -44544,9 +44160,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: + - *254 - *255 - - *256 - - *124 + - *117 requestBody: required: true content: @@ -44588,9 +44204,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: + - *254 - *255 - - *256 - - *124 + - *117 responses: '204': description: Response @@ -44615,8 +44231,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -44634,7 +44250,7 @@ paths: type: integer workflows: type: array - items: &307 + items: &306 title: Workflow description: A GitHub Actions workflow type: object @@ -44718,7 +44334,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: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44741,9 +44357,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: + - *254 - *255 - - *256 - - &308 + - &307 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -44758,7 +44374,7 @@ paths: description: Response content: application/json: - schema: *307 + schema: *306 examples: default: value: @@ -44791,9 +44407,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: + - *254 - *255 - - *256 - - *308 + - *307 responses: '204': description: Response @@ -44818,9 +44434,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: + - *254 - *255 - - *256 - - *308 + - *307 responses: '204': description: Response @@ -44871,9 +44487,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: + - *254 - *255 - - *256 - - *308 + - *307 responses: '204': description: Response @@ -44900,19 +44516,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: + - *254 - *255 - - *256 + - *307 - *308 - *309 - *310 - *311 - - *312 - *18 - *20 + - *312 + - *291 - *313 - - *292 - *314 - - *315 responses: '200': description: Response @@ -44928,11 +44544,11 @@ paths: type: integer workflow_runs: type: array - items: *293 + items: *292 examples: - default: *316 + default: *315 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44956,9 +44572,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: + - *254 - *255 - - *256 - - *308 + - *307 responses: '200': description: Response @@ -45019,12 +44635,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: + - *254 - *255 - - *256 - - *42 + - *39 - *18 - - *43 - - *44 + - *40 + - *41 - name: ref description: |- The Git reference for the activities you want to list. @@ -45165,7 +44781,7 @@ paths: type: User site_admin: false headers: - Link: *39 + Link: *51 '422': *8 x-github: githubCloudOnly: false @@ -45184,8 +44800,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -45197,9 +44813,9 @@ paths: type: array items: *19 examples: - default: *184 + default: *177 headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -45222,8 +44838,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: + - *254 - *255 - - *256 - name: assignee in: path required: true @@ -45259,8 +44875,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-attestation parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -45372,11 +44988,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-attestations parameters: + - *254 - *255 - - *256 - *18 - - *43 - - *44 + - *40 + - *41 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -45416,8 +45032,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: *317 + default: *316 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45437,8 +45055,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: + - *254 - *255 - - *256 responses: '200': description: Response @@ -45446,7 +45064,7 @@ paths: application/json: schema: type: array - items: &318 + items: &317 title: Autolink reference description: An autolink reference. type: object @@ -45496,8 +45114,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -45536,9 +45154,9 @@ paths: description: response content: application/json: - schema: *318 + schema: *317 examples: - default: &319 + default: &318 value: id: 1 key_prefix: TICKET- @@ -45569,9 +45187,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: + - *254 - *255 - - *256 - - &320 + - &319 name: autolink_id description: The unique identifier of the autolink. in: path @@ -45583,9 +45201,9 @@ paths: description: Response content: application/json: - schema: *318 + schema: *317 examples: - default: *319 + default: *318 '404': *7 x-github: githubCloudOnly: false @@ -45605,9 +45223,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: + - *254 - *255 - - *256 - - *320 + - *319 responses: '204': description: Response @@ -45631,8 +45249,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: + - *254 - *255 - - *256 responses: '200': description: Response if Dependabot is enabled @@ -45680,8 +45298,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-automated-security-fixes parameters: + - *254 - *255 - - *256 responses: '204': description: Response @@ -45702,8 +45320,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-automated-security-fixes parameters: + - *254 - *255 - - *256 responses: '204': description: Response @@ -45723,8 +45341,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: + - *254 - *255 - - *256 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -45762,7 +45380,7 @@ paths: - url protected: type: boolean - protection: &322 + protection: &321 title: Branch Protection description: Branch Protection type: object @@ -45804,7 +45422,7 @@ paths: required: - contexts - checks - enforce_admins: &325 + enforce_admins: &324 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -45819,7 +45437,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &327 + required_pull_request_reviews: &326 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -45840,7 +45458,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *181 + items: *174 apps: description: The list of apps with review dismissal access. @@ -45869,7 +45487,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *181 + items: *174 apps: description: The list of apps allowed to bypass pull request requirements. @@ -45895,7 +45513,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &324 + restrictions: &323 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -46184,7 +45802,7 @@ paths: - linter protection_url: https://api.github.com/repos/octocat/hello-world/branches/master/protection headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -46202,9 +45820,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: + - *254 - *255 - - *256 - - &323 + - &322 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). @@ -46218,14 +45836,14 @@ paths: description: Response content: application/json: - schema: &333 + schema: &332 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &383 + commit: &382 title: Commit description: Commit type: object @@ -46259,7 +45877,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &321 + properties: &320 name: type: string example: '"Chris Wanstrath"' @@ -46274,7 +45892,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *321 + properties: *320 nullable: true message: type: string @@ -46295,7 +45913,7 @@ paths: required: - sha - url - verification: &435 + verification: &434 title: Verification type: object properties: @@ -46328,12 +45946,12 @@ paths: nullable: true oneOf: - *19 - - *122 + - *115 committer: nullable: true oneOf: - *19 - - *122 + - *115 parents: type: array items: @@ -46364,7 +45982,7 @@ paths: type: integer files: type: array - items: &398 + items: &397 title: Diff Entry description: Diff Entry type: object @@ -46447,7 +46065,7 @@ paths: - self protected: type: boolean - protection: *322 + protection: *321 protection_url: type: string format: uri @@ -46554,7 +46172,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *267 + '301': *266 '404': *7 x-github: githubCloudOnly: false @@ -46576,15 +46194,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: + - *254 - *255 - - *256 - - *323 + - *322 responses: '200': description: Response content: application/json: - schema: *322 + schema: *321 examples: default: value: @@ -46778,9 +46396,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: + - *254 - *255 - - *256 - - *323 + - *322 requestBody: required: true content: @@ -47035,7 +46653,7 @@ paths: url: type: string format: uri - required_status_checks: &330 + required_status_checks: &329 title: Status Check Policy description: Status Check Policy type: object @@ -47111,7 +46729,7 @@ paths: items: *19 teams: type: array - items: *181 + items: *174 apps: type: array items: *6 @@ -47129,7 +46747,7 @@ paths: items: *19 teams: type: array - items: *181 + items: *174 apps: type: array items: *6 @@ -47187,7 +46805,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *324 + restrictions: *323 required_conversation_resolution: type: object properties: @@ -47299,9 +46917,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: + - *254 - *255 - - *256 - - *323 + - *322 responses: '204': description: Response @@ -47326,17 +46944,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: + - *254 - *255 - - *256 - - *323 + - *322 responses: '200': description: Response content: application/json: - schema: *325 + schema: *324 examples: - default: &326 + default: &325 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -47358,17 +46976,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: + - *254 - *255 - - *256 - - *323 + - *322 responses: '200': description: Response content: application/json: - schema: *325 + schema: *324 examples: - default: *326 + default: *325 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47387,9 +47005,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: + - *254 - *255 - - *256 - - *323 + - *322 responses: '204': description: Response @@ -47414,17 +47032,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: + - *254 - *255 - - *256 - - *323 + - *322 responses: '200': description: Response content: application/json: - schema: *327 + schema: *326 examples: - default: &328 + default: &327 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -47520,9 +47138,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: + - *254 - *255 - - *256 - - *323 + - *322 requestBody: required: false content: @@ -47620,9 +47238,9 @@ paths: description: Response content: application/json: - schema: *327 + schema: *326 examples: - default: *328 + default: *327 '422': *16 x-github: githubCloudOnly: false @@ -47643,9 +47261,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: + - *254 - *255 - - *256 - - *323 + - *322 responses: '204': description: Response @@ -47672,17 +47290,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: + - *254 - *255 - - *256 - - *323 + - *322 responses: '200': description: Response content: application/json: - schema: *325 + schema: *324 examples: - default: &329 + default: &328 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -47705,17 +47323,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: + - *254 - *255 - - *256 - - *323 + - *322 responses: '200': description: Response content: application/json: - schema: *325 + schema: *324 examples: - default: *329 + default: *328 '404': *7 x-github: githubCloudOnly: false @@ -47735,9 +47353,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: + - *254 - *255 - - *256 - - *323 + - *322 responses: '204': description: Response @@ -47762,17 +47380,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: + - *254 - *255 - - *256 - - *323 + - *322 responses: '200': description: Response content: application/json: - schema: *330 + schema: *329 examples: - default: &331 + default: &330 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -47798,9 +47416,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: + - *254 - *255 - - *256 - - *323 + - *322 requestBody: required: false content: @@ -47852,9 +47470,9 @@ paths: description: Response content: application/json: - schema: *330 + schema: *329 examples: - default: *331 + default: *330 '404': *7 '422': *16 x-github: @@ -47876,9 +47494,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: + - *254 - *255 - - *256 - - *323 + - *322 responses: '204': description: Response @@ -47902,9 +47520,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: + - *254 - *255 - - *256 - - *323 + - *322 responses: '200': description: Response @@ -47938,9 +47556,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: + - *254 - *255 - - *256 - - *323 + - *322 requestBody: required: false content: @@ -48007,9 +47625,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: + - *254 - *255 - - *256 - - *323 + - *322 requestBody: required: false content: @@ -48073,9 +47691,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: + - *254 - *255 - - *256 - - *323 + - *322 requestBody: content: application/json: @@ -48141,15 +47759,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: + - *254 - *255 - - *256 - - *323 + - *322 responses: '200': description: Response content: application/json: - schema: *324 + schema: *323 examples: default: value: @@ -48240,9 +47858,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: + - *254 - *255 - - *256 - - *323 + - *322 responses: '204': description: Response @@ -48265,9 +47883,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: + - *254 - *255 - - *256 - - *323 + - *322 responses: '200': description: Response @@ -48277,7 +47895,7 @@ paths: type: array items: *6 examples: - default: &332 + default: &331 value: - id: 1 slug: octoapp @@ -48334,9 +47952,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: + - *254 - *255 - - *256 - - *323 + - *322 requestBody: required: true content: @@ -48370,7 +47988,7 @@ paths: type: array items: *6 examples: - default: *332 + default: *331 '422': *16 x-github: githubCloudOnly: false @@ -48391,9 +48009,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: + - *254 - *255 - - *256 - - *323 + - *322 requestBody: required: true content: @@ -48427,7 +48045,7 @@ paths: type: array items: *6 examples: - default: *332 + default: *331 '422': *16 x-github: githubCloudOnly: false @@ -48448,9 +48066,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: + - *254 - *255 - - *256 - - *323 + - *322 requestBody: required: true content: @@ -48484,7 +48102,7 @@ paths: type: array items: *6 examples: - default: *332 + default: *331 '422': *16 x-github: githubCloudOnly: false @@ -48506,9 +48124,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: + - *254 - *255 - - *256 - - *323 + - *322 responses: '200': description: Response @@ -48516,9 +48134,9 @@ paths: application/json: schema: type: array - items: *181 + items: *174 examples: - default: *198 + default: *192 '404': *7 x-github: githubCloudOnly: false @@ -48538,9 +48156,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: + - *254 - *255 - - *256 - - *323 + - *322 requestBody: required: false content: @@ -48576,9 +48194,9 @@ paths: application/json: schema: type: array - items: *181 + items: *174 examples: - default: *198 + default: *192 '422': *16 x-github: githubCloudOnly: false @@ -48599,9 +48217,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: + - *254 - *255 - - *256 - - *323 + - *322 requestBody: required: false content: @@ -48637,9 +48255,9 @@ paths: application/json: schema: type: array - items: *181 + items: *174 examples: - default: *198 + default: *192 '422': *16 x-github: githubCloudOnly: false @@ -48660,9 +48278,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: + - *254 - *255 - - *256 - - *323 + - *322 requestBody: content: application/json: @@ -48697,9 +48315,9 @@ paths: application/json: schema: type: array - items: *181 + items: *174 examples: - default: *198 + default: *192 '422': *16 x-github: githubCloudOnly: false @@ -48721,9 +48339,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: + - *254 - *255 - - *256 - - *323 + - *322 responses: '200': description: Response @@ -48733,7 +48351,7 @@ paths: type: array items: *19 examples: - default: *184 + default: *177 '404': *7 x-github: githubCloudOnly: false @@ -48757,9 +48375,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: + - *254 - *255 - - *256 - - *323 + - *322 requestBody: required: true content: @@ -48792,7 +48410,7 @@ paths: type: array items: *19 examples: - default: *184 + default: *177 '422': *16 x-github: githubCloudOnly: false @@ -48817,9 +48435,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: + - *254 - *255 - - *256 - - *323 + - *322 requestBody: required: true content: @@ -48852,7 +48470,7 @@ paths: type: array items: *19 examples: - default: *184 + default: *177 '422': *16 x-github: githubCloudOnly: false @@ -48877,9 +48495,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: + - *254 - *255 - - *256 - - *323 + - *322 requestBody: required: true content: @@ -48912,7 +48530,7 @@ paths: type: array items: *19 examples: - default: *184 + default: *177 '422': *16 x-github: githubCloudOnly: false @@ -48939,9 +48557,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: + - *254 - *255 - - *256 - - *323 + - *322 requestBody: required: true content: @@ -48963,7 +48581,7 @@ paths: description: Response content: application/json: - schema: *333 + schema: *332 examples: default: value: @@ -49079,8 +48697,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -49359,7 +48977,7 @@ paths: description: Response content: application/json: - schema: &335 + schema: &334 title: CheckRun description: A check performed on the code of a given code change type: object @@ -49470,16 +49088,16 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 pull_requests: description: Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check. type: array - items: *334 - deployment: &623 + items: *333 + deployment: &622 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -49546,8 +49164,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 required: - id - node_id @@ -49759,9 +49377,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: + - *254 - *255 - - *256 - - &336 + - &335 name: check_run_id description: The unique identifier of the check run. in: path @@ -49773,9 +49391,9 @@ paths: description: Response content: application/json: - schema: *335 + schema: *334 examples: - default: &337 + default: &336 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -49875,9 +49493,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: + - *254 - *255 - - *256 - - *336 + - *335 requestBody: required: true content: @@ -50117,9 +49735,9 @@ paths: description: Response content: application/json: - schema: *335 + schema: *334 examples: - default: *337 + default: *336 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50139,9 +49757,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: + - *254 - *255 - - *256 - - *336 + - *335 - *18 - *20 responses: @@ -50216,7 +49834,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: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50238,15 +49856,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: + - *254 - *255 - - *256 - - *336 + - *335 responses: '201': description: Response content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -50284,8 +49902,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -50307,7 +49925,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &340 + schema: &339 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -50371,7 +49989,7 @@ paths: nullable: true pull_requests: type: array - items: *334 + items: *333 nullable: true app: title: GitHub app @@ -50382,9 +50000,9 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 - repository: *113 + properties: *54 + required: *55 + repository: *106 created_at: type: string format: date-time @@ -50393,12 +50011,12 @@ paths: type: string format: date-time nullable: true - head_commit: &649 + head_commit: &648 title: Simple Commit description: A commit. type: object - properties: *338 - required: *339 + properties: *337 + required: *338 latest_check_runs_count: type: integer check_runs_url: @@ -50426,7 +50044,7 @@ paths: - check_runs_url - pull_requests examples: - default: &341 + default: &340 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -50717,9 +50335,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *340 + schema: *339 examples: - default: *341 + default: *340 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50738,8 +50356,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -50800,7 +50418,7 @@ paths: required: - app_id - setting - repository: *113 + repository: *106 examples: default: value: @@ -51048,9 +50666,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: + - *254 - *255 - - *256 - - &342 + - &341 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -51062,9 +50680,9 @@ paths: description: Response content: application/json: - schema: *340 + schema: *339 examples: - default: *341 + default: *340 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51087,17 +50705,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: + - *254 - *255 - - *256 - - *342 - - &391 + - *341 + - &390 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &392 + - &391 name: status description: Returns check runs with the specified `status`. in: query @@ -51136,9 +50754,9 @@ paths: type: integer check_runs: type: array - items: *335 + items: *334 examples: - default: &393 + default: &392 value: total_count: 1 check_runs: @@ -51220,7 +50838,7 @@ paths: url: https://api.github.com/repos/github/hello-world name: hello-world headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51240,15 +50858,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: + - *254 - *255 - - *256 - - *342 + - *341 responses: '201': description: Response content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -51275,30 +50893,30 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: + - *254 - *255 - - *256 + - *342 - *343 - - *344 - *20 - *18 - - &357 + - &356 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: *345 - - &358 + schema: *344 + - &357 name: pr description: The number of the pull request for the results you want to list. in: query required: false schema: type: integer - - *42 - - *43 - - *44 + - *39 + - *40 + - *41 - name: sort description: The property by which to sort the results. in: query @@ -51314,13 +50932,13 @@ paths: be returned. in: query required: false - schema: *346 + schema: *345 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *347 + schema: *346 responses: '200': description: Response @@ -51331,14 +50949,14 @@ paths: items: type: object properties: - number: *48 - created_at: *49 - updated_at: *127 - url: *50 - html_url: *51 - instances_url: *348 - state: *132 - fixed_at: *128 + number: *46 + created_at: *47 + updated_at: *120 + url: *48 + html_url: *49 + instances_url: *347 + state: *125 + fixed_at: *121 dismissed_by: title: Simple User description: A GitHub user. @@ -51346,12 +50964,12 @@ paths: properties: *4 required: *5 nullable: true - dismissed_at: *129 - dismissed_reason: *349 - dismissed_comment: *350 - rule: *351 - tool: *352 - most_recent_instance: *353 + dismissed_at: *122 + dismissed_reason: *348 + dismissed_comment: *349 + rule: *350 + tool: *351 + most_recent_instance: *352 required: - number - created_at @@ -51467,14 +51085,14 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &354 + '403': &353 description: Response if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *7 - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51494,9 +51112,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: + - *254 - *255 - - *256 - - &355 + - &354 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -51504,23 +51122,23 @@ paths: field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. required: true - schema: *48 + schema: *46 responses: '200': description: Response content: application/json: - schema: &356 + schema: &355 type: object properties: - number: *48 - created_at: *49 - updated_at: *127 - url: *50 - html_url: *51 - instances_url: *348 - state: *132 - fixed_at: *128 + number: *46 + created_at: *47 + updated_at: *120 + url: *48 + html_url: *49 + instances_url: *347 + state: *125 + fixed_at: *121 dismissed_by: title: Simple User description: A GitHub user. @@ -51528,9 +51146,9 @@ paths: properties: *4 required: *5 nullable: true - dismissed_at: *129 - dismissed_reason: *349 - dismissed_comment: *350 + dismissed_at: *122 + dismissed_reason: *348 + dismissed_comment: *349 rule: type: object properties: @@ -51584,8 +51202,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *352 - most_recent_instance: *353 + tool: *351 + most_recent_instance: *352 required: - number - created_at @@ -51674,9 +51292,9 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *354 + '403': *353 '404': *7 - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51694,9 +51312,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: + - *254 - *255 - - *256 - - *355 + - *354 requestBody: required: true content: @@ -51711,8 +51329,8 @@ paths: enum: - open - dismissed - dismissed_reason: *349 - dismissed_comment: *350 + dismissed_reason: *348 + dismissed_comment: *349 required: - state examples: @@ -51727,7 +51345,7 @@ paths: description: Response content: application/json: - schema: *356 + schema: *355 examples: default: value: @@ -51802,14 +51420,14 @@ paths: classifications: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances - '403': &363 + '403': &362 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *7 - '503': *63 + '503': *58 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -51829,13 +51447,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: + - *254 - *255 - - *256 - - *355 + - *354 - *20 - *18 + - *356 - *357 - - *358 responses: '200': description: Response @@ -51843,7 +51461,7 @@ paths: application/json: schema: type: array - items: *353 + items: *352 examples: default: value: @@ -51882,9 +51500,9 @@ paths: end_column: 50 classifications: - source - '403': *354 + '403': *353 '404': *7 - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51916,29 +51534,29 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: + - *254 - *255 - - *256 + - *342 - *343 - - *344 - *20 - *18 - - *358 + - *357 - 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: *345 + schema: *344 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &361 + schema: &360 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 - - *42 + - *39 - name: sort description: The property by which to sort the results. in: query @@ -51955,23 +51573,23 @@ paths: application/json: schema: type: array - items: &362 + items: &361 type: object properties: - ref: *345 - commit_sha: &371 + ref: *344 + commit_sha: &370 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: *359 + analysis_key: *358 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *360 + category: *359 error: type: string example: error reading field xyz @@ -51995,8 +51613,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *361 - tool: *352 + sarif_id: *360 + tool: *351 deletable: type: boolean warning: @@ -52057,9 +51675,9 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *354 + '403': *353 '404': *7 - '503': *63 + '503': *58 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -52093,8 +51711,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: + - *254 - *255 - - *256 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -52107,7 +51725,7 @@ paths: description: Response content: application/json: - schema: *362 + schema: *361 examples: response: summary: application/json response @@ -52161,9 +51779,9 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *354 + '403': *353 '404': *7 - '503': *63 + '503': *58 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -52243,8 +51861,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: + - *254 - *255 - - *256 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -52297,9 +51915,9 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *15 - '403': *363 + '403': *362 '404': *7 - '503': *63 + '503': *58 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -52319,8 +51937,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: + - *254 - *255 - - *256 responses: '200': description: Response @@ -52328,7 +51946,7 @@ paths: application/json: schema: type: array - items: &364 + items: &363 title: CodeQL Database description: A CodeQL database. type: object @@ -52439,9 +52057,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': *354 + '403': *353 '404': *7 - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52468,8 +52086,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: + - *254 - *255 - - *256 - name: language in: path description: The language of the CodeQL database. @@ -52481,7 +52099,7 @@ paths: description: Response content: application/json: - schema: *364 + schema: *363 examples: default: value: @@ -52513,11 +52131,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': &400 + '302': &399 description: Found - '403': *354 + '403': *353 '404': *7 - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52537,8 +52155,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: + - *254 - *255 - - *256 - name: language in: path description: The language of the CodeQL database. @@ -52548,9 +52166,9 @@ paths: responses: '204': description: Response - '403': *363 + '403': *362 '404': *7 - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52576,8 +52194,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -52586,7 +52204,7 @@ paths: type: object additionalProperties: false properties: - language: &365 + language: &364 type: string description: The language targeted by the CodeQL query enum: @@ -52664,7 +52282,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &369 + schema: &368 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -52672,9 +52290,9 @@ paths: id: type: integer description: The ID of the variant analysis. - controller_repo: *52 + controller_repo: *50 actor: *19 - query_language: *365 + query_language: *364 query_pack_url: type: string description: The download url for the query pack. @@ -52721,7 +52339,7 @@ paths: items: type: object properties: - repository: &366 + repository: &365 title: Repository Identifier description: Repository Identifier type: object @@ -52757,7 +52375,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &370 + analysis_status: &369 type: string description: The new status of the CodeQL variant analysis repository task. @@ -52789,7 +52407,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &367 + access_mismatch_repos: &366 type: object properties: repository_count: @@ -52803,7 +52421,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: *366 + items: *365 required: - repository_count - repositories @@ -52825,8 +52443,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *367 - over_limit_repos: *367 + no_codeql_db_repos: *366 + over_limit_repos: *366 required: - access_mismatch_repos - not_found_repos @@ -52842,7 +52460,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &368 + value: &367 summary: Default response value: id: 1 @@ -52994,17 +52612,17 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *368 + value: *367 repository_lists: summary: Response for a successful variant analysis submission - value: *368 + value: *367 '404': *7 '422': description: Unable to process variant analysis submission content: application/json: schema: *3 - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53025,8 +52643,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: + - *254 - *255 - - *256 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -53038,11 +52656,11 @@ paths: description: Response content: application/json: - schema: *369 + schema: *368 examples: - default: *368 + default: *367 '404': *7 - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53063,7 +52681,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: - - *255 + - *254 - name: repo in: path description: The name of the controller repository. @@ -53097,8 +52715,8 @@ paths: schema: type: object properties: - repository: *52 - analysis_status: *370 + repository: *50 + analysis_status: *369 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -53202,7 +52820,7 @@ paths: source_location_prefix: "/" artifact_url: https://example.com '404': *7 - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53223,8 +52841,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: + - *254 - *255 - - *256 responses: '200': description: Response @@ -53285,9 +52903,9 @@ paths: query_suite: default updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *354 + '403': *353 '404': *7 - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53306,8 +52924,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -53363,7 +52981,7 @@ paths: description: Response content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -53388,7 +53006,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *363 + '403': *362 '404': *7 '409': description: Response if there is already a validation run in progress with @@ -53396,7 +53014,7 @@ paths: content: application/json: schema: *3 - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53453,8 +53071,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -53462,7 +53080,7 @@ paths: schema: type: object properties: - commit_sha: *371 + commit_sha: *370 ref: type: string description: |- @@ -53520,7 +53138,7 @@ paths: schema: type: object properties: - id: *361 + id: *360 url: type: string description: The REST API URL for checking the status of the upload. @@ -53534,11 +53152,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': *363 + '403': *362 '404': *7 '413': description: Payload Too Large if the sarif field is too large - '503': *63 + '503': *58 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -53557,8 +53175,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: + - *254 - *255 - - *256 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -53604,10 +53222,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': *354 + '403': *353 '404': description: Not Found if the sarif id does not match any upload - '503': *63 + '503': *58 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -53629,8 +53247,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: + - *254 - *255 - - *256 responses: '200': description: Response @@ -53654,7 +53272,7 @@ paths: - failed - updating - removed_by_enterprise - configuration: *133 + configuration: *126 examples: default: value: @@ -53683,7 +53301,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': *138 + '204': *131 '304': *37 '403': *29 '404': *7 @@ -53708,8 +53326,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: + - *254 - *255 - - *256 - 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 @@ -53829,8 +53447,8 @@ paths: parameters: - *18 - *20 + - *254 - *255 - - *256 responses: '200': description: Response @@ -53846,7 +53464,7 @@ paths: type: integer codespaces: type: array - items: *185 + items: *178 examples: default: value: @@ -54122,7 +53740,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': *41 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -54144,8 +53762,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -54208,22 +53826,22 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *185 + schema: *178 examples: - default: *372 + default: *371 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *185 + schema: *178 examples: - default: *372 + default: *371 '400': *15 '401': *25 '403': *29 '404': *7 - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54247,8 +53865,8 @@ paths: parameters: - *18 - *20 + - *254 - *255 - - *256 responses: '200': description: Response @@ -54288,7 +53906,7 @@ paths: - path: ".devcontainer.json" display_name: Default project configuration total_count: 3 - '500': *41 + '500': *132 '400': *15 '401': *25 '403': *29 @@ -54312,8 +53930,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: + - *254 - *255 - - *256 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -54348,14 +53966,14 @@ paths: type: integer machines: type: array - items: &580 + items: &579 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *373 - required: *374 + properties: *372 + required: *373 examples: - default: &581 + default: &580 value: total_count: 2 machines: @@ -54372,7 +53990,7 @@ paths: memory_in_bytes: 34359738368 cpus: 8 '304': *37 - '500': *41 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -54395,8 +54013,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: + - *254 - *255 - - *256 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -54480,8 +54098,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: + - *254 - *255 - - *256 - 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 @@ -54526,7 +54144,7 @@ paths: '403': *29 '404': *7 '422': *16 - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54547,8 +54165,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -54566,7 +54184,7 @@ paths: type: integer secrets: type: array - items: &378 + items: &377 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -54586,9 +54204,9 @@ paths: - created_at - updated_at examples: - default: *375 + default: *374 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54609,16 +54227,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: + - *254 - *255 - - *256 responses: '200': description: Response content: application/json: - schema: *376 + schema: *375 examples: - default: *377 + default: *376 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54638,17 +54256,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: + - *254 - *255 - - *256 - - *121 + - *114 responses: '200': description: Response content: application/json: - schema: *378 + schema: *377 examples: - default: *379 + default: *378 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54668,9 +54286,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: + - *254 - *255 - - *256 - - *121 + - *114 requestBody: required: true content: @@ -54698,7 +54316,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -54722,9 +54340,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: + - *254 - *255 - - *256 - - *121 + - *114 responses: '204': description: Response @@ -54752,8 +54370,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: + - *254 - *255 - - *256 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -54795,7 +54413,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &380 + properties: &379 login: type: string example: octocat @@ -54888,7 +54506,7 @@ paths: user_view_type: type: string example: public - required: &381 + required: &380 - avatar_url - events_url - followers_url @@ -54937,7 +54555,7 @@ paths: admin: false role_name: write headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -54962,9 +54580,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: + - *254 - *255 - - *256 - - *126 + - *119 responses: '204': description: Response if user is a collaborator @@ -55006,9 +54624,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: + - *254 - *255 - - *256 - - *126 + - *119 requestBody: required: false content: @@ -55034,7 +54652,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &448 + schema: &447 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -55045,7 +54663,7 @@ paths: example: 42 type: integer format: int64 - repository: *113 + repository: *106 invitee: title: Simple User description: A GitHub user. @@ -55256,9 +54874,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: + - *254 - *255 - - *256 - - *126 + - *119 responses: '204': description: No Content when collaborator was removed from the repository. @@ -55287,9 +54905,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: + - *254 - *255 - - *256 - - *126 + - *119 responses: '200': description: if user has admin permissions @@ -55309,8 +54927,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *380 - required: *381 + properties: *379 + required: *380 nullable: true required: - permission @@ -55365,8 +54983,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -55376,7 +54994,7 @@ paths: application/json: schema: type: array - items: &382 + items: &381 title: Commit Comment description: Commit Comment type: object @@ -55417,8 +55035,8 @@ paths: updated_at: type: string format: date-time - author_association: *61 - reactions: *62 + author_association: *56 + reactions: *57 required: - url - html_url @@ -55434,7 +55052,7 @@ paths: - created_at - updated_at examples: - default: &385 + default: &384 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -55468,7 +55086,7 @@ paths: updated_at: '2011-04-14T16:00:49Z' author_association: COLLABORATOR headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55493,17 +55111,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: + - *254 - *255 - - *256 - - *74 + - *69 responses: '200': description: Response content: application/json: - schema: *382 + schema: *381 examples: - default: &386 + default: &385 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -55560,9 +55178,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: + - *254 - *255 - - *256 - - *74 + - *69 requestBody: required: true content: @@ -55584,7 +55202,7 @@ paths: description: Response content: application/json: - schema: *382 + schema: *381 examples: default: value: @@ -55635,9 +55253,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: + - *254 - *255 - - *256 - - *74 + - *69 responses: '204': description: Response @@ -55658,9 +55276,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: + - *254 - *255 - - *256 - - *74 + - *69 - 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. @@ -55686,11 +55304,11 @@ paths: application/json: schema: type: array - items: *248 + items: *247 examples: - default: *250 + default: *249 headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -55709,9 +55327,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: + - *254 - *255 - - *256 - - *74 + - *69 requestBody: required: true content: @@ -55743,16 +55361,16 @@ paths: description: Reaction exists content: application/json: - schema: *248 + schema: *247 examples: - default: *249 + default: *248 '201': description: Reaction created content: application/json: - schema: *248 + schema: *247 examples: - default: *249 + default: *248 '422': *16 x-github: githubCloudOnly: false @@ -55774,10 +55392,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: + - *254 - *255 - - *256 - - *74 - - *251 + - *69 + - *250 responses: '204': description: Response @@ -55826,8 +55444,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: + - *254 - *255 - - *256 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -55883,9 +55501,9 @@ paths: application/json: schema: type: array - items: *383 + items: *382 examples: - default: &499 + default: &498 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -55955,11 +55573,11 @@ paths: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e headers: - Link: *39 - '500': *41 + Link: *51 + '500': *132 '400': *15 '404': *7 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55979,9 +55597,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: + - *254 - *255 - - *256 - - &384 + - &383 name: commit_sha description: The SHA of the commit. in: path @@ -56028,7 +55646,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc protected: false '422': *16 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56053,9 +55671,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: + - *254 - *255 - - *256 - - *384 + - *383 - *18 - *20 responses: @@ -56065,11 +55683,11 @@ paths: application/json: schema: type: array - items: *382 + items: *381 examples: - default: *385 + default: *384 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56095,9 +55713,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: + - *254 - *255 - - *256 - - *384 + - *383 requestBody: required: true content: @@ -56132,9 +55750,9 @@ paths: description: Response content: application/json: - schema: *382 + schema: *381 examples: - default: *386 + default: *385 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -56162,9 +55780,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: + - *254 - *255 - - *256 - - *384 + - *383 - *18 - *20 responses: @@ -56174,7 +55792,7 @@ paths: application/json: schema: type: array - items: &490 + items: &489 title: Pull Request Simple description: Pull Request Simple type: object @@ -56280,8 +55898,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *387 - required: *388 + properties: *386 + required: *387 nullable: true active_lock_reason: type: string @@ -56326,7 +55944,7 @@ paths: nullable: true requested_teams: type: array - items: *181 + items: *174 nullable: true head: type: object @@ -56335,7 +55953,7 @@ paths: type: string ref: type: string - repo: *58 + repo: *53 sha: type: string user: @@ -56358,7 +55976,7 @@ paths: type: string ref: type: string - repo: *58 + repo: *53 sha: type: string user: @@ -56377,7 +55995,7 @@ paths: _links: type: object properties: - comments: &389 + comments: &388 title: Link description: Hypermedia Link type: object @@ -56386,13 +56004,13 @@ paths: type: string required: - href - commits: *389 - statuses: *389 - html: *389 - issue: *389 - review_comments: *389 - review_comment: *389 - self: *389 + commits: *388 + statuses: *388 + html: *388 + issue: *388 + review_comments: *388 + review_comment: *388 + self: *388 required: - comments - commits @@ -56402,8 +56020,8 @@ paths: - review_comments - review_comment - self - author_association: *61 - auto_merge: &492 + author_association: *56 + auto_merge: &491 title: Auto merge description: The status of auto merging a pull request. type: object @@ -56466,7 +56084,7 @@ paths: - author_association - auto_merge examples: - default: &491 + default: &490 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -56945,8 +56563,8 @@ paths: auto_merge: draft: false headers: - Link: *39 - '409': *134 + Link: *51 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57003,11 +56621,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: + - *254 - *255 - - *256 - *20 - *18 - - &390 + - &389 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)" @@ -57022,9 +56640,9 @@ paths: description: Response content: application/json: - schema: *383 + schema: *382 examples: - default: &477 + default: &476 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -57110,9 +56728,9 @@ paths: ..... '422': *16 '404': *7 - '500': *41 - '503': *63 - '409': *134 + '500': *132 + '503': *58 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57137,11 +56755,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: + - *254 - *255 - - *256 + - *389 - *390 - *391 - - *392 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -57175,11 +56793,11 @@ paths: type: integer check_runs: type: array - items: *335 + items: *334 examples: - default: *393 + default: *392 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57202,9 +56820,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: + - *254 - *255 - - *256 - - *390 + - *389 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -57212,7 +56830,7 @@ paths: schema: type: integer example: 1 - - *391 + - *390 - *18 - *20 responses: @@ -57230,7 +56848,7 @@ paths: type: integer check_suites: type: array - items: *340 + items: *339 examples: default: value: @@ -57405,7 +57023,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: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57430,9 +57048,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: + - *254 - *255 - - *256 - - *390 + - *389 - *18 - *20 responses: @@ -57499,7 +57117,7 @@ paths: type: string total_count: type: integer - repository: *113 + repository: *106 commit_url: type: string format: uri @@ -57630,9 +57248,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: + - *254 - *255 - - *256 - - *390 + - *389 - *18 - *20 responses: @@ -57642,7 +57260,7 @@ paths: application/json: schema: type: array - items: &554 + items: &553 title: Status description: The status of a commit. type: object @@ -57722,8 +57340,8 @@ paths: type: User site_admin: false headers: - Link: *39 - '301': *267 + Link: *51 + '301': *266 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57751,8 +57369,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: + - *254 - *255 - - *256 responses: '200': description: Response @@ -57781,20 +57399,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *394 - required: *395 + properties: *393 + required: *394 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &396 + properties: &395 url: type: string format: uri html_url: type: string format: uri - required: &397 + required: &396 - url - html_url nullable: true @@ -57802,32 +57420,32 @@ paths: title: License Simple description: License Simple type: object - properties: *76 - required: *77 + properties: *71 + required: *72 nullable: true contributing: title: Community Health File type: object - properties: *396 - required: *397 + properties: *395 + required: *396 nullable: true readme: title: Community Health File type: object - properties: *396 - required: *397 + properties: *395 + required: *396 nullable: true issue_template: title: Community Health File type: object - properties: *396 - required: *397 + properties: *395 + required: *396 nullable: true pull_request_template: title: Community Health File type: object - properties: *396 - required: *397 + properties: *395 + required: *396 nullable: true required: - code_of_conduct @@ -57954,8 +57572,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: + - *254 - *255 - - *256 - *20 - *18 - name: basehead @@ -57998,8 +57616,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *383 - merge_base_commit: *383 + base_commit: *382 + merge_base_commit: *382 status: type: string enum: @@ -58019,10 +57637,10 @@ paths: example: 6 commits: type: array - items: *383 + items: *382 files: type: array - items: *398 + items: *397 required: - url - html_url @@ -58265,8 +57883,8 @@ paths: patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" '404': *7 - '500': *41 - '503': *63 + '500': *132 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58308,8 +57926,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: + - *254 - *255 - - *256 - name: path description: path parameter in: path @@ -58450,7 +58068,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &399 + response-if-content-is-a-file: &398 summary: Response if content is a file value: type: file @@ -58582,7 +58200,7 @@ paths: - size - type - url - - &504 + - &503 title: Content File description: Content File type: object @@ -58783,7 +58401,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *399 + response-if-content-is-a-file: *398 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -58852,7 +58470,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *7 '403': *29 - '302': *400 + '302': *399 '304': *37 x-github: githubCloudOnly: false @@ -58875,8 +58493,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: + - *254 - *255 - - *256 - name: path description: path parameter in: path @@ -58969,7 +58587,7 @@ paths: description: Response content: application/json: - schema: &401 + schema: &400 title: File Commit description: File Commit type: object @@ -59121,7 +58739,7 @@ paths: description: Response content: application/json: - schema: *401 + schema: *400 examples: example-for-creating-a-file: value: @@ -59175,7 +58793,7 @@ paths: schema: oneOf: - *3 - - &430 + - &429 description: Repository rule violation was detected type: object properties: @@ -59196,7 +58814,7 @@ paths: items: type: object properties: - placeholder_id: &546 + placeholder_id: &545 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -59228,8 +58846,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: + - *254 - *255 - - *256 - name: path description: path parameter in: path @@ -59290,7 +58908,7 @@ paths: description: Response content: application/json: - schema: *401 + schema: *400 examples: default: value: @@ -59324,8 +58942,8 @@ paths: verified_at: '422': *16 '404': *7 - '409': *134 - '503': *63 + '409': *127 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59345,8 +58963,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: + - *254 - *255 - - *256 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -59446,7 +59064,7 @@ paths: site_admin: false contributions: 32 headers: - Link: *39 + Link: *51 '204': description: Response if repository is empty '403': *29 @@ -59469,21 +59087,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: + - *254 - *255 - - *256 - - *143 - - *144 - - *145 - - *146 + - *136 + - *137 + - *138 + - *139 - name: manifest in: query description: A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. schema: type: string - - *147 - - *148 - - *42 + - *140 + - *141 + - *39 - name: page description: "**Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead." @@ -59500,10 +59118,10 @@ paths: schema: type: integer default: 30 - - *43 - - *44 - - *149 - - *150 + - *40 + - *41 + - *142 + - *143 responses: '200': description: Response @@ -59511,11 +59129,11 @@ paths: application/json: schema: type: array - items: &404 + items: &403 type: object description: A Dependabot alert. properties: - number: *48 + number: *46 state: type: string description: The state of the Dependabot alert. @@ -59530,7 +59148,7 @@ paths: description: Details for the vulnerable dependency. readOnly: true properties: - package: *45 + package: *42 manifest_path: type: string description: The full path to the dependency manifest file, @@ -59544,13 +59162,13 @@ paths: enum: - development - runtime - security_advisory: *402 - security_vulnerability: *47 - url: *50 - html_url: *51 - created_at: *49 - updated_at: *127 - dismissed_at: *129 + security_advisory: *401 + security_vulnerability: *44 + url: *48 + html_url: *49 + created_at: *47 + updated_at: *120 + dismissed_at: *122 dismissed_by: title: Simple User description: A GitHub user. @@ -59574,8 +59192,8 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: *128 - auto_dismissed_at: *403 + fixed_at: *121 + auto_dismissed_at: *402 required: - number - state @@ -59802,9 +59420,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: + - *254 - *255 - - *256 - - &405 + - &404 name: alert_number in: path description: |- @@ -59813,13 +59431,13 @@ paths: or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation. required: true - schema: *48 + schema: *46 responses: '200': description: Response content: application/json: - schema: *404 + schema: *403 examples: default: value: @@ -59929,9 +59547,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: + - *254 - *255 - - *256 - - *405 + - *404 requestBody: required: true content: @@ -59976,7 +59594,7 @@ paths: description: Response content: application/json: - schema: *404 + schema: *403 examples: default: value: @@ -60082,7 +59700,7 @@ paths: '400': *15 '403': *29 '404': *7 - '409': *134 + '409': *127 '422': *8 x-github: githubCloudOnly: false @@ -60105,8 +59723,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -60124,7 +59742,7 @@ paths: type: integer secrets: type: array - items: &408 + items: &407 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -60155,7 +59773,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60177,16 +59795,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: + - *254 - *255 - - *256 responses: '200': description: Response content: application/json: - schema: *406 + schema: *405 examples: - default: *407 + default: *406 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60206,15 +59824,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: + - *254 - *255 - - *256 - - *121 + - *114 responses: '200': description: Response content: application/json: - schema: *408 + schema: *407 examples: default: value: @@ -60240,9 +59858,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: + - *254 - *255 - - *256 - - *121 + - *114 requestBody: required: true content: @@ -60270,7 +59888,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -60294,9 +59912,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: + - *254 - *255 - - *256 - - *121 + - *114 responses: '204': description: Response @@ -60318,8 +59936,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: + - *254 - *255 - - *256 - 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 @@ -60455,7 +60073,7 @@ paths: advisory_summary: Ruby OpenID advisory_url: https://github.com/advisories/GHSA-fqfj-cmh6-hj49 headers: - Link: *39 + Link: *51 '404': *7 '403': description: Response if GitHub Advanced Security is not enabled for this @@ -60479,8 +60097,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: + - *254 - *255 - - *256 responses: '200': description: Response @@ -60696,7 +60314,7 @@ paths: spdxElementId: SPDXRef-DOCUMENT relatedSpdxElement: SPDXRef-Repository headers: - Link: *39 + Link: *51 '404': *7 '403': *29 x-github: @@ -60719,8 +60337,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: + - *254 - *255 - - *256 requestBody: required: true content: @@ -60795,7 +60413,7 @@ paths: - version - url additionalProperties: false - metadata: &409 + metadata: &408 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -60828,7 +60446,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *409 + metadata: *408 resolved: type: object description: A collection of resolved package dependencies. @@ -60841,7 +60459,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *409 + metadata: *408 relationship: type: string description: A notation of whether a dependency is requested @@ -60970,8 +60588,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: + - *254 - *255 - - *256 - name: sha description: The SHA recorded at creation time. in: query @@ -61011,11 +60629,11 @@ paths: application/json: schema: type: array - items: *410 + items: *409 examples: - default: *411 + default: *410 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61079,8 +60697,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -61161,7 +60779,7 @@ paths: description: Response content: application/json: - schema: *410 + schema: *409 examples: simple-example: summary: Simple example @@ -61234,9 +60852,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: + - *254 - *255 - - *256 - - &412 + - &411 name: deployment_id description: deployment_id parameter in: path @@ -61248,7 +60866,7 @@ paths: description: Response content: application/json: - schema: *410 + schema: *409 examples: default: value: @@ -61313,9 +60931,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: + - *254 - *255 - - *256 - - *412 + - *411 responses: '204': description: Response @@ -61337,9 +60955,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: + - *254 - *255 - - *256 - - *412 + - *411 - *18 - *20 responses: @@ -61349,7 +60967,7 @@ paths: application/json: schema: type: array - items: &413 + items: &412 title: Deployment Status description: The status of a deployment. type: object @@ -61440,8 +61058,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 required: - id - node_id @@ -61490,7 +61108,7 @@ paths: environment_url: https://test-branch.lab.acme.com log_url: https://example.com/deployment/42/output headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -61510,9 +61128,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: + - *254 - *255 - - *256 - - *412 + - *411 requestBody: required: true content: @@ -61587,9 +61205,9 @@ paths: description: Response content: application/json: - schema: *413 + schema: *412 examples: - default: &414 + default: &413 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -61645,9 +61263,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: + - *254 - *255 - - *256 - - *412 + - *411 - name: status_id in: path required: true @@ -61658,9 +61276,9 @@ paths: description: Response content: application/json: - schema: *413 + schema: *412 examples: - default: *414 + default: *413 '404': *7 x-github: githubCloudOnly: false @@ -61685,8 +61303,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -61743,8 +61361,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -61761,7 +61379,7 @@ paths: type: integer environments: type: array - items: &416 + items: &415 title: Environment description: Details of a deployment environment type: object @@ -61813,7 +61431,7 @@ paths: type: type: string example: wait_timer - wait_timer: &418 + wait_timer: &417 type: integer example: 30 description: The amount of time to delay a job after @@ -61850,11 +61468,11 @@ paths: items: type: object properties: - type: *415 + type: *414 reviewer: anyOf: - *19 - - *181 + - *174 required: - id - node_id @@ -61874,7 +61492,7 @@ paths: - id - node_id - type - deployment_branch_policy: &419 + deployment_branch_policy: &418 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -61990,9 +61608,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: + - *254 - *255 - - *256 - - &417 + - &416 name: environment_name in: path required: true @@ -62005,9 +61623,9 @@ paths: description: Response content: application/json: - schema: *416 + schema: *415 examples: - default: &420 + default: &419 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -62091,9 +61709,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: + - *254 - *255 - - *256 - - *417 + - *416 requestBody: required: false content: @@ -62102,7 +61720,7 @@ paths: type: object nullable: true properties: - wait_timer: *418 + wait_timer: *417 prevent_self_review: type: boolean example: false @@ -62119,13 +61737,13 @@ paths: items: type: object properties: - type: *415 + type: *414 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *419 + deployment_branch_policy: *418 additionalProperties: false examples: default: @@ -62145,9 +61763,9 @@ paths: description: Response content: application/json: - schema: *416 + schema: *415 examples: - default: *420 + default: *419 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -62171,9 +61789,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: + - *254 - *255 - - *256 - - *417 + - *416 responses: '204': description: Default response @@ -62198,9 +61816,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: + - *254 - *255 - - *256 - - *417 + - *416 - *18 - *20 responses: @@ -62218,7 +61836,7 @@ paths: example: 2 branch_policies: type: array - items: &421 + items: &420 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -62275,9 +61893,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: + - *254 - *255 - - *256 - - *417 + - *416 requestBody: required: true content: @@ -62323,9 +61941,9 @@ paths: description: Response content: application/json: - schema: *421 + schema: *420 examples: - example-wildcard: &422 + example-wildcard: &421 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -62367,10 +61985,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: + - *254 - *255 - - *256 - - *417 - - &423 + - *416 + - &422 name: branch_policy_id in: path required: true @@ -62382,9 +62000,9 @@ paths: description: Response content: application/json: - schema: *421 + schema: *420 examples: - default: *422 + default: *421 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62403,10 +62021,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: + - *254 - *255 - - *256 - - *417 - - *423 + - *416 + - *422 requestBody: required: true content: @@ -62434,9 +62052,9 @@ paths: description: Response content: application/json: - schema: *421 + schema: *420 examples: - default: *422 + default: *421 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62455,10 +62073,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: + - *254 - *255 - - *256 - - *417 - - *423 + - *416 + - *422 responses: '204': description: Response @@ -62483,9 +62101,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *417 - - *256 + - *416 - *255 + - *254 responses: '200': description: List of deployment protection rules @@ -62501,7 +62119,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &424 + items: &423 title: Deployment protection rule description: Deployment protection rule type: object @@ -62520,7 +62138,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &425 + app: &424 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -62619,9 +62237,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: - - *417 - - *256 + - *416 - *255 + - *254 requestBody: content: application/json: @@ -62642,9 +62260,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *424 + schema: *423 examples: - default: &426 + default: &425 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -62679,9 +62297,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: - - *417 - - *256 + - *416 - *255 + - *254 - *20 - *18 responses: @@ -62700,7 +62318,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *425 + items: *424 examples: default: value: @@ -62735,10 +62353,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: + - *254 - *255 - - *256 - - *417 - - &427 + - *416 + - &426 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -62750,9 +62368,9 @@ paths: description: Response content: application/json: - schema: *424 + schema: *423 examples: - default: *426 + default: *425 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62773,10 +62391,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *417 - - *256 + - *416 - *255 - - *427 + - *254 + - *426 responses: '204': description: Response @@ -62802,9 +62420,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: + - *254 - *255 - - *256 - - *417 + - *416 - *18 - *20 responses: @@ -62822,11 +62440,11 @@ paths: type: integer secrets: type: array - items: *301 + items: *300 examples: - default: *302 + default: *301 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62849,17 +62467,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: + - *254 - *255 - - *256 - - *417 + - *416 responses: '200': description: Response content: application/json: - schema: *303 + schema: *302 examples: - default: *304 + default: *303 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62881,18 +62499,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: + - *254 - *255 - - *256 - - *417 - - *121 + - *416 + - *114 responses: '200': description: Response content: application/json: - schema: *301 + schema: *300 examples: - default: *428 + default: *427 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62914,10 +62532,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: + - *254 - *255 - - *256 - - *417 - - *121 + - *416 + - *114 requestBody: required: true content: @@ -62948,7 +62566,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -62974,10 +62592,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: + - *254 - *255 - - *256 - - *417 - - *121 + - *416 + - *114 responses: '204': description: Default response @@ -63002,10 +62620,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: + - *254 - *255 - - *256 - - *417 - - *277 + - *416 + - *276 - *20 responses: '200': @@ -63022,11 +62640,11 @@ paths: type: integer variables: type: array - items: *305 + items: *304 examples: - default: *306 + default: *305 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63047,9 +62665,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: + - *254 - *255 - - *256 - - *417 + - *416 requestBody: required: true content: @@ -63076,7 +62694,7 @@ paths: description: Response content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -63101,18 +62719,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: + - *254 - *255 - - *256 - - *417 - - *124 + - *416 + - *117 responses: '200': description: Response content: application/json: - schema: *305 + schema: *304 examples: - default: *429 + default: *428 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63133,10 +62751,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: + - *254 - *255 - - *256 - - *124 - - *417 + - *117 + - *416 requestBody: required: true content: @@ -63178,10 +62796,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: + - *254 - *255 - - *256 - - *124 - - *417 + - *117 + - *416 responses: '204': description: Response @@ -63203,8 +62821,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -63214,7 +62832,7 @@ paths: application/json: schema: type: array - items: *87 + items: *82 examples: 200-response: value: @@ -63281,8 +62899,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: + - *254 - *255 - - *256 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -63304,7 +62922,7 @@ paths: application/json: schema: type: array - items: *113 + items: *106 examples: default: value: @@ -63417,7 +63035,7 @@ paths: url: https://api.github.com/licenses/mit node_id: MDc6TGljZW5zZW1pdA== headers: - Link: *39 + Link: *51 '400': *15 x-github: githubCloudOnly: false @@ -63441,8 +63059,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: + - *254 - *255 - - *256 requestBody: required: false content: @@ -63474,9 +63092,9 @@ paths: description: Response content: application/json: - schema: *266 + schema: *265 examples: - default: *268 + default: *267 '400': *15 '422': *16 '403': *29 @@ -63497,8 +63115,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -63549,7 +63167,7 @@ paths: schema: type: string '404': *7 - '409': *134 + '409': *127 '403': *29 '422': description: Validation failed @@ -63557,8 +63175,8 @@ paths: application/json: schema: oneOf: - - *97 - - *430 + - *90 + - *429 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63583,8 +63201,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: + - *254 - *255 - - *256 - name: file_sha in: path required: true @@ -63635,7 +63253,7 @@ paths: '404': *7 '422': *16 '403': *29 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63683,8 +63301,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -63793,7 +63411,7 @@ paths: description: Response content: application/json: - schema: &431 + schema: &430 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -63956,7 +63574,7 @@ paths: type: string '422': *16 '404': *7 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64006,15 +63624,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: + - *254 - *255 - - *256 - - *384 + - *383 responses: '200': description: Response content: application/json: - schema: *431 + schema: *430 examples: default: value: @@ -64045,7 +63663,7 @@ paths: payload: verified_at: '404': *7 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64070,9 +63688,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: + - *254 - *255 - - *256 - - &432 + - &431 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. @@ -64089,7 +63707,7 @@ paths: application/json: schema: type: array - items: &433 + items: &432 title: Git Reference description: Git references within a repository type: object @@ -64142,8 +63760,8 @@ paths: sha: 612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: - Link: *39 - '409': *134 + Link: *51 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64164,17 +63782,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: + - *254 - *255 - - *256 - - *432 + - *431 responses: '200': description: Response content: application/json: - schema: *433 + schema: *432 examples: - default: &434 + default: &433 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -64184,7 +63802,7 @@ paths: sha: aa218f56b14c9653891f9e74264a383fa43fefbd url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd '404': *7 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64203,8 +63821,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -64233,16 +63851,16 @@ paths: description: Response content: application/json: - schema: *433 + schema: *432 examples: - default: *434 + default: *433 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA schema: type: string '422': *16 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64261,9 +63879,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: + - *254 - *255 - - *256 - - *432 + - *431 requestBody: required: true content: @@ -64292,11 +63910,11 @@ paths: description: Response content: application/json: - schema: *433 + schema: *432 examples: - default: *434 + default: *433 '422': *16 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64312,14 +63930,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: + - *254 - *255 - - *256 - - *432 + - *431 responses: '204': description: Response '422': *16 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64367,8 +63985,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -64435,7 +64053,7 @@ paths: description: Response content: application/json: - schema: &436 + schema: &435 title: Git Tag description: Metadata for a Git tag type: object @@ -64486,7 +64104,7 @@ paths: - sha - type - url - verification: *435 + verification: *434 required: - sha - url @@ -64496,7 +64114,7 @@ paths: - tag - message examples: - default: &437 + default: &436 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -64523,7 +64141,7 @@ paths: schema: type: string '422': *16 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64569,8 +64187,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: + - *254 - *255 - - *256 - name: tag_sha in: path required: true @@ -64581,11 +64199,11 @@ paths: description: Response content: application/json: - schema: *436 + schema: *435 examples: - default: *437 + default: *436 '404': *7 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64607,8 +64225,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -64681,7 +64299,7 @@ paths: description: Response content: application/json: - schema: &438 + schema: &437 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -64770,7 +64388,7 @@ paths: '422': *16 '404': *7 '403': *29 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64793,8 +64411,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: + - *254 - *255 - - *256 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -64817,7 +64435,7 @@ paths: description: Response content: application/json: - schema: *438 + schema: *437 examples: default-response: summary: Default response @@ -64858,7 +64476,7 @@ paths: truncated: false '422': *16 '404': *7 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64876,8 +64494,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -64887,7 +64505,7 @@ paths: application/json: schema: type: array - items: &439 + items: &438 title: Webhook description: Webhooks for repositories. type: object @@ -64941,7 +64559,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &657 + last_response: &656 title: Hook Response type: object properties: @@ -64996,7 +64614,7 @@ paths: status: unused message: headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -65015,8 +64633,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: + - *254 - *255 - - *256 requestBody: required: false content: @@ -65068,9 +64686,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *438 examples: - default: &440 + default: &439 value: type: Repository id: 12345678 @@ -65118,17 +64736,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: + - *254 - *255 - - *256 - - *158 + - *151 responses: '200': description: Response content: application/json: - schema: *439 + schema: *438 examples: - default: *440 + default: *439 '404': *7 x-github: githubCloudOnly: false @@ -65148,9 +64766,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: + - *254 - *255 - - *256 - - *158 + - *151 requestBody: required: true content: @@ -65195,9 +64813,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *438 examples: - default: *440 + default: *439 '422': *16 '404': *7 x-github: @@ -65218,9 +64836,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: + - *254 - *255 - - *256 - - *158 + - *151 responses: '204': description: Response @@ -65244,9 +64862,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: + - *254 - *255 - - *256 - - *158 + - *151 responses: '200': description: Response @@ -65273,9 +64891,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: + - *254 - *255 - - *256 - - *158 + - *151 requestBody: required: false content: @@ -65319,11 +64937,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: + - *254 - *255 - - *256 - - *158 + - *151 - *18 - - *159 + - *152 responses: '200': description: Response @@ -65331,9 +64949,9 @@ paths: application/json: schema: type: array - items: *160 + items: *153 examples: - default: *161 + default: *154 '400': *15 '422': *16 x-github: @@ -65352,18 +64970,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: + - *254 - *255 - - *256 - - *158 + - *151 - *17 responses: '200': description: Response content: application/json: - schema: *162 + schema: *155 examples: - default: *163 + default: *156 '400': *15 '422': *16 x-github: @@ -65382,12 +65000,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: + - *254 - *255 - - *256 - - *158 + - *151 - *17 responses: - '202': *99 + '202': *92 '400': *15 '422': *16 x-github: @@ -65407,9 +65025,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: + - *254 - *255 - - *256 - - *158 + - *151 responses: '204': description: Response @@ -65434,9 +65052,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: + - *254 - *255 - - *256 - - *158 + - *151 responses: '204': description: Response @@ -65494,14 +65112,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: + - *254 - *255 - - *256 responses: '200': description: Response content: application/json: - schema: &441 + schema: &440 title: Import description: A repository import from an external source. type: object @@ -65600,7 +65218,7 @@ paths: - html_url - authors_url examples: - default: &444 + default: &443 value: vcs: subversion use_lfs: true @@ -65616,7 +65234,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *7 - '503': &442 + '503': &441 description: Unavailable due to service under maintenance. content: application/json: @@ -65645,8 +65263,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -65694,7 +65312,7 @@ paths: description: Response content: application/json: - schema: *441 + schema: *440 examples: default: value: @@ -65719,7 +65337,7 @@ paths: type: string '422': *16 '404': *7 - '503': *442 + '503': *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65747,8 +65365,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: + - *254 - *255 - - *256 requestBody: required: false content: @@ -65797,7 +65415,7 @@ paths: description: Response content: application/json: - schema: *441 + schema: *440 examples: example-1: summary: Example 1 @@ -65845,7 +65463,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': *442 + '503': *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65868,12 +65486,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: + - *254 - *255 - - *256 responses: '204': description: Response - '503': *442 + '503': *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65899,9 +65517,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: + - *254 - *255 - - *256 - - &604 + - &603 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -65915,7 +65533,7 @@ paths: application/json: schema: type: array - items: &443 + items: &442 title: Porter Author description: Porter Author type: object @@ -65969,7 +65587,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *7 - '503': *442 + '503': *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65994,8 +65612,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: + - *254 - *255 - - *256 - name: author_id in: path required: true @@ -66025,7 +65643,7 @@ paths: description: Response content: application/json: - schema: *443 + schema: *442 examples: default: value: @@ -66038,7 +65656,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *16 '404': *7 - '503': *442 + '503': *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66062,8 +65680,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: + - *254 - *255 - - *256 responses: '200': description: Response @@ -66104,7 +65722,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *442 + '503': *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66132,8 +65750,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -66160,11 +65778,11 @@ paths: description: Response content: application/json: - schema: *441 + schema: *440 examples: - default: *444 + default: *443 '422': *16 - '503': *442 + '503': *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66187,8 +65805,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: + - *254 - *255 - - *256 responses: '200': description: Response @@ -66196,8 +65814,8 @@ paths: application/json: schema: *22 examples: - default: *445 - '301': *267 + default: *444 + '301': *266 '404': *7 x-github: githubCloudOnly: false @@ -66217,8 +65835,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: + - *254 - *255 - - *256 responses: '200': description: Response @@ -66226,12 +65844,12 @@ paths: application/json: schema: anyOf: - - *176 + - *169 - type: object properties: {} additionalProperties: false examples: - default: &447 + default: &446 value: limit: collaborators_only origin: repository @@ -66256,13 +65874,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: + - *254 - *255 - - *256 requestBody: required: true content: application/json: - schema: *446 + schema: *445 examples: default: summary: Example request body @@ -66274,9 +65892,9 @@ paths: description: Response content: application/json: - schema: *176 + schema: *169 examples: - default: *447 + default: *446 '409': description: Response x-github: @@ -66298,8 +65916,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: + - *254 - *255 - - *256 responses: '204': description: Response @@ -66322,8 +65940,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -66333,9 +65951,9 @@ paths: application/json: schema: type: array - items: *448 + items: *447 examples: - default: &597 + default: &596 value: - id: 1 repository: @@ -66449,7 +66067,7 @@ paths: html_url: https://github.com/octocat/Hello-World/invitations node_id: MDQ6VXNlcjE= headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66466,9 +66084,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: + - *254 - *255 - - *256 - - *180 + - *173 requestBody: required: false content: @@ -66497,7 +66115,7 @@ paths: description: Response content: application/json: - schema: *448 + schema: *447 examples: default: value: @@ -66628,9 +66246,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: + - *254 - *255 - - *256 - - *180 + - *173 responses: '204': description: Response @@ -66661,8 +66279,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: + - *254 - *255 - - *256 - 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 @@ -66702,7 +66320,7 @@ paths: required: false schema: type: string - - *182 + - *175 - name: sort description: What to sort results by. in: query @@ -66714,8 +66332,8 @@ paths: - updated - comments default: created - - *42 - - *65 + - *39 + - *60 - *18 - *20 responses: @@ -66725,9 +66343,9 @@ paths: application/json: schema: type: array - items: *75 + items: *70 examples: - default: &459 + default: &458 value: - id: 1 node_id: MDU6SXNzdWUx @@ -66874,8 +66492,8 @@ paths: author_association: COLLABORATOR state_reason: completed headers: - Link: *39 - '301': *267 + Link: *51 + '301': *266 '422': *16 '404': *7 x-github: @@ -66904,8 +66522,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -66980,9 +66598,9 @@ paths: description: Response content: application/json: - schema: *75 + schema: *70 examples: - default: &454 + default: &453 value: id: 1 node_id: MDU6SXNzdWUx @@ -67136,9 +66754,9 @@ paths: '400': *15 '403': *29 '422': *16 - '503': *63 + '503': *58 '404': *7 - '410': *264 + '410': *263 x-github: triggersNotification: true githubCloudOnly: false @@ -67166,9 +66784,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: + - *254 - *255 - - *256 - - *85 + - *80 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -67178,7 +66796,7 @@ paths: enum: - asc - desc - - *65 + - *60 - *18 - *20 responses: @@ -67188,9 +66806,9 @@ paths: application/json: schema: type: array - items: *449 + items: *448 examples: - default: &456 + default: &455 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -67221,7 +66839,7 @@ paths: issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 author_association: COLLABORATOR headers: - Link: *39 + Link: *51 '422': *16 '404': *7 x-github: @@ -67248,17 +66866,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: + - *254 - *255 - - *256 - - *74 + - *69 responses: '200': description: Response content: application/json: - schema: *449 + schema: *448 examples: - default: &450 + default: &449 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -67312,9 +66930,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: + - *254 - *255 - - *256 - - *74 + - *69 requestBody: required: true content: @@ -67336,9 +66954,9 @@ paths: description: Response content: application/json: - schema: *449 + schema: *448 examples: - default: *450 + default: *449 '422': *16 x-github: githubCloudOnly: false @@ -67356,9 +66974,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: + - *254 - *255 - - *256 - - *74 + - *69 responses: '204': description: Response @@ -67378,9 +66996,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: + - *254 - *255 - - *256 - - *74 + - *69 - 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. @@ -67406,11 +67024,11 @@ paths: application/json: schema: type: array - items: *248 + items: *247 examples: - default: *250 + default: *249 headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -67429,9 +67047,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: + - *254 - *255 - - *256 - - *74 + - *69 requestBody: required: true content: @@ -67463,16 +67081,16 @@ paths: description: Reaction exists content: application/json: - schema: *248 + schema: *247 examples: - default: *249 + default: *248 '201': description: Reaction created content: application/json: - schema: *248 + schema: *247 examples: - default: *249 + default: *248 '422': *16 x-github: githubCloudOnly: false @@ -67494,10 +67112,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: + - *254 - *255 - - *256 - - *74 - - *251 + - *69 + - *250 responses: '204': description: Response @@ -67517,8 +67135,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -67528,7 +67146,7 @@ paths: application/json: schema: type: array - items: &453 + items: &452 title: Issue Event description: Issue Event type: object @@ -67571,8 +67189,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *451 - required: *452 + properties: *450 + required: *451 nullable: true label: title: Issue Event Label @@ -67616,7 +67234,7 @@ paths: properties: *4 required: *5 nullable: true - requested_team: *181 + requested_team: *174 dismissed_review: title: Issue Event Dismissed Review type: object @@ -67681,7 +67299,7 @@ paths: required: - from - to - author_association: *61 + author_association: *56 lock_reason: type: string nullable: true @@ -67694,8 +67312,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 required: - id - node_id @@ -67861,7 +67479,7 @@ paths: author_association: COLLABORATOR state_reason: completed headers: - Link: *39 + Link: *51 '422': *16 x-github: githubCloudOnly: false @@ -67879,8 +67497,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: + - *254 - *255 - - *256 - name: event_id in: path required: true @@ -67891,7 +67509,7 @@ paths: description: Response content: application/json: - schema: *453 + schema: *452 examples: default: value: @@ -68084,7 +67702,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *7 - '410': *264 + '410': *263 '403': *29 x-github: githubCloudOnly: false @@ -68118,9 +67736,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: + - *254 - *255 - - *256 - - &455 + - &454 name: issue_number description: The number that identifies the issue. in: path @@ -68132,12 +67750,12 @@ paths: description: Response content: application/json: - schema: *75 + schema: *70 examples: - default: *454 - '301': *267 + default: *453 + '301': *266 '404': *7 - '410': *264 + '410': *263 '304': *37 x-github: githubCloudOnly: false @@ -68162,9 +67780,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: + - *254 - *255 - - *256 - - *455 + - *454 requestBody: required: false content: @@ -68259,15 +67877,15 @@ paths: description: Response content: application/json: - schema: *75 + schema: *70 examples: - default: *454 + default: *453 '422': *16 - '503': *63 + '503': *58 '403': *29 - '301': *267 + '301': *266 '404': *7 - '410': *264 + '410': *263 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68285,9 +67903,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: + - *254 - *255 - - *256 - - *455 + - *454 requestBody: required: false content: @@ -68313,9 +67931,9 @@ paths: description: Response content: application/json: - schema: *75 + schema: *70 examples: - default: *454 + default: *453 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68331,9 +67949,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: + - *254 - *255 - - *256 - - *455 + - *454 requestBody: content: application/json: @@ -68358,9 +67976,9 @@ paths: description: Response content: application/json: - schema: *75 + schema: *70 examples: - default: *454 + default: *453 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68382,9 +68000,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: + - *254 - *255 - - *256 - - *455 + - *454 - name: assignee in: path required: true @@ -68424,10 +68042,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: + - *254 - *255 - - *256 - - *455 - - *65 + - *454 + - *60 - *18 - *20 responses: @@ -68437,13 +68055,13 @@ paths: application/json: schema: type: array - items: *449 + items: *448 examples: - default: *456 + default: *455 headers: - Link: *39 + Link: *51 '404': *7 - '410': *264 + '410': *263 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68472,9 +68090,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: + - *254 - *255 - - *256 - - *455 + - *454 requestBody: required: true content: @@ -68496,16 +68114,16 @@ paths: description: Response content: application/json: - schema: *449 + schema: *448 examples: - default: *450 + default: *449 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *264 + '410': *263 '422': *16 '404': *7 x-github: @@ -68525,9 +68143,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: + - *254 - *255 - - *256 - - *455 + - *454 - *18 - *20 responses: @@ -68541,7 +68159,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &460 + - &459 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -68572,8 +68190,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 label: type: object properties: @@ -68595,7 +68213,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &461 + - &460 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -68626,8 +68244,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 label: type: object properties: @@ -68715,8 +68333,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 assignee: *19 assigner: *19 required: @@ -68731,7 +68349,7 @@ paths: - performed_via_github_app - assignee - assigner - - &462 + - &461 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -68762,8 +68380,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 milestone: type: object properties: @@ -68782,7 +68400,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &463 + - &462 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -68813,8 +68431,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 milestone: type: object properties: @@ -68833,7 +68451,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &464 + - &463 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -68864,8 +68482,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 rename: type: object properties: @@ -68887,7 +68505,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &465 + - &464 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -68918,10 +68536,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 review_requester: *19 - requested_team: *181 + requested_team: *174 requested_reviewer: *19 required: - review_requester @@ -68934,7 +68552,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &466 + - &465 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -68965,10 +68583,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 review_requester: *19 - requested_team: *181 + requested_team: *174 requested_reviewer: *19 required: - review_requester @@ -68981,7 +68599,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &467 + - &466 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -69012,8 +68630,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 dismissed_review: type: object properties: @@ -69041,7 +68659,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &468 + - &467 title: Locked Issue Event description: Locked Issue Event type: object @@ -69072,8 +68690,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 lock_reason: type: string example: '"off-topic"' @@ -69089,7 +68707,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &469 + - &468 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -69120,8 +68738,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 project_card: type: object properties: @@ -69155,7 +68773,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &470 + - &469 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -69186,8 +68804,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 project_card: type: object properties: @@ -69221,7 +68839,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &471 + - &470 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -69252,8 +68870,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 project_card: type: object properties: @@ -69287,7 +68905,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &472 + - &471 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -69377,8 +68995,8 @@ paths: name: label color: red headers: - Link: *39 - '410': *264 + Link: *51 + '410': *263 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69395,9 +69013,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: + - *254 - *255 - - *256 - - *455 + - *454 - *18 - *20 responses: @@ -69407,7 +69025,7 @@ paths: application/json: schema: type: array - items: &457 + items: &456 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -69454,7 +69072,7 @@ paths: - color - default examples: - default: &458 + default: &457 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -69471,10 +69089,10 @@ paths: color: a2eeef default: false headers: - Link: *39 - '301': *267 + Link: *51 + '301': *266 '404': *7 - '410': *264 + '410': *263 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69491,9 +69109,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: + - *254 - *255 - - *256 - - *455 + - *454 requestBody: required: false content: @@ -69552,12 +69170,12 @@ paths: application/json: schema: type: array - items: *457 + items: *456 examples: - default: *458 - '301': *267 + default: *457 + '301': *266 '404': *7 - '410': *264 + '410': *263 '422': *16 x-github: githubCloudOnly: false @@ -69574,9 +69192,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: + - *254 - *255 - - *256 - - *455 + - *454 requestBody: required: false content: @@ -69636,12 +69254,12 @@ paths: application/json: schema: type: array - items: *457 + items: *456 examples: - default: *458 - '301': *267 + default: *457 + '301': *266 '404': *7 - '410': *264 + '410': *263 '422': *16 x-github: githubCloudOnly: false @@ -69658,15 +69276,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: + - *254 - *255 - - *256 - - *455 + - *454 responses: '204': description: Response - '301': *267 + '301': *266 '404': *7 - '410': *264 + '410': *263 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69685,9 +69303,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: + - *254 - *255 - - *256 - - *455 + - *454 - name: name in: path required: true @@ -69700,7 +69318,7 @@ paths: application/json: schema: type: array - items: *457 + items: *456 examples: default: value: @@ -69711,9 +69329,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *267 + '301': *266 '404': *7 - '410': *264 + '410': *263 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69733,9 +69351,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: + - *254 - *255 - - *256 - - *455 + - *454 requestBody: required: false content: @@ -69763,7 +69381,7 @@ paths: '204': description: Response '403': *29 - '410': *264 + '410': *263 '404': *7 '422': *16 x-github: @@ -69781,9 +69399,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: + - *254 - *255 - - *256 - - *455 + - *454 responses: '204': description: Response @@ -69805,9 +69423,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: + - *254 - *255 - - *256 - - *455 + - *454 - 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. @@ -69833,13 +69451,13 @@ paths: application/json: schema: type: array - items: *248 + items: *247 examples: - default: *250 + default: *249 headers: - Link: *39 + Link: *51 '404': *7 - '410': *264 + '410': *263 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69857,9 +69475,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: + - *254 - *255 - - *256 - - *455 + - *454 requestBody: required: true content: @@ -69891,16 +69509,16 @@ paths: description: Response content: application/json: - schema: *248 + schema: *247 examples: - default: *249 + default: *248 '201': description: Response content: application/json: - schema: *248 + schema: *247 examples: - default: *249 + default: *248 '422': *16 x-github: githubCloudOnly: false @@ -69922,10 +69540,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: + - *254 - *255 - - *256 - - *455 - - *251 + - *454 + - *250 responses: '204': description: Response @@ -69954,9 +69572,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue parameters: + - *254 - *255 - - *256 - - *455 + - *454 requestBody: required: true content: @@ -69978,9 +69596,9 @@ paths: description: Response content: application/json: - schema: *75 + schema: *70 examples: - default: *454 + default: *453 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -70013,9 +69631,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues parameters: + - *254 - *255 - - *256 - - *455 + - *454 - *18 - *20 responses: @@ -70025,13 +69643,13 @@ paths: application/json: schema: type: array - items: *75 + items: *70 examples: - default: *459 + default: *458 headers: - Link: *39 + Link: *51 '404': *7 - '410': *264 + '410': *263 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70059,9 +69677,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue parameters: + - *254 - *255 - - *256 - - *455 + - *454 requestBody: required: true content: @@ -70087,16 +69705,16 @@ paths: description: Response content: application/json: - schema: *75 + schema: *70 examples: - default: *454 + default: *453 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *264 + '410': *263 '422': *16 '404': *7 x-github: @@ -70116,9 +69734,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue parameters: + - *254 - *255 - - *256 - - *455 + - *454 requestBody: required: true content: @@ -70149,13 +69767,13 @@ paths: description: Response content: application/json: - schema: *75 + schema: *70 examples: - default: *454 + default: *453 '403': *29 '404': *7 '422': *8 - '503': *63 + '503': *58 x-github: triggersNotification: true githubCloudOnly: false @@ -70173,9 +69791,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: + - *254 - *255 - - *256 - - *455 + - *454 - *18 - *20 responses: @@ -70190,6 +69808,7 @@ paths: description: Timeline Event type: object anyOf: + - *459 - *460 - *461 - *462 @@ -70202,7 +69821,6 @@ paths: - *469 - *470 - *471 - - *472 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -70245,7 +69863,7 @@ paths: issue_url: type: string format: uri - author_association: *61 + author_association: *56 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. They @@ -70255,9 +69873,9 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 - reactions: *62 + properties: *54 + required: *55 + reactions: *57 required: - event - actor @@ -70288,7 +69906,7 @@ paths: properties: type: type: string - issue: *75 + issue: *70 required: - event - created_at @@ -70483,7 +70101,7 @@ paths: type: string body_text: type: string - author_association: *61 + author_association: *56 required: - event - id @@ -70506,7 +70124,7 @@ paths: type: string comments: type: array - items: &493 + items: &492 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -70595,7 +70213,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *61 + author_association: *56 _links: type: object properties: @@ -70679,7 +70297,7 @@ paths: enum: - line - file - reactions: *62 + reactions: *57 body_html: type: string example: '"

comment body

"' @@ -70715,7 +70333,7 @@ paths: type: string comments: type: array - items: *382 + items: *381 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -70746,8 +70364,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 assignee: *19 required: - id @@ -70790,8 +70408,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 assignee: *19 required: - id @@ -70834,8 +70452,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 state_reason: type: string nullable: true @@ -71002,9 +70620,9 @@ paths: type: User site_admin: true headers: - Link: *39 + Link: *51 '404': *7 - '410': *264 + '410': *263 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71021,8 +70639,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -71032,7 +70650,7 @@ paths: application/json: schema: type: array - items: &473 + items: &472 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -71081,7 +70699,7 @@ paths: last_used: '2022-01-10T15:53:42Z' enabled: true headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71097,8 +70715,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -71134,9 +70752,9 @@ paths: description: Response content: application/json: - schema: *473 + schema: *472 examples: - default: &474 + default: &473 value: id: 1 key: ssh-rsa AAA... @@ -71170,9 +70788,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: + - *254 - *255 - - *256 - - &475 + - &474 name: key_id description: The unique identifier of the key. in: path @@ -71184,9 +70802,9 @@ paths: description: Response content: application/json: - schema: *473 + schema: *472 examples: - default: *474 + default: *473 '404': *7 x-github: githubCloudOnly: false @@ -71204,9 +70822,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: + - *254 - *255 - - *256 - - *475 + - *474 responses: '204': description: Response @@ -71226,8 +70844,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -71237,11 +70855,11 @@ paths: application/json: schema: type: array - items: *457 + items: *456 examples: - default: *458 + default: *457 headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -71260,8 +70878,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -71297,9 +70915,9 @@ paths: description: Response content: application/json: - schema: *457 + schema: *456 examples: - default: &476 + default: &475 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -71331,8 +70949,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: + - *254 - *255 - - *256 - name: name in: path required: true @@ -71343,9 +70961,9 @@ paths: description: Response content: application/json: - schema: *457 + schema: *456 examples: - default: *476 + default: *475 '404': *7 x-github: githubCloudOnly: false @@ -71362,8 +70980,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: + - *254 - *255 - - *256 - name: name in: path required: true @@ -71402,7 +71020,7 @@ paths: description: Response content: application/json: - schema: *457 + schema: *456 examples: default: value: @@ -71428,8 +71046,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: + - *254 - *255 - - *256 - name: name in: path required: true @@ -71455,8 +71073,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: + - *254 - *255 - - *256 responses: '200': description: Response @@ -71495,9 +71113,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: + - *254 - *255 - - *256 - - *357 + - *356 responses: '200': description: Response @@ -71559,8 +71177,8 @@ paths: title: License Simple description: License Simple type: object - properties: *76 - required: *77 + properties: *71 + required: *72 nullable: true required: - _links @@ -71642,8 +71260,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -71708,8 +71326,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -71743,9 +71361,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *383 + schema: *382 examples: - default: *477 + default: *476 '204': description: Response when already merged '404': @@ -71770,8 +71388,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: + - *254 - *255 - - *256 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -71812,12 +71430,12 @@ paths: application/json: schema: type: array - items: &478 + items: &477 title: Milestone description: A collection of related issues and pull requests. type: object - properties: *387 - required: *388 + properties: *386 + required: *387 examples: default: value: @@ -71856,7 +71474,7 @@ paths: closed_at: '2013-02-12T13:22:01Z' due_on: '2012-10-09T23:39:01Z' headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -71873,8 +71491,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -71914,9 +71532,9 @@ paths: description: Response content: application/json: - schema: *478 + schema: *477 examples: - default: &479 + default: &478 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -71975,9 +71593,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: + - *254 - *255 - - *256 - - &480 + - &479 name: milestone_number description: The number that identifies the milestone. in: path @@ -71989,9 +71607,9 @@ paths: description: Response content: application/json: - schema: *478 + schema: *477 examples: - default: *479 + default: *478 '404': *7 x-github: githubCloudOnly: false @@ -72008,9 +71626,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: + - *254 - *255 - - *256 - - *480 + - *479 requestBody: required: false content: @@ -72048,9 +71666,9 @@ paths: description: Response content: application/json: - schema: *478 + schema: *477 examples: - default: *479 + default: *478 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72066,9 +71684,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: + - *254 - *255 - - *256 - - *480 + - *479 responses: '204': description: Response @@ -72089,9 +71707,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: + - *254 - *255 - - *256 - - *480 + - *479 - *18 - *20 responses: @@ -72101,11 +71719,11 @@ paths: application/json: schema: type: array - items: *457 + items: *456 examples: - default: *458 + default: *457 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72122,12 +71740,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: + - *254 - *255 - - *256 + - *480 - *481 + - *60 - *482 - - *65 - - *483 - *18 - *20 responses: @@ -72137,11 +71755,11 @@ paths: application/json: schema: type: array - items: *88 + items: *83 examples: - default: *484 + default: *483 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -72163,8 +71781,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: + - *254 - *255 - - *256 requestBody: required: false content: @@ -72222,14 +71840,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: + - *254 - *255 - - *256 responses: '200': description: Response content: application/json: - schema: &485 + schema: &484 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -72354,7 +71972,7 @@ paths: - custom_404 - public examples: - default: &486 + default: &485 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -72395,8 +72013,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -72450,11 +72068,11 @@ paths: description: Response content: application/json: - schema: *485 + schema: *484 examples: - default: *486 + default: *485 '422': *16 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72475,8 +72093,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -72554,7 +72172,7 @@ paths: description: Response '422': *16 '400': *15 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72575,14 +72193,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: + - *254 - *255 - - *256 responses: '204': description: Response '422': *16 '404': *7 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72602,8 +72220,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -72613,7 +72231,7 @@ paths: application/json: schema: type: array - items: &487 + items: &486 title: Page Build description: Page Build type: object @@ -72688,7 +72306,7 @@ paths: created_at: '2014-02-10T19:00:49Z' updated_at: '2014-02-10T19:00:51Z' headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72707,8 +72325,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: + - *254 - *255 - - *256 responses: '201': description: Response @@ -72753,16 +72371,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: + - *254 - *255 - - *256 responses: '200': description: Response content: application/json: - schema: *487 + schema: *486 examples: - default: &488 + default: &487 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -72810,8 +72428,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: + - *254 - *255 - - *256 - name: build_id in: path required: true @@ -72822,9 +72440,9 @@ paths: description: Response content: application/json: - schema: *487 + schema: *486 examples: - default: *488 + default: *487 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72844,8 +72462,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -72951,9 +72569,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: + - *254 - *255 - - *256 - - &489 + - &488 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -73011,11 +72629,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: + - *254 - *255 - - *256 - - *489 + - *488 responses: - '204': *138 + '204': *131 '404': *7 x-github: githubCloudOnly: false @@ -73040,8 +72658,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: + - *254 - *255 - - *256 responses: '200': description: Response @@ -73272,7 +72890,7 @@ paths: description: Empty response content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -73299,8 +72917,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: + - *254 - *255 - - *256 responses: '200': description: Private vulnerability reporting status @@ -73337,10 +72955,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: + - *254 - *255 - - *256 responses: - '204': *138 + '204': *131 '422': *15 x-github: githubCloudOnly: false @@ -73359,10 +72977,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: + - *254 - *255 - - *256 responses: - '204': *138 + '204': *131 '422': *15 x-github: githubCloudOnly: false @@ -73383,8 +73001,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-repository-projects parameters: + - *254 - *255 - - *256 - name: state description: Indicates the state of the projects to return. in: query @@ -73405,7 +73023,7 @@ paths: application/json: schema: type: array - items: *212 + items: *206 examples: default: value: @@ -73441,11 +73059,11 @@ paths: created_at: '2011-04-10T20:09:31Z' updated_at: '2014-03-03T18:58:10Z' headers: - Link: *39 + Link: *51 '401': *25 '403': *29 '404': *7 - '410': *264 + '410': *263 '422': *8 x-github: githubCloudOnly: false @@ -73465,8 +73083,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#create-a-repository-project parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -73492,13 +73110,13 @@ paths: description: Response content: application/json: - schema: *212 + schema: *206 examples: - default: *263 + default: *262 '401': *25 '403': *29 '404': *7 - '410': *264 + '410': *263 '422': *8 x-github: githubCloudOnly: false @@ -73518,8 +73136,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: + - *254 - *255 - - *256 responses: '200': description: Response @@ -73527,7 +73145,7 @@ paths: application/json: schema: type: array - items: *217 + items: *211 examples: default: value: @@ -73558,8 +73176,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: + - *254 - *255 - - *256 requestBody: required: true content: @@ -73571,7 +73189,7 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *217 + items: *211 required: - properties examples: @@ -73621,8 +73239,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: + - *254 - *255 - - *256 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -73682,11 +73300,11 @@ paths: application/json: schema: type: array - items: *490 + items: *489 examples: - default: *491 + default: *490 headers: - Link: *39 + Link: *51 '304': *37 '422': *16 x-github: @@ -73716,8 +73334,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -73782,7 +73400,7 @@ paths: description: Response content: application/json: - schema: &495 + schema: &494 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -73893,8 +73511,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *387 - required: *388 + properties: *386 + required: *387 nullable: true active_lock_reason: type: string @@ -73939,7 +73557,7 @@ paths: nullable: true requested_teams: type: array - items: *239 + items: *233 nullable: true head: type: object @@ -73948,7 +73566,7 @@ paths: type: string ref: type: string - repo: *58 + repo: *53 sha: type: string user: *19 @@ -73965,7 +73583,7 @@ paths: type: string ref: type: string - repo: *58 + repo: *53 sha: type: string user: *19 @@ -73978,14 +73596,14 @@ paths: _links: type: object properties: - comments: *389 - commits: *389 - statuses: *389 - html: *389 - issue: *389 - review_comments: *389 - review_comment: *389 - self: *389 + comments: *388 + commits: *388 + statuses: *388 + html: *388 + issue: *388 + review_comments: *388 + review_comment: *388 + self: *388 required: - comments - commits @@ -73995,8 +73613,8 @@ paths: - review_comments - review_comment - self - author_association: *61 - auto_merge: *492 + author_association: *56 + auto_merge: *491 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -74088,7 +73706,7 @@ paths: - merged_by - review_comments examples: - default: &496 + default: &495 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -74615,8 +74233,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: + - *254 - *255 - - *256 - name: sort in: query required: false @@ -74635,7 +74253,7 @@ paths: enum: - asc - desc - - *65 + - *60 - *18 - *20 responses: @@ -74645,9 +74263,9 @@ paths: application/json: schema: type: array - items: *493 + items: *492 examples: - default: &498 + default: &497 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -74699,7 +74317,7 @@ paths: original_line: 2 side: RIGHT headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74724,17 +74342,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: + - *254 - *255 - - *256 - - *74 + - *69 responses: '200': description: Response content: application/json: - schema: *493 + schema: *492 examples: - default: &494 + default: &493 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -74809,9 +74427,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: + - *254 - *255 - - *256 - - *74 + - *69 requestBody: required: true content: @@ -74833,9 +74451,9 @@ paths: description: Response content: application/json: - schema: *493 + schema: *492 examples: - default: *494 + default: *493 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74851,9 +74469,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: + - *254 - *255 - - *256 - - *74 + - *69 responses: '204': description: Response @@ -74874,9 +74492,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: + - *254 - *255 - - *256 - - *74 + - *69 - 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. @@ -74902,11 +74520,11 @@ paths: application/json: schema: type: array - items: *248 + items: *247 examples: - default: *250 + default: *249 headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -74925,9 +74543,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: + - *254 - *255 - - *256 - - *74 + - *69 requestBody: required: true content: @@ -74959,16 +74577,16 @@ paths: description: Reaction exists content: application/json: - schema: *248 + schema: *247 examples: - default: *249 + default: *248 '201': description: Reaction created content: application/json: - schema: *248 + schema: *247 examples: - default: *249 + default: *248 '422': *16 x-github: githubCloudOnly: false @@ -74990,10 +74608,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: + - *254 - *255 - - *256 - - *74 - - *251 + - *69 + - *250 responses: '204': description: Response @@ -75036,9 +74654,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: + - *254 - *255 - - *256 - - &497 + - &496 name: pull_number description: The number that identifies the pull request. in: path @@ -75051,9 +74669,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *495 + schema: *494 examples: - default: *496 + default: *495 '304': *37 '404': *7 '406': @@ -75061,8 +74679,8 @@ paths: content: application/json: schema: *3 - '500': *41 - '503': *63 + '500': *132 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75088,9 +74706,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: + - *254 - *255 - - *256 - - *497 + - *496 requestBody: required: false content: @@ -75132,9 +74750,9 @@ paths: description: Response content: application/json: - schema: *495 + schema: *494 examples: - default: *496 + default: *495 '422': *16 '403': *29 x-github: @@ -75156,9 +74774,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: + - *254 - *255 - - *256 - - *497 + - *496 requestBody: required: true content: @@ -75218,21 +74836,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *185 + schema: *178 examples: - default: *372 + default: *371 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *185 + schema: *178 examples: - default: *372 + default: *371 '401': *25 '403': *29 '404': *7 - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -75258,10 +74876,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: + - *254 - *255 - - *256 - - *497 - - *85 + - *496 + - *80 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -75271,7 +74889,7 @@ paths: enum: - asc - desc - - *65 + - *60 - *18 - *20 responses: @@ -75281,11 +74899,11 @@ paths: application/json: schema: type: array - items: *493 + items: *492 examples: - default: *498 + default: *497 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75316,9 +74934,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: + - *254 - *255 - - *256 - - *497 + - *496 requestBody: required: true content: @@ -75423,7 +75041,7 @@ paths: description: Response content: application/json: - schema: *493 + schema: *492 examples: example-for-a-multi-line-comment: value: @@ -75511,10 +75129,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: + - *254 - *255 - - *256 - - *497 - - *74 + - *496 + - *69 requestBody: required: true content: @@ -75536,7 +75154,7 @@ paths: description: Response content: application/json: - schema: *493 + schema: *492 examples: default: value: @@ -75622,9 +75240,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: + - *254 - *255 - - *256 - - *497 + - *496 - *18 - *20 responses: @@ -75634,11 +75252,11 @@ paths: application/json: schema: type: array - items: *383 + items: *382 examples: - default: *499 + default: *498 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75666,9 +75284,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: + - *254 - *255 - - *256 - - *497 + - *496 - *18 - *20 responses: @@ -75678,7 +75296,7 @@ paths: application/json: schema: type: array - items: *398 + items: *397 examples: default: value: @@ -75694,10 +75312,10 @@ paths: patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" headers: - Link: *39 + Link: *51 '422': *16 - '500': *41 - '503': *63 + '500': *132 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75716,9 +75334,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: + - *254 - *255 - - *256 - - *497 + - *496 responses: '204': description: Response if pull request has been merged @@ -75741,9 +75359,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: + - *254 - *255 - - *256 - - *497 + - *496 requestBody: required: false content: @@ -75854,9 +75472,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: + - *254 - *255 - - *256 - - *497 + - *496 responses: '200': description: Response @@ -75872,7 +75490,7 @@ paths: items: *19 teams: type: array - items: *181 + items: *174 required: - users - teams @@ -75913,7 +75531,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos parent: headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75931,9 +75549,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: + - *254 - *255 - - *256 - - *497 + - *496 requestBody: required: false content: @@ -75970,7 +75588,7 @@ paths: description: Response content: application/json: - schema: *490 + schema: *489 examples: default: value: @@ -76506,9 +76124,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: + - *254 - *255 - - *256 - - *497 + - *496 requestBody: required: true content: @@ -76542,7 +76160,7 @@ paths: description: Response content: application/json: - schema: *490 + schema: *489 examples: default: value: @@ -77047,9 +76665,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: + - *254 - *255 - - *256 - - *497 + - *496 - *18 - *20 responses: @@ -77059,7 +76677,7 @@ paths: application/json: schema: type: array - items: &500 + items: &499 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -77128,7 +76746,7 @@ paths: type: string body_text: type: string - author_association: *61 + author_association: *56 required: - id - node_id @@ -77177,7 +76795,7 @@ paths: commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091 author_association: COLLABORATOR headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77210,9 +76828,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: + - *254 - *255 - - *256 - - *497 + - *496 requestBody: required: false content: @@ -77298,9 +76916,9 @@ paths: description: Response content: application/json: - schema: *500 + schema: *499 examples: - default: &502 + default: &501 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -77363,10 +76981,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: + - *254 - *255 - - *256 - - *497 - - &501 + - *496 + - &500 name: review_id description: The unique identifier of the review. in: path @@ -77378,9 +76996,9 @@ paths: description: Response content: application/json: - schema: *500 + schema: *499 examples: - default: &503 + default: &502 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -77439,10 +77057,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: + - *254 - *255 - - *256 - - *497 - - *501 + - *496 + - *500 requestBody: required: true content: @@ -77465,7 +77083,7 @@ paths: description: Response content: application/json: - schema: *500 + schema: *499 examples: default: value: @@ -77527,18 +77145,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: + - *254 - *255 - - *256 - - *497 - - *501 + - *496 + - *500 responses: '200': description: Response content: application/json: - schema: *500 + schema: *499 examples: - default: *502 + default: *501 '422': *8 '404': *7 x-github: @@ -77565,10 +77183,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: + - *254 - *255 - - *256 - - *497 - - *501 + - *496 + - *500 - *18 - *20 responses: @@ -77647,13 +77265,13 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *61 + author_association: *56 _links: type: object properties: - self: *389 - html: *389 - pull_request: *389 + self: *388 + html: *388 + pull_request: *388 required: - self - html @@ -77662,7 +77280,7 @@ paths: type: string body_html: type: string - reactions: *62 + reactions: *57 side: description: The side of the first line of the range for a multi-line comment. @@ -77767,7 +77385,7 @@ paths: pull_request: href: https://api.github.com/repos/octocat/Hello-World/pulls/1 headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -77796,10 +77414,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: + - *254 - *255 - - *256 - - *497 - - *501 + - *496 + - *500 requestBody: required: true content: @@ -77827,7 +77445,7 @@ paths: description: Response content: application/json: - schema: *500 + schema: *499 examples: default: value: @@ -77890,10 +77508,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: + - *254 - *255 - - *256 - - *497 - - *501 + - *496 + - *500 requestBody: required: true content: @@ -77928,9 +77546,9 @@ paths: description: Response content: application/json: - schema: *500 + schema: *499 examples: - default: *503 + default: *502 '404': *7 '422': *8 '403': *29 @@ -77952,9 +77570,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: + - *254 - *255 - - *256 - - *497 + - *496 requestBody: required: false content: @@ -78017,8 +77635,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: + - *254 - *255 - - *256 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -78031,9 +77649,9 @@ paths: description: Response content: application/json: - schema: *504 + schema: *503 examples: - default: &505 + default: &504 value: type: file encoding: base64 @@ -78075,8 +77693,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: + - *254 - *255 - - *256 - name: dir description: The alternate path to look for a README file in: path @@ -78096,9 +77714,9 @@ paths: description: Response content: application/json: - schema: *504 + schema: *503 examples: - default: *505 + default: *504 '404': *7 '422': *16 x-github: @@ -78120,8 +77738,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -78131,7 +77749,7 @@ paths: application/json: schema: type: array - items: &506 + items: &505 title: Release description: A release. type: object @@ -78194,7 +77812,7 @@ paths: author: *19 assets: type: array - items: &507 + items: &506 title: Release Asset description: Data related to a release. type: object @@ -78265,7 +77883,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *62 + reactions: *57 required: - assets_url - upload_url @@ -78355,7 +77973,7 @@ paths: type: User site_admin: false headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -78375,8 +77993,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -78452,9 +78070,9 @@ paths: description: Response content: application/json: - schema: *506 + schema: *505 examples: - default: &510 + default: &509 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -78557,9 +78175,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: + - *254 - *255 - - *256 - - &508 + - &507 name: asset_id description: The unique identifier of the asset. in: path @@ -78571,9 +78189,9 @@ paths: description: Response content: application/json: - schema: *507 + schema: *506 examples: - default: &509 + default: &508 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 @@ -78607,7 +78225,7 @@ paths: type: User site_admin: false '404': *7 - '302': *400 + '302': *399 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78623,9 +78241,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: + - *254 - *255 - - *256 - - *508 + - *507 requestBody: required: false content: @@ -78653,9 +78271,9 @@ paths: description: Response content: application/json: - schema: *507 + schema: *506 examples: - default: *509 + default: *508 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78671,9 +78289,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: + - *254 - *255 - - *256 - - *508 + - *507 responses: '204': description: Response @@ -78697,8 +78315,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -78783,16 +78401,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: + - *254 - *255 - - *256 responses: '200': description: Response content: application/json: - schema: *506 + schema: *505 examples: - default: *510 + default: *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78809,8 +78427,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: + - *254 - *255 - - *256 - name: tag description: tag parameter in: path @@ -78823,9 +78441,9 @@ paths: description: Response content: application/json: - schema: *506 + schema: *505 examples: - default: *510 + default: *509 '404': *7 x-github: githubCloudOnly: false @@ -78847,9 +78465,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: + - *254 - *255 - - *256 - - &511 + - &510 name: release_id description: The unique identifier of the release. in: path @@ -78863,9 +78481,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: *506 + schema: *505 examples: - default: *510 + default: *509 '401': description: Unauthorized x-github: @@ -78883,9 +78501,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: + - *254 - *255 - - *256 - - *511 + - *510 requestBody: required: false content: @@ -78949,9 +78567,9 @@ paths: description: Response content: application/json: - schema: *506 + schema: *505 examples: - default: *510 + default: *509 '404': description: Not Found if the discussion category name is invalid content: @@ -78972,9 +78590,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: + - *254 - *255 - - *256 - - *511 + - *510 responses: '204': description: Response @@ -78994,9 +78612,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: + - *254 - *255 - - *256 - - *511 + - *510 - *18 - *20 responses: @@ -79006,7 +78624,7 @@ paths: application/json: schema: type: array - items: *507 + items: *506 examples: default: value: @@ -79042,7 +78660,7 @@ paths: type: User site_admin: false headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79086,9 +78704,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: + - *254 - *255 - - *256 - - *511 + - *510 - name: name in: query required: true @@ -79114,7 +78732,7 @@ paths: description: Response for successful upload content: application/json: - schema: *507 + schema: *506 examples: response-for-successful-upload: value: @@ -79168,9 +78786,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: + - *254 - *255 - - *256 - - *511 + - *510 - 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. @@ -79194,11 +78812,11 @@ paths: application/json: schema: type: array - items: *248 + items: *247 examples: - default: *250 + default: *249 headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -79217,9 +78835,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: + - *254 - *255 - - *256 - - *511 + - *510 requestBody: required: true content: @@ -79249,16 +78867,16 @@ paths: description: Reaction exists content: application/json: - schema: *248 + schema: *247 examples: - default: *249 + default: *248 '201': description: Reaction created content: application/json: - schema: *248 + schema: *247 examples: - default: *249 + default: *248 '422': *16 x-github: githubCloudOnly: false @@ -79280,10 +78898,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: + - *254 - *255 - - *256 - - *511 - - *251 + - *510 + - *250 responses: '204': description: Response @@ -79307,9 +78925,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: + - *254 - *255 - - *256 - - *323 + - *322 - *18 - *20 responses: @@ -79325,8 +78943,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *512 - - &514 + - *511 + - &513 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -79346,53 +78964,53 @@ paths: type: integer description: The ID of the ruleset that includes this rule. - allOf: + - *512 - *513 + - allOf: - *514 + - *513 - allOf: - *515 - - *514 + - *513 - allOf: - *516 - - *514 + - *513 - allOf: - *517 - - *514 + - *513 - allOf: - *518 - - *514 + - *513 - allOf: - *519 - - *514 + - *513 - allOf: - *520 - - *514 + - *513 - allOf: - *521 - - *514 + - *513 - allOf: - *522 - - *514 + - *513 - allOf: - *523 - - *514 + - *513 - allOf: - *524 - - *514 + - *513 - allOf: - *525 - - *514 + - *513 - allOf: - *526 - - *514 + - *513 - allOf: - *527 - - *514 + - *513 - allOf: - *528 - - *514 - - allOf: - - *529 - - *514 + - *513 examples: default: value: @@ -79431,8 +79049,8 @@ paths: category: repos subcategory: rules parameters: + - *254 - *255 - - *256 - *18 - *20 - name: includes_parents @@ -79443,7 +79061,7 @@ paths: schema: type: boolean default: true - - *530 + - *529 responses: '200': description: Response @@ -79451,7 +79069,7 @@ paths: application/json: schema: type: array - items: *227 + items: *221 examples: default: value: @@ -79482,7 +79100,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *7 - '500': *41 + '500': *132 post: summary: Create a repository ruleset description: Create a ruleset for a repository. @@ -79498,8 +79116,8 @@ paths: category: repos subcategory: rules parameters: + - *254 - *255 - - *256 requestBody: description: Request body required: true @@ -79519,16 +79137,16 @@ paths: - tag - push default: branch - enforcement: *223 + enforcement: *217 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *224 - conditions: *221 + items: *218 + conditions: *215 rules: type: array description: An array of rules within the ruleset. - items: *226 + items: *220 required: - name - enforcement @@ -79559,9 +79177,9 @@ paths: description: Response content: application/json: - schema: *227 + schema: *221 examples: - default: &540 + default: &539 value: id: 42 name: super cool ruleset @@ -79594,7 +79212,7 @@ paths: created_at: '2023-07-15T08:43:03Z' updated_at: '2023-08-23T16:29:47Z' '404': *7 - '500': *41 + '500': *132 "/repos/{owner}/{repo}/rulesets/rule-suites": get: summary: List repository rule suites @@ -79608,12 +79226,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: + - *254 - *255 - - *256 + - *530 - *531 - *532 - *533 - - *534 - *18 - *20 responses: @@ -79621,11 +79239,11 @@ paths: description: Response content: application/json: - schema: *535 + schema: *534 examples: - default: *536 + default: *535 '404': *7 - '500': *41 + '500': *132 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79644,19 +79262,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: + - *254 - *255 - - *256 - - *537 + - *536 responses: '200': description: Response content: application/json: - schema: *538 + schema: *537 examples: - default: *539 + default: *538 '404': *7 - '500': *41 + '500': *132 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79682,8 +79300,8 @@ paths: category: repos subcategory: rules parameters: + - *254 - *255 - - *256 - name: ruleset_id description: The ID of the ruleset. in: path @@ -79703,11 +79321,11 @@ paths: description: Response content: application/json: - schema: *227 + schema: *221 examples: - default: *540 + default: *539 '404': *7 - '500': *41 + '500': *132 put: summary: Update a repository ruleset description: Update a ruleset for a repository. @@ -79723,8 +79341,8 @@ paths: category: repos subcategory: rules parameters: + - *254 - *255 - - *256 - name: ruleset_id description: The ID of the ruleset. in: path @@ -79749,16 +79367,16 @@ paths: - branch - tag - push - enforcement: *223 + enforcement: *217 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *224 - conditions: *221 + items: *218 + conditions: *215 rules: description: An array of rules within the ruleset. type: array - items: *226 + items: *220 examples: default: value: @@ -79786,11 +79404,11 @@ paths: description: Response content: application/json: - schema: *227 + schema: *221 examples: - default: *540 + default: *539 '404': *7 - '500': *41 + '500': *132 delete: summary: Delete a repository ruleset description: Delete a ruleset for a repository. @@ -79806,8 +79424,8 @@ paths: category: repos subcategory: rules parameters: + - *254 - *255 - - *256 - name: ruleset_id description: The ID of the ruleset. in: path @@ -79818,7 +79436,7 @@ paths: '204': description: Response '404': *7 - '500': *41 + '500': *132 "/repos/{owner}/{repo}/secret-scanning/alerts": get: summary: List secret scanning alerts for a repository @@ -79835,20 +79453,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: + - *254 - *255 - - *256 - - *229 - - *230 - - *231 - - *232 - - *42 + - *223 + - *224 + - *225 + - *226 + - *39 - *20 - *18 + - *540 - *541 - - *542 - - *233 - - *234 - - *235 + - *227 + - *228 + - *229 responses: '200': description: Response @@ -79856,11 +79474,11 @@ paths: application/json: schema: type: array - items: &545 + items: &544 type: object properties: - number: *48 - created_at: *49 + number: *46 + created_at: *47 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -79868,15 +79486,15 @@ paths: format: date-time readOnly: true nullable: true - url: *50 - html_url: *51 + url: *48 + html_url: *49 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *543 - resolution: *544 + state: *542 + resolution: *543 resolved_at: type: string format: date-time @@ -79930,6 +79548,11 @@ paths: properties: *4 required: *5 nullable: true + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection + bypass. + nullable: true push_protection_bypass_request_comment: type: string description: An optional comment when requesting a push protection @@ -80029,6 +79652,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 @@ -80051,6 +79675,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: @@ -80060,7 +79685,7 @@ paths: '404': description: Repository is public or secret scanning is disabled for the repository - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80082,15 +79707,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: + - *254 - *255 - - *256 - - *355 + - *354 responses: '200': description: Response content: application/json: - schema: *545 + schema: *544 examples: default: value: @@ -80110,6 +79735,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: @@ -80120,7 +79746,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80141,9 +79767,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: + - *254 - *255 - - *256 - - *355 + - *354 requestBody: required: true content: @@ -80151,8 +79777,8 @@ paths: schema: type: object properties: - state: *543 - resolution: *544 + state: *542 + resolution: *543 resolution_comment: description: An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. @@ -80170,7 +79796,7 @@ paths: description: Response content: application/json: - schema: *545 + schema: *544 examples: default: value: @@ -80208,6 +79834,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 @@ -80222,7 +79849,7 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment - '503': *63 + '503': *58 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -80244,9 +79871,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: + - *254 - *255 - - *256 - - *355 + - *354 - *20 - *18 responses: @@ -80257,7 +79884,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &678 + items: &677 type: object properties: type: @@ -80590,11 +80217,11 @@ paths: details: pull_request_review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 headers: - Link: *39 + Link: *51 '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80616,8 +80243,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -80625,14 +80252,14 @@ paths: schema: type: object properties: - reason: &547 + reason: &546 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *546 + placeholder_id: *545 required: - reason - placeholder_id @@ -80649,7 +80276,7 @@ paths: schema: type: object properties: - reason: *547 + reason: *546 expire_at: type: string format: date-time @@ -80672,7 +80299,7 @@ paths: this repository. '422': description: Bad request, input data missing or incorrect. - '503': *63 + '503': *58 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -80692,13 +80319,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: + - *254 - *255 - - *256 responses: '404': description: Repository does not have GitHub Advanced Security or secret scanning enabled - '503': *63 + '503': *58 '200': description: Response content: @@ -80708,7 +80335,7 @@ paths: properties: incremental_scans: type: array - items: &548 + items: &547 description: Information on a single scan performed by secret scanning on the repository type: object @@ -80734,15 +80361,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *548 + items: *547 backfill_scans: type: array - items: *548 + items: *547 custom_pattern_backfill_scans: type: array items: allOf: - - *548 + - *547 - type: object properties: pattern_name: @@ -80812,9 +80439,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: + - *254 - *255 - - *256 - - *42 + - *39 - name: sort description: The property to sort the results by. in: query @@ -80826,8 +80453,8 @@ paths: - updated - published default: created - - *43 - - *44 + - *40 + - *41 - 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)." @@ -80857,9 +80484,9 @@ paths: application/json: schema: type: array - items: *549 + items: *548 examples: - default: *550 + default: *549 '400': *15 '404': *7 x-github: @@ -80882,8 +80509,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -80956,7 +80583,7 @@ paths: login: type: string description: The username of the user credited. - type: *238 + type: *232 required: - login - type @@ -81043,9 +80670,9 @@ paths: description: Response content: application/json: - schema: *549 + schema: *548 examples: - default: &552 + default: &551 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -81278,8 +80905,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -81383,7 +81010,7 @@ paths: description: Response content: application/json: - schema: *549 + schema: *548 examples: default: value: @@ -81530,17 +81157,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: + - *254 - *255 - - *256 - - *551 + - *550 responses: '200': description: Response content: application/json: - schema: *549 + schema: *548 examples: - default: *552 + default: *551 '403': *29 '404': *7 x-github: @@ -81564,9 +81191,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: + - *254 - *255 - - *256 - - *551 + - *550 requestBody: required: true content: @@ -81639,7 +81266,7 @@ paths: login: type: string description: The username of the user credited. - type: *238 + type: *232 required: - login - type @@ -81725,17 +81352,17 @@ paths: description: Response content: application/json: - schema: *549 + schema: *548 examples: - default: *552 - add_credit: *552 + default: *551 + add_credit: *551 '403': *29 '404': *7 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *97 + schema: *90 examples: invalid_state_transition: value: @@ -81766,11 +81393,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: + - *254 - *255 - - *256 - - *551 + - *550 responses: - '202': *99 + '202': *92 '400': *15 '403': *29 '404': *7 @@ -81795,17 +81422,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: + - *254 - *255 - - *256 - - *551 + - *550 responses: '202': description: Response content: application/json: - schema: *266 + schema: *265 examples: - default: *268 + default: *267 '400': *15 '422': *16 '403': *29 @@ -81831,8 +81458,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -81909,7 +81536,7 @@ paths: type: User site_admin: false headers: - Link: *39 + Link: *51 '422': *16 x-github: githubCloudOnly: false @@ -81931,8 +81558,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: + - *254 - *255 - - *256 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -81941,7 +81568,7 @@ paths: application/json: schema: type: array - items: &553 + items: &552 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -81953,8 +81580,8 @@ paths: - - 1302998400 - 1124 - -435 - '202': *99 - '204': *138 + '202': *92 + '204': *131 '422': description: Repository contains more than 10,000 commits x-github: @@ -81974,8 +81601,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: + - *254 - *255 - - *256 responses: '200': description: Response @@ -82023,8 +81650,8 @@ paths: - 0 total: 89 week: 1336280400 - '202': *99 - '204': *138 + '202': *92 + '204': *131 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82051,8 +81678,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: + - *254 - *255 - - *256 responses: '200': description: Response @@ -82125,8 +81752,8 @@ paths: a: 6898 d: 77 c: 10 - '202': *99 - '204': *138 + '202': *92 + '204': *131 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82148,8 +81775,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: + - *254 - *255 - - *256 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -82303,8 +81930,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: + - *254 - *255 - - *256 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -82314,7 +81941,7 @@ paths: application/json: schema: type: array - items: *553 + items: *552 examples: default: value: @@ -82327,7 +81954,7 @@ paths: - - 0 - 2 - 21 - '204': *138 + '204': *131 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82347,8 +81974,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: + - *254 - *255 - - *256 - name: sha in: path required: true @@ -82402,7 +82029,7 @@ paths: description: Response content: application/json: - schema: *554 + schema: *553 examples: default: value: @@ -82456,8 +82083,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -82469,9 +82096,9 @@ paths: type: array items: *19 examples: - default: *184 + default: *177 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82489,14 +82116,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: + - *254 - *255 - - *256 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &555 + schema: &554 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -82564,8 +82191,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: + - *254 - *255 - - *256 requestBody: required: false content: @@ -82591,7 +82218,7 @@ paths: description: Response content: application/json: - schema: *555 + schema: *554 examples: default: value: @@ -82618,8 +82245,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: + - *254 - *255 - - *256 responses: '204': description: Response @@ -82639,8 +82266,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -82696,7 +82323,7 @@ paths: tarball_url: https://github.com/octocat/Hello-World/tarball/v0.1 node_id: MDQ6VXNlcjE= headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82719,8 +82346,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: + - *254 - *255 - - *256 responses: '200': description: Response @@ -82728,7 +82355,7 @@ paths: application/json: schema: type: array - items: &556 + items: &555 title: Tag protection description: Tag protection type: object @@ -82780,8 +82407,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: + - *254 - *255 - - *256 requestBody: required: true content: @@ -82804,7 +82431,7 @@ paths: description: Response content: application/json: - schema: *556 + schema: *555 examples: default: value: @@ -82835,8 +82462,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: + - *254 - *255 - - *256 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -82873,8 +82500,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: + - *254 - *255 - - *256 - name: ref in: path required: true @@ -82910,8 +82537,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: + - *254 - *255 - - *256 - *18 - *20 responses: @@ -82921,11 +82548,11 @@ paths: application/json: schema: type: array - items: *181 + items: *174 examples: - default: *198 + default: *192 headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -82943,8 +82570,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: + - *254 - *255 - - *256 - *20 - *18 responses: @@ -82952,7 +82579,7 @@ paths: description: Response content: application/json: - schema: &557 + schema: &556 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -82964,7 +82591,7 @@ paths: required: - names examples: - default: &558 + default: &557 value: names: - octocat @@ -82987,8 +82614,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -83019,9 +82646,9 @@ paths: description: Response content: application/json: - schema: *557 + schema: *556 examples: - default: *558 + default: *557 '404': *7 '422': *8 x-github: @@ -83042,9 +82669,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: + - *254 - *255 - - *256 - - &559 + - &558 name: per description: The time frame to display results for. in: query @@ -83073,7 +82700,7 @@ paths: example: 128 clones: type: array - items: &560 + items: &559 title: Traffic type: object properties: @@ -83160,8 +82787,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: + - *254 - *255 - - *256 responses: '200': description: Response @@ -83251,8 +82878,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: + - *254 - *255 - - *256 responses: '200': description: Response @@ -83312,9 +82939,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: + - *254 - *255 - - *256 - - *559 + - *558 responses: '200': description: Response @@ -83333,7 +82960,7 @@ paths: example: 3782 views: type: array - items: *560 + items: *559 required: - uniques - count @@ -83410,8 +83037,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: + - *254 - *255 - - *256 requestBody: required: true content: @@ -83447,7 +83074,7 @@ paths: description: Response content: application/json: - schema: *113 + schema: *106 examples: default: value: @@ -83685,8 +83312,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: + - *254 - *255 - - *256 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -83709,8 +83336,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: + - *254 - *255 - - *256 responses: '204': description: Response @@ -83732,8 +83359,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: + - *254 - *255 - - *256 responses: '204': description: Response @@ -83759,8 +83386,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: + - *254 - *255 - - *256 - name: ref in: path required: true @@ -83852,9 +83479,9 @@ paths: description: Response content: application/json: - schema: *266 + schema: *265 examples: - default: *268 + default: *267 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -83895,7 +83522,7 @@ paths: application/json: schema: type: array - items: *113 + items: *106 examples: default: value: @@ -84084,7 +83711,7 @@ paths: html_url: type: string format: uri - repository: *113 + repository: *106 score: type: number file_size: @@ -84102,7 +83729,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &561 + text_matches: &560 title: Search Result Text Matches type: array items: @@ -84216,7 +83843,7 @@ paths: releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} score: 1 '304': *37 - '503': *63 + '503': *58 '422': *16 '403': *29 x-github: @@ -84264,7 +83891,7 @@ paths: enum: - author-date - committer-date - - &562 + - &561 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 @@ -84335,7 +83962,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *321 + properties: *320 nullable: true comment_count: type: integer @@ -84355,7 +83982,7 @@ paths: url: type: string format: uri - verification: *435 + verification: *434 required: - author - committer @@ -84374,7 +84001,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *321 + properties: *320 nullable: true parents: type: array @@ -84387,12 +84014,12 @@ paths: type: string sha: type: string - repository: *113 + repository: *106 score: type: number node_id: type: string - text_matches: *561 + text_matches: *560 required: - sha - node_id @@ -84584,7 +84211,7 @@ paths: - interactions - created - updated - - *562 + - *561 - *18 - *20 responses: @@ -84703,8 +84330,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *387 - required: *388 + properties: *386 + required: *387 nullable: true comments: type: integer @@ -84718,7 +84345,7 @@ paths: type: string format: date-time nullable: true - text_matches: *561 + text_matches: *560 pull_request: type: object properties: @@ -84751,10 +84378,10 @@ paths: type: string score: type: number - author_association: *61 + author_association: *56 draft: type: boolean - repository: *58 + repository: *53 body_html: type: string body_text: @@ -84771,9 +84398,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 - reactions: *62 + properties: *54 + required: *55 + reactions: *57 required: - assignee - closed_at @@ -84889,7 +84516,7 @@ paths: locked: true author_association: COLLABORATOR state_reason: completed - '503': *63 + '503': *58 '422': *16 '304': *37 '403': *29 @@ -84942,7 +84569,7 @@ paths: enum: - created - updated - - *562 + - *561 - *18 - *20 responses: @@ -84986,7 +84613,7 @@ paths: nullable: true score: type: number - text_matches: *561 + text_matches: *560 required: - id - node_id @@ -85071,7 +84698,7 @@ paths: - forks - help-wanted-issues - updated - - *562 + - *561 - *18 - *20 responses: @@ -85290,8 +84917,8 @@ paths: title: License Simple description: License Simple type: object - properties: *76 - required: *77 + properties: *71 + required: *72 nullable: true permissions: type: object @@ -85310,7 +84937,7 @@ paths: - admin - pull - push - text_matches: *561 + text_matches: *560 temp_clone_token: type: string allow_merge_commit: @@ -85512,7 +85139,7 @@ paths: spdx_id: MIT node_id: MDc6TGljZW5zZW1pdA== html_url: https://api.github.com/licenses/mit - '503': *63 + '503': *58 '422': *16 '304': *37 x-github: @@ -85610,7 +85237,7 @@ paths: type: string format: uri nullable: true - text_matches: *561 + text_matches: *560 related: type: array nullable: true @@ -85801,7 +85428,7 @@ paths: - followers - repositories - joined - - *562 + - *561 - *18 - *20 responses: @@ -85905,7 +85532,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *561 + text_matches: *560 blog: type: string nullable: true @@ -85964,7 +85591,7 @@ paths: events_url: https://api.github.com/users/mojombo/events{/privacy} site_admin: true '304': *37 - '503': *63 + '503': *58 '422': *16 x-github: githubCloudOnly: false @@ -85984,7 +85611,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &563 + - &562 name: team_id description: The unique identifier of the team. in: path @@ -85996,9 +85623,9 @@ paths: description: Response content: application/json: - schema: *240 + schema: *239 examples: - default: *241 + default: *240 '404': *7 x-github: githubCloudOnly: false @@ -86025,7 +85652,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *563 + - *562 requestBody: required: true content: @@ -86088,16 +85715,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *240 + schema: *239 examples: - default: *241 + default: *240 '201': description: Response content: application/json: - schema: *240 + schema: *239 examples: - default: *241 + default: *240 '404': *7 '422': *16 '403': *29 @@ -86125,7 +85752,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *563 + - *562 responses: '204': description: Response @@ -86156,8 +85783,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy parameters: - - *563 - - *42 + - *562 + - *39 - *18 - *20 responses: @@ -86167,11 +85794,11 @@ paths: application/json: schema: type: array - items: *242 + items: *241 examples: - default: *564 + default: *563 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86198,7 +85825,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy parameters: - - *563 + - *562 requestBody: required: true content: @@ -86232,9 +85859,9 @@ paths: description: Response content: application/json: - schema: *242 + schema: *241 examples: - default: *243 + default: *242 x-github: triggersNotification: true githubCloudOnly: false @@ -86261,16 +85888,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy parameters: - - *563 - - *244 + - *562 + - *243 responses: '200': description: Response content: application/json: - schema: *242 + schema: *241 examples: - default: *243 + default: *242 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86295,8 +85922,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy parameters: - - *563 - - *244 + - *562 + - *243 requestBody: required: false content: @@ -86319,9 +85946,9 @@ paths: description: Response content: application/json: - schema: *242 + schema: *241 examples: - default: *565 + default: *564 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86346,8 +85973,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy parameters: - - *563 - - *244 + - *562 + - *243 responses: '204': description: Response @@ -86376,9 +86003,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *563 - - *244 - - *42 + - *562 + - *243 + - *39 - *18 - *20 responses: @@ -86388,11 +86015,11 @@ paths: application/json: schema: type: array - items: *245 + items: *244 examples: - default: *566 + default: *565 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86419,8 +86046,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *563 - - *244 + - *562 + - *243 requestBody: required: true content: @@ -86442,9 +86069,9 @@ paths: description: Response content: application/json: - schema: *245 + schema: *244 examples: - default: *246 + default: *245 x-github: triggersNotification: true githubCloudOnly: false @@ -86471,17 +86098,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *563 - - *244 - - *247 + - *562 + - *243 + - *246 responses: '200': description: Response content: application/json: - schema: *245 + schema: *244 examples: - default: *246 + default: *245 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86506,9 +86133,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *563 - - *244 - - *247 + - *562 + - *243 + - *246 requestBody: required: true content: @@ -86530,9 +86157,9 @@ paths: description: Response content: application/json: - schema: *245 + schema: *244 examples: - default: *567 + default: *566 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86557,9 +86184,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *563 - - *244 - - *247 + - *562 + - *243 + - *246 responses: '204': description: Response @@ -86588,9 +86215,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *563 - - *244 - - *247 + - *562 + - *243 + - *246 - 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. @@ -86616,11 +86243,11 @@ paths: application/json: schema: type: array - items: *248 + items: *247 examples: - default: *250 + default: *249 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86647,9 +86274,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *563 - - *244 - - *247 + - *562 + - *243 + - *246 requestBody: required: true content: @@ -86681,9 +86308,9 @@ paths: description: Response content: application/json: - schema: *248 + schema: *247 examples: - default: *249 + default: *248 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86709,8 +86336,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *563 - - *244 + - *562 + - *243 - 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. @@ -86736,11 +86363,11 @@ paths: application/json: schema: type: array - items: *248 + items: *247 examples: - default: *250 + default: *249 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86767,8 +86394,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *563 - - *244 + - *562 + - *243 requestBody: required: true content: @@ -86800,9 +86427,9 @@ paths: description: Response content: application/json: - schema: *248 + schema: *247 examples: - default: *249 + default: *248 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -86826,7 +86453,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *563 + - *562 - *18 - *20 responses: @@ -86836,11 +86463,11 @@ paths: application/json: schema: type: array - items: *178 + items: *171 examples: - default: *179 + default: *172 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86864,7 +86491,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *563 + - *562 - name: role description: Filters members returned by their role in the team. in: query @@ -86887,9 +86514,9 @@ paths: type: array items: *19 examples: - default: *184 + default: *177 headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -86915,8 +86542,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *563 - - *126 + - *562 + - *119 responses: '204': description: if user is a member @@ -86952,8 +86579,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *563 - - *126 + - *562 + - *119 responses: '204': description: Response @@ -86992,8 +86619,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *563 - - *126 + - *562 + - *119 responses: '204': description: Response @@ -87029,16 +86656,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *563 - - *126 + - *562 + - *119 responses: '200': description: Response content: application/json: - schema: *252 + schema: *251 examples: - response-if-user-is-a-team-maintainer: *568 + response-if-user-is-a-team-maintainer: *567 '404': *7 x-github: githubCloudOnly: false @@ -87071,8 +86698,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *563 - - *126 + - *562 + - *119 requestBody: required: false content: @@ -87097,9 +86724,9 @@ paths: description: Response content: application/json: - schema: *252 + schema: *251 examples: - response-if-users-membership-with-team-is-now-pending: *569 + response-if-users-membership-with-team-is-now-pending: *568 '403': description: Forbidden if team synchronization is set up '422': @@ -87133,8 +86760,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *563 - - *126 + - *562 + - *119 responses: '204': description: Response @@ -87163,7 +86790,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy parameters: - - *563 + - *562 - *18 - *20 responses: @@ -87173,11 +86800,11 @@ paths: application/json: schema: type: array - items: *253 + items: *252 examples: - default: *570 + default: *569 headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -87202,16 +86829,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy parameters: - - *563 - - *254 + - *562 + - *253 responses: '200': description: Response content: application/json: - schema: *253 + schema: *252 examples: - default: *571 + default: *570 '404': description: Not Found if project is not managed by this team x-github: @@ -87236,8 +86863,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy parameters: - - *563 - - *254 + - *562 + - *253 requestBody: required: false content: @@ -87305,8 +86932,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy parameters: - - *563 - - *254 + - *562 + - *253 responses: '204': description: Response @@ -87333,7 +86960,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *563 + - *562 - *18 - *20 responses: @@ -87343,11 +86970,11 @@ paths: application/json: schema: type: array - items: *113 + items: *106 examples: - default: *205 + default: *199 headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -87375,15 +87002,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *563 + - *562 + - *254 - *255 - - *256 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *572 + schema: *571 examples: alternative-response-with-extra-repository-information: value: @@ -87534,9 +87161,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *563 + - *562 + - *254 - *255 - - *256 requestBody: required: false content: @@ -87586,9 +87213,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *563 + - *562 + - *254 - *255 - - *256 responses: '204': description: Response @@ -87613,7 +87240,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *563 + - *562 - *18 - *20 responses: @@ -87623,11 +87250,11 @@ paths: application/json: schema: type: array - items: *181 + items: *174 examples: - response-if-child-teams-exist: *573 + response-if-child-teams-exist: *572 headers: - Link: *39 + Link: *51 '404': *7 '403': *29 '422': *16 @@ -87658,7 +87285,7 @@ paths: application/json: schema: oneOf: - - &575 + - &574 title: Private User description: Private User type: object @@ -87861,7 +87488,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *574 + - *573 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -88014,7 +87641,7 @@ paths: description: Response content: application/json: - schema: *575 + schema: *574 examples: default: value: @@ -88093,7 +87720,7 @@ paths: type: array items: *19 examples: - default: *184 + default: *177 '304': *37 '404': *7 '403': *29 @@ -88116,7 +87743,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: - - *126 + - *119 responses: '204': description: If the user is blocked @@ -88144,7 +87771,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#block-a-user parameters: - - *126 + - *119 responses: '204': description: Response @@ -88168,7 +87795,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#unblock-a-user parameters: - - *126 + - *119 responses: '204': description: Response @@ -88217,11 +87844,11 @@ paths: type: integer codespaces: type: array - items: *185 + items: *178 examples: - default: *186 + default: *179 '304': *37 - '500': *41 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -88358,21 +87985,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *185 + schema: *178 examples: - default: *372 + default: *371 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *185 + schema: *178 examples: - default: *372 + default: *371 '401': *25 '403': *29 '404': *7 - '503': *63 + '503': *58 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -88412,7 +88039,7 @@ paths: type: integer secrets: type: array - items: &576 + items: &575 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -88452,9 +88079,9 @@ paths: - visibility - selected_repositories_url examples: - default: *375 + default: *374 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -88522,13 +88149,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *121 + - *114 responses: '200': description: Response content: application/json: - schema: *576 + schema: *575 examples: default: value: @@ -88558,7 +88185,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *121 + - *114 requestBody: required: true content: @@ -88603,7 +88230,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -88631,7 +88258,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *121 + - *114 responses: '204': description: Response @@ -88656,7 +88283,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *121 + - *114 responses: '200': description: Response @@ -88672,13 +88299,13 @@ paths: type: integer repositories: type: array - items: *113 + items: *106 examples: - default: *577 + default: *576 '401': *25 '403': *29 '404': *7 - '500': *41 + '500': *132 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -88699,7 +88326,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *121 + - *114 requestBody: required: true content: @@ -88731,7 +88358,7 @@ paths: '401': *25 '403': *29 '404': *7 - '500': *41 + '500': *132 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -88753,7 +88380,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *121 + - *114 - name: repository_id in: path required: true @@ -88765,7 +88392,7 @@ paths: '401': *25 '403': *29 '404': *7 - '500': *41 + '500': *132 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -88786,7 +88413,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *121 + - *114 - name: repository_id in: path required: true @@ -88798,7 +88425,7 @@ paths: '401': *25 '403': *29 '404': *7 - '500': *41 + '500': *132 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -88818,17 +88445,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *187 + - *180 responses: '200': description: Response content: application/json: - schema: *185 + schema: *178 examples: - default: *372 + default: *371 '304': *37 - '500': *41 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -88852,7 +88479,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *187 + - *180 requestBody: required: false content: @@ -88882,9 +88509,9 @@ paths: description: Response content: application/json: - schema: *185 + schema: *178 examples: - default: *372 + default: *371 '401': *25 '403': *29 '404': *7 @@ -88906,11 +88533,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *187 + - *180 responses: - '202': *99 + '202': *92 '304': *37 - '500': *41 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -88935,13 +88562,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *187 + - *180 responses: '202': description: Response content: application/json: - schema: &578 + schema: &577 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -88982,7 +88609,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &579 + default: &578 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -88990,7 +88617,7 @@ paths: sha: fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 id: latest export_url: https://api.github.com/user/codespaces/:name/exports/latest - '500': *41 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -89014,7 +88641,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *187 + - *180 - name: export_id in: path required: true @@ -89027,9 +88654,9 @@ paths: description: Response content: application/json: - schema: *578 + schema: *577 examples: - default: *579 + default: *578 '404': *7 x-github: githubCloudOnly: false @@ -89050,7 +88677,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *187 + - *180 responses: '200': description: Response @@ -89066,11 +88693,11 @@ paths: type: integer machines: type: array - items: *580 + items: *579 examples: - default: *581 + default: *580 '304': *37 - '500': *41 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -89097,7 +88724,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *187 + - *180 requestBody: required: true content: @@ -89147,13 +88774,13 @@ paths: nullable: true owner: *19 billable_owner: *19 - repository: *266 + repository: *265 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *373 - required: *374 + properties: *372 + required: *373 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -89927,17 +89554,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *187 + - *180 responses: '200': description: Response content: application/json: - schema: *185 + schema: *178 examples: - default: *372 + default: *371 '304': *37 - '500': *41 + '500': *132 '400': *15 '401': *25 '402': @@ -89947,7 +89574,7 @@ paths: schema: *3 '403': *29 '404': *7 - '409': *134 + '409': *127 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -89967,16 +89594,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *187 + - *180 responses: '200': description: Response content: application/json: - schema: *185 + schema: *178 examples: - default: *372 - '500': *41 + default: *371 + '500': *132 '401': *25 '403': *29 '404': *7 @@ -90005,9 +89632,9 @@ paths: application/json: schema: type: array - items: *199 + items: *193 examples: - default: &594 + default: &593 value: - id: 197 name: hello_docker @@ -90108,7 +89735,7 @@ paths: application/json: schema: type: array - items: &582 + items: &581 title: Email description: Email type: object @@ -90173,16 +89800,16 @@ paths: application/json: schema: type: array - items: *582 + items: *581 examples: - default: &596 + default: &595 value: - email: octocat@github.com verified: true primary: true visibility: public headers: - Link: *39 + Link: *51 '304': *37 '404': *7 '403': *29 @@ -90250,7 +89877,7 @@ paths: application/json: schema: type: array - items: *582 + items: *581 examples: default: value: @@ -90360,9 +89987,9 @@ paths: type: array items: *19 examples: - default: *184 + default: *177 headers: - Link: *39 + Link: *51 '304': *37 '403': *29 '401': *25 @@ -90393,9 +90020,9 @@ paths: type: array items: *19 examples: - default: *184 + default: *177 headers: - Link: *39 + Link: *51 '304': *37 '403': *29 '401': *25 @@ -90415,7 +90042,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: - - *126 + - *119 responses: '204': description: if the person is followed by the authenticated user @@ -90445,7 +90072,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#follow-a-user parameters: - - *126 + - *119 responses: '204': description: Response @@ -90470,7 +90097,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#unfollow-a-user parameters: - - *126 + - *119 responses: '204': description: Response @@ -90506,7 +90133,7 @@ paths: application/json: schema: type: array - items: &583 + items: &582 title: GPG Key description: A unique encryption key type: object @@ -90637,7 +90264,7 @@ paths: - subkeys - revoked examples: - default: &607 + default: &606 value: - id: 3 name: Octocat's GPG Key @@ -90669,7 +90296,7 @@ paths: revoked: false raw_key: string headers: - Link: *39 + Link: *51 '304': *37 '404': *7 '403': *29 @@ -90722,9 +90349,9 @@ paths: description: Response content: application/json: - schema: *583 + schema: *582 examples: - default: &584 + default: &583 value: id: 3 name: Octocat's GPG Key @@ -90781,7 +90408,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &585 + - &584 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -90793,9 +90420,9 @@ paths: description: Response content: application/json: - schema: *583 + schema: *582 examples: - default: *584 + default: *583 '404': *7 '304': *37 '403': *29 @@ -90818,7 +90445,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *585 + - *584 responses: '204': description: Response @@ -90961,7 +90588,7 @@ paths: suspended_at: suspended_by: headers: - Link: *39 + Link: *51 '304': *37 '403': *29 '401': *25 @@ -91007,11 +90634,11 @@ paths: type: string repositories: type: array - items: *58 + items: *53 examples: - default: *586 + default: *585 headers: - Link: *39 + Link: *51 '404': *7 '403': *29 '304': *37 @@ -91034,7 +90661,7 @@ paths: url: https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *23 - - *104 + - *97 responses: '204': description: Response @@ -91060,7 +90687,7 @@ paths: url: https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *23 - - *104 + - *97 responses: '204': description: Response @@ -91094,12 +90721,12 @@ paths: application/json: schema: anyOf: - - *176 + - *169 - type: object properties: {} additionalProperties: false examples: - default: *177 + default: *170 '204': description: Response when there are no restrictions x-github: @@ -91123,7 +90750,7 @@ paths: required: true content: application/json: - schema: *446 + schema: *445 examples: default: value: @@ -91134,7 +90761,7 @@ paths: description: Response content: application/json: - schema: *176 + schema: *169 examples: default: value: @@ -91215,7 +90842,7 @@ paths: - closed - all default: open - - *182 + - *175 - name: sort description: What to sort results by. in: query @@ -91227,8 +90854,8 @@ paths: - updated - comments default: created - - *42 - - *65 + - *39 + - *60 - *18 - *20 responses: @@ -91238,11 +90865,11 @@ paths: application/json: schema: type: array - items: *75 + items: *70 examples: - default: *183 + default: *176 headers: - Link: *39 + Link: *51 '404': *7 '304': *37 x-github: @@ -91273,7 +90900,7 @@ paths: application/json: schema: type: array - items: &587 + items: &586 title: Key description: Key type: object @@ -91320,7 +90947,7 @@ paths: verified: false read_only: false headers: - Link: *39 + Link: *51 '304': *37 '404': *7 '403': *29 @@ -91370,9 +90997,9 @@ paths: description: Response content: application/json: - schema: *587 + schema: *586 examples: - default: &588 + default: &587 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -91405,15 +91032,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *475 + - *474 responses: '200': description: Response content: application/json: - schema: *587 + schema: *586 examples: - default: *588 + default: *587 '404': *7 '304': *37 '403': *29 @@ -91436,7 +91063,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *475 + - *474 responses: '204': description: Response @@ -91469,7 +91096,7 @@ paths: application/json: schema: type: array - items: &589 + items: &588 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -91526,7 +91153,7 @@ paths: - id - type - login - plan: *79 + plan: *74 required: - billing_cycle - next_billing_date @@ -91537,7 +91164,7 @@ paths: - account - plan examples: - default: &590 + default: &589 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -91570,7 +91197,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *39 + Link: *51 '304': *37 '401': *25 '404': *7 @@ -91599,11 +91226,11 @@ paths: application/json: schema: type: array - items: *589 + items: *588 examples: - default: *590 + default: *589 headers: - Link: *39 + Link: *51 '304': *37 '401': *25 x-github: @@ -91641,7 +91268,7 @@ paths: application/json: schema: type: array - items: *189 + items: *183 examples: default: value: @@ -91718,7 +91345,7 @@ paths: type: User site_admin: false headers: - Link: *39 + Link: *51 '304': *37 '403': *29 '401': *25 @@ -91743,13 +91370,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user parameters: - - *94 + - *87 responses: '200': description: Response content: application/json: - schema: *189 + schema: *183 examples: default: value: @@ -91807,7 +91434,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user parameters: - - *94 + - *87 requestBody: required: true content: @@ -91832,7 +91459,7 @@ paths: description: Response content: application/json: - schema: *189 + schema: *183 examples: default: value: @@ -91900,7 +91527,7 @@ paths: application/json: schema: type: array - items: *191 + items: *185 examples: default: value: @@ -92053,7 +91680,7 @@ paths: updated_at: '2015-07-06T15:33:38-07:00' node_id: MDQ6VXNlcjE= headers: - Link: *39 + Link: *51 '304': *37 '403': *29 '401': *25 @@ -92153,7 +91780,7 @@ paths: description: Response content: application/json: - schema: *191 + schema: *185 examples: default: value: @@ -92333,7 +91960,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status parameters: - - *192 + - *186 - name: exclude in: query required: false @@ -92346,7 +91973,7 @@ paths: description: Response content: application/json: - schema: *191 + schema: *185 examples: default: value: @@ -92540,7 +92167,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive parameters: - - *192 + - *186 responses: '302': description: Response @@ -92566,7 +92193,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive parameters: - - *192 + - *186 responses: '204': description: Response @@ -92595,8 +92222,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - - *192 - - *591 + - *186 + - *590 responses: '204': description: Response @@ -92620,7 +92247,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *192 + - *186 - *18 - *20 responses: @@ -92630,11 +92257,11 @@ paths: application/json: schema: type: array - items: *113 + items: *106 examples: - default: *205 + default: *199 headers: - Link: *39 + Link: *51 '404': *7 x-github: githubCloudOnly: false @@ -92667,11 +92294,11 @@ paths: application/json: schema: type: array - items: *188 + items: *182 examples: - default: *592 + default: *591 headers: - Link: *39 + Link: *51 '304': *37 '403': *29 '401': *25 @@ -92711,7 +92338,7 @@ paths: - docker - nuget - container - - *593 + - *592 - *20 - *18 responses: @@ -92721,10 +92348,10 @@ paths: application/json: schema: type: array - items: *199 + items: *193 examples: - default: *594 - '400': *595 + default: *593 + '400': *594 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -92744,16 +92371,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *201 - - *202 + - *195 + - *196 responses: '200': description: Response content: application/json: - schema: *199 + schema: *193 examples: - default: &608 + default: &607 value: id: 40201 name: octo-name @@ -92866,8 +92493,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *201 - - *202 + - *195 + - *196 responses: '204': description: Response @@ -92897,8 +92524,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *201 - - *202 + - *195 + - *196 - name: token description: package token schema: @@ -92930,8 +92557,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: - - *201 - - *202 + - *195 + - *196 - *20 - *18 - name: state @@ -92951,7 +92578,7 @@ paths: application/json: schema: type: array - items: *203 + items: *197 examples: default: value: @@ -93000,15 +92627,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *201 - - *202 - - *204 + - *195 + - *196 + - *198 responses: '200': description: Response content: application/json: - schema: *203 + schema: *197 examples: default: value: @@ -93044,9 +92671,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *201 - - *202 - - *204 + - *195 + - *196 + - *198 responses: '204': description: Response @@ -93076,9 +92703,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *201 - - *202 - - *204 + - *195 + - *196 + - *198 responses: '204': description: Response @@ -93134,7 +92761,7 @@ paths: description: Response content: application/json: - schema: *212 + schema: *206 examples: default: value: @@ -93203,11 +92830,11 @@ paths: application/json: schema: type: array - items: *582 + items: *581 examples: - default: *596 + default: *595 headers: - Link: *39 + Link: *51 '304': *37 '404': *7 '403': *29 @@ -93316,9 +92943,9 @@ paths: application/json: schema: type: array - items: *58 + items: *53 examples: - default: &603 + default: &602 summary: Default response value: - id: 1296269 @@ -93620,9 +93247,9 @@ paths: description: Response content: application/json: - schema: *266 + schema: *265 examples: - default: *268 + default: *267 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -93660,11 +93287,11 @@ paths: application/json: schema: type: array - items: *448 + items: *447 examples: - default: *597 + default: *596 headers: - Link: *39 + Link: *51 '304': *37 '404': *7 '403': *29 @@ -93685,12 +93312,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *180 + - *173 responses: '204': description: Response '403': *29 - '409': *134 + '409': *127 '404': *7 '304': *37 x-github: @@ -93708,11 +93335,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *180 + - *173 responses: '204': description: Response - '409': *134 + '409': *127 '304': *37 '404': *7 '403': *29 @@ -93741,7 +93368,7 @@ paths: application/json: schema: type: array - items: &598 + items: &597 title: Social account description: Social media account type: object @@ -93756,12 +93383,12 @@ paths: - provider - url examples: - default: &599 + default: &598 value: - provider: twitter url: https://twitter.com/github headers: - Link: *39 + Link: *51 '304': *37 '404': *7 '403': *29 @@ -93818,9 +93445,9 @@ paths: application/json: schema: type: array - items: *598 + items: *597 examples: - default: *599 + default: *598 '422': *16 '304': *37 '404': *7 @@ -93907,7 +93534,7 @@ paths: application/json: schema: type: array - items: &600 + items: &599 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -93927,7 +93554,7 @@ paths: - title - created_at examples: - default: &615 + default: &614 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -93940,7 +93567,7 @@ paths: title: ssh-rsa AAAAB3NzaC1yc2EAAB created_at: '2020-07-11T21:31:57Z' headers: - Link: *39 + Link: *51 '304': *37 '404': *7 '403': *29 @@ -93993,9 +93620,9 @@ paths: description: Response content: application/json: - schema: *600 + schema: *599 examples: - default: &601 + default: &600 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -94026,7 +93653,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: - - &602 + - &601 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -94038,9 +93665,9 @@ paths: description: Response content: application/json: - schema: *600 + schema: *599 examples: - default: *601 + default: *600 '404': *7 '304': *37 '403': *29 @@ -94063,7 +93690,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: - - *602 + - *601 responses: '204': description: Response @@ -94092,7 +93719,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &616 + - &615 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 @@ -94105,7 +93732,7 @@ paths: - created - updated default: created - - *42 + - *39 - *18 - *20 responses: @@ -94115,13 +93742,13 @@ paths: application/json: schema: type: array - items: *58 + items: *53 examples: - default-response: *603 + default-response: *602 application/vnd.github.v3.star+json: schema: type: array - items: &617 + items: &616 title: Starred Repository description: Starred Repository type: object @@ -94129,7 +93756,7 @@ paths: starred_at: type: string format: date-time - repo: *58 + repo: *53 required: - starred_at - repo @@ -94257,7 +93884,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *39 + Link: *51 '304': *37 '403': *29 '401': *25 @@ -94277,8 +93904,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: + - *254 - *255 - - *256 responses: '204': description: Response if this repository is starred by you @@ -94306,8 +93933,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: + - *254 - *255 - - *256 responses: '204': description: Response @@ -94331,8 +93958,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: + - *254 - *255 - - *256 responses: '204': description: Response @@ -94365,11 +93992,11 @@ paths: application/json: schema: type: array - items: *113 + items: *106 examples: - default: *205 + default: *199 headers: - Link: *39 + Link: *51 '304': *37 '403': *29 '401': *25 @@ -94404,7 +94031,7 @@ paths: application/json: schema: type: array - items: *240 + items: *239 examples: default: value: @@ -94455,7 +94082,7 @@ paths: updated_at: '2017-08-17T12:37:15Z' type: Organization headers: - Link: *39 + Link: *51 '304': *37 '404': *7 '403': *29 @@ -94480,7 +94107,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user-using-their-id parameters: - - *81 + - *76 responses: '200': description: Response @@ -94488,10 +94115,10 @@ paths: application/json: schema: oneOf: - - *575 - *574 + - *573 examples: - default-response: &605 + default-response: &604 summary: Default response value: login: octocat @@ -94526,7 +94153,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &606 + response-with-git-hub-plan-information: &605 summary: Response with GitHub plan information value: login: octocat @@ -94586,7 +94213,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *604 + - *603 - *18 responses: '200': @@ -94597,7 +94224,7 @@ paths: type: array items: *19 examples: - default: *184 + default: *177 headers: Link: example: ; rel="next" @@ -94625,7 +94252,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user parameters: - - *126 + - *119 responses: '200': description: Response @@ -94633,11 +94260,11 @@ paths: application/json: schema: oneOf: - - *575 - *574 + - *573 examples: - default-response: *605 - response-with-git-hub-plan-information: *606 + default-response: *604 + response-with-git-hub-plan-information: *605 '404': *7 x-github: githubCloudOnly: false @@ -94661,9 +94288,9 @@ paths: url: https://docs.github.com/rest/users/attestations#list-attestations parameters: - *18 - - *43 - - *44 - - *126 + - *40 + - *41 + - *119 - name: subject_digest description: Subject Digest in: path @@ -94756,6 +94383,8 @@ paths: type: string repository_id: type: integer + bundle_url: + type: string examples: default: value: @@ -94763,7 +94392,7 @@ paths: description: Response content: application/json: - schema: *122 + schema: *115 examples: default: value: @@ -94789,7 +94418,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: - - *126 + - *119 responses: '200': description: Response @@ -94797,9 +94426,9 @@ paths: application/json: schema: type: array - items: *199 + items: *193 examples: - default: *594 + default: *593 '403': *29 '401': *25 x-github: @@ -94822,7 +94451,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-for-the-authenticated-user parameters: - - *126 + - *119 - *18 - *20 responses: @@ -94832,7 +94461,7 @@ paths: application/json: schema: type: array - items: *87 + items: *82 examples: default: value: @@ -94903,8 +94532,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-organization-events-for-the-authenticated-user parameters: - - *126 - - *94 + - *119 + - *87 - *18 - *20 responses: @@ -94914,7 +94543,7 @@ paths: application/json: schema: type: array - items: *87 + items: *82 examples: default: value: @@ -94993,7 +94622,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-user parameters: - - *126 + - *119 - *18 - *20 responses: @@ -95003,7 +94632,7 @@ paths: application/json: schema: type: array - items: *87 + items: *82 examples: default: value: @@ -95070,7 +94699,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-followers-of-a-user parameters: - - *126 + - *119 - *18 - *20 responses: @@ -95082,9 +94711,9 @@ paths: type: array items: *19 examples: - default: *184 + default: *177 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95101,7 +94730,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-the-people-a-user-follows parameters: - - *126 + - *119 - *18 - *20 responses: @@ -95113,9 +94742,9 @@ paths: type: array items: *19 examples: - default: *184 + default: *177 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95132,7 +94761,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user parameters: - - *126 + - *119 - name: target_user in: path required: true @@ -95159,8 +94788,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-a-user parameters: - - *126 - - *65 + - *119 + - *60 - *18 - *20 responses: @@ -95170,11 +94799,11 @@ paths: application/json: schema: type: array - items: *66 + items: *61 examples: - default: *67 + default: *62 headers: - Link: *39 + Link: *51 '422': *16 x-github: githubCloudOnly: false @@ -95193,7 +94822,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user parameters: - - *126 + - *119 - *18 - *20 responses: @@ -95203,11 +94832,11 @@ paths: application/json: schema: type: array - items: *583 + items: *582 examples: - default: *607 + default: *606 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95229,7 +94858,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-contextual-information-for-a-user parameters: - - *126 + - *119 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -95301,7 +94930,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-user-installation-for-the-authenticated-app parameters: - - *126 + - *119 responses: '200': description: Response @@ -95309,7 +94938,7 @@ paths: application/json: schema: *22 examples: - default: *445 + default: *444 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -95327,7 +94956,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#list-public-keys-for-a-user parameters: - - *126 + - *119 - *18 - *20 responses: @@ -95355,7 +94984,7 @@ paths: - id: 1 key: ssh-rsa AAA... headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95375,7 +95004,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-organizations-for-a-user parameters: - - *126 + - *119 - *18 - *20 responses: @@ -95385,11 +95014,11 @@ paths: application/json: schema: type: array - items: *188 + items: *182 examples: - default: *592 + default: *591 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95426,8 +95055,8 @@ paths: - docker - nuget - container - - *593 - - *126 + - *592 + - *119 - *20 - *18 responses: @@ -95437,12 +95066,12 @@ paths: application/json: schema: type: array - items: *199 + items: *193 examples: - default: *594 + default: *593 '403': *29 '401': *25 - '400': *595 + '400': *594 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -95462,17 +95091,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user parameters: - - *201 - - *202 - - *126 + - *195 + - *196 + - *119 responses: '200': description: Response content: application/json: - schema: *199 + schema: *193 examples: - default: *608 + default: *607 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -95493,9 +95122,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user parameters: - - *201 - - *202 - - *126 + - *195 + - *196 + - *119 responses: '204': description: Response @@ -95527,9 +95156,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user parameters: - - *201 - - *202 - - *126 + - *195 + - *196 + - *119 - name: token description: package token schema: @@ -95561,9 +95190,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: - - *201 - - *202 - - *126 + - *195 + - *196 + - *119 responses: '200': description: Response @@ -95571,7 +95200,7 @@ paths: application/json: schema: type: array - items: *203 + items: *197 examples: default: value: @@ -95629,16 +95258,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user parameters: - - *201 - - *202 - - *204 - - *126 + - *195 + - *196 + - *198 + - *119 responses: '200': description: Response content: application/json: - schema: *203 + schema: *197 examples: default: value: @@ -95673,10 +95302,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user parameters: - - *201 - - *202 - - *126 - - *204 + - *195 + - *196 + - *119 + - *198 responses: '204': description: Response @@ -95708,10 +95337,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user parameters: - - *201 - - *202 - - *126 - - *204 + - *195 + - *196 + - *119 + - *198 responses: '204': description: Response @@ -95734,7 +95363,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-user-projects parameters: - - *126 + - *119 - name: state description: Indicates the state of the projects to return. in: query @@ -95755,7 +95384,7 @@ paths: application/json: schema: type: array - items: *212 + items: *206 examples: default: value: @@ -95791,7 +95420,7 @@ paths: created_at: '2011-04-10T20:09:31Z' updated_at: '2014-03-03T18:58:10Z' headers: - Link: *39 + Link: *51 '422': *16 x-github: githubCloudOnly: false @@ -95814,7 +95443,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-received-by-the-authenticated-user parameters: - - *126 + - *119 - *18 - *20 responses: @@ -95824,7 +95453,7 @@ paths: application/json: schema: type: array - items: *87 + items: *82 examples: default: value: @@ -95903,7 +95532,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-received-by-a-user parameters: - - *126 + - *119 - *18 - *20 responses: @@ -95913,7 +95542,7 @@ paths: application/json: schema: type: array - items: *87 + items: *82 examples: default: value: @@ -95990,7 +95619,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repositories-for-a-user parameters: - - *126 + - *119 - name: type description: Limit results to repositories of the specified type. in: query @@ -96033,11 +95662,11 @@ paths: application/json: schema: type: array - items: *113 + items: *106 examples: - default: *205 + default: *199 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96059,15 +95688,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-a-user parameters: - - *126 + - *119 responses: '200': description: Response content: application/json: - schema: *609 + schema: *608 examples: - default: *610 + default: *609 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -96089,15 +95718,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-a-user parameters: - - *126 + - *119 responses: '200': description: Response content: application/json: - schema: *611 + schema: *610 examples: - default: *612 + default: *611 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -96119,15 +95748,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-a-user parameters: - - *126 + - *119 responses: '200': description: Response content: application/json: - schema: *613 + schema: *612 examples: - default: *614 + default: *613 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -96145,7 +95774,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-a-user parameters: - - *126 + - *119 - *18 - *20 responses: @@ -96155,11 +95784,11 @@ paths: application/json: schema: type: array - items: *598 + items: *597 examples: - default: *599 + default: *598 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96177,7 +95806,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user parameters: - - *126 + - *119 - *18 - *20 responses: @@ -96187,11 +95816,11 @@ paths: application/json: schema: type: array - items: *600 + items: *599 examples: - default: *615 + default: *614 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96213,9 +95842,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *126 - - *616 - - *42 + - *119 + - *615 + - *39 - *18 - *20 responses: @@ -96226,13 +95855,13 @@ paths: schema: anyOf: - type: array - items: *617 + items: *616 - type: array - items: *58 + items: *53 examples: - default-response: *603 + default-response: *602 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96249,7 +95878,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *126 + - *119 - *18 - *20 responses: @@ -96259,11 +95888,11 @@ paths: application/json: schema: type: array - items: *113 + items: *106 examples: - default: *205 + default: *199 headers: - Link: *39 + Link: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96389,7 +96018,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &618 + enterprise: &617 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -96447,7 +96076,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &619 + installation: &618 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -96466,7 +96095,7 @@ x-webhooks: required: - id - node_id - organization: &620 + organization: &619 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -96526,13 +96155,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &621 + repository: &620 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &651 + properties: &650 id: description: Unique identifier of the repository example: 42 @@ -96552,8 +96181,8 @@ x-webhooks: title: License Simple description: License Simple type: object - properties: *76 - required: *77 + properties: *71 + required: *72 nullable: true organization: title: Simple User @@ -97215,7 +96844,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &652 + required: &651 - archive_url - assignees_url - blobs_url @@ -97366,10 +96995,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -97445,11 +97074,11 @@ x-webhooks: type: string enum: - created - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 - rule: &622 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 + rule: &621 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) @@ -97672,11 +97301,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 - rule: *622 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 + rule: *621 sender: *19 required: - action @@ -97859,11 +97488,11 @@ x-webhooks: - everyone required: - from - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 - rule: *622 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 + rule: *621 sender: *19 required: - action @@ -97947,7 +97576,7 @@ x-webhooks: type: string enum: - completed - check_run: &624 + check_run: &623 title: CheckRun description: A check performed on the code of a given code change type: object @@ -97961,8 +97590,8 @@ x-webhooks: first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 check_suite: description: A suite of checks performed on the code of a given code change @@ -98010,8 +97639,8 @@ x-webhooks: type: string pull_requests: type: array - items: *334 - repository: *113 + items: *333 + repository: *106 status: example: completed type: string @@ -98048,7 +97677,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *623 + deployment: *622 details_url: example: https://example.com type: string @@ -98098,7 +97727,7 @@ x-webhooks: - annotations_url pull_requests: type: array - items: *334 + items: *333 started_at: example: '2018-05-04T01:14:52Z' type: string @@ -98133,9 +97762,9 @@ x-webhooks: - output - app - pull_requests - installation: *619 - organization: *620 - repository: *621 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - check_run @@ -98528,10 +98157,10 @@ x-webhooks: type: string enum: - created - check_run: *624 - installation: *619 - organization: *620 - repository: *621 + check_run: *623 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - check_run @@ -98927,10 +98556,10 @@ x-webhooks: type: string enum: - requested_action - check_run: *624 - installation: *619 - organization: *620 - repository: *621 + check_run: *623 + installation: *618 + organization: *619 + repository: *620 requested_action: description: The action requested by the user. type: object @@ -99335,10 +98964,10 @@ x-webhooks: type: string enum: - rerequested - check_run: *624 - installation: *619 - organization: *620 - repository: *621 + check_run: *623 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - check_run @@ -100315,10 +99944,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -100988,10 +100617,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -101655,10 +101284,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -101958,20 +101587,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &625 + commit_oid: &624 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: *618 - installation: *619 - organization: *620 - ref: &626 + enterprise: *617 + installation: *618 + organization: *619 + ref: &625 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: *621 + repository: *620 sender: *19 required: - action @@ -102289,12 +101918,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *625 - enterprise: *618 - installation: *619 - organization: *620 - ref: *626 - repository: *621 + commit_oid: *624 + enterprise: *617 + installation: *618 + organization: *619 + ref: *625 + repository: *620 sender: *19 required: - action @@ -102389,7 +102018,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *350 + dismissed_comment: *349 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -102551,12 +102180,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *625 - enterprise: *618 - installation: *619 - organization: *620 - ref: *626 - repository: *621 + commit_oid: *624 + enterprise: *617 + installation: *618 + organization: *619 + ref: *625 + repository: *620 sender: *19 required: - action @@ -102877,12 +102506,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *625 - enterprise: *618 - installation: *619 - organization: *620 - ref: *626 - repository: *621 + commit_oid: *624 + enterprise: *617 + installation: *618 + organization: *619 + ref: *625 + repository: *620 sender: *19 required: - action @@ -103139,16 +102768,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *621 + repository: *620 sender: *19 required: - action @@ -103374,12 +103003,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *625 - enterprise: *618 - installation: *619 - organization: *620 - ref: *626 - repository: *621 + commit_oid: *624 + enterprise: *617 + installation: *618 + organization: *619 + ref: *625 + repository: *620 sender: *19 required: - action @@ -103636,10 +103265,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -103719,18 +103348,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *620 - pusher_type: &627 + organization: *619 + pusher_type: &626 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &628 + ref: &627 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -103740,7 +103369,7 @@ x-webhooks: enum: - tag - branch - repository: *621 + repository: *620 sender: *19 required: - ref @@ -103822,10 +103451,10 @@ x-webhooks: type: string enum: - created - definition: *213 - enterprise: *618 - installation: *619 - organization: *620 + definition: *207 + enterprise: *617 + installation: *618 + organization: *619 sender: *19 required: - action @@ -103910,9 +103539,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 sender: *19 required: - action @@ -103989,10 +103618,10 @@ x-webhooks: type: string enum: - updated - definition: *213 - enterprise: *618 - installation: *619 - organization: *620 + definition: *207 + enterprise: *617 + installation: *618 + organization: *619 sender: *19 required: - action @@ -104069,19 +103698,19 @@ x-webhooks: type: string enum: - updated - enterprise: *618 - installation: *619 - repository: *621 - organization: *620 + enterprise: *617 + installation: *618 + repository: *620 + organization: *619 sender: *19 new_property_values: type: array description: The new custom property values for the repository. - items: *217 + items: *211 old_property_values: type: array description: The old custom property values for the repository. - items: *217 + items: *211 required: - action - repository @@ -104157,18 +103786,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *618 - installation: *619 - organization: *620 - pusher_type: *627 - ref: *628 + enterprise: *617 + installation: *618 + organization: *619 + pusher_type: *626 + ref: *627 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *621 + repository: *620 sender: *19 required: - ref @@ -104252,11 +103881,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *404 - installation: *619 - organization: *620 - enterprise: *618 - repository: *621 + alert: *403 + installation: *618 + organization: *619 + enterprise: *617 + repository: *620 sender: *19 required: - action @@ -104340,11 +103969,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *404 - installation: *619 - organization: *620 - enterprise: *618 - repository: *621 + alert: *403 + installation: *618 + organization: *619 + enterprise: *617 + repository: *620 sender: *19 required: - action @@ -104428,11 +104057,11 @@ x-webhooks: type: string enum: - created - alert: *404 - installation: *619 - organization: *620 - enterprise: *618 - repository: *621 + alert: *403 + installation: *618 + organization: *619 + enterprise: *617 + repository: *620 sender: *19 required: - action @@ -104514,11 +104143,11 @@ x-webhooks: type: string enum: - dismissed - alert: *404 - installation: *619 - organization: *620 - enterprise: *618 - repository: *621 + alert: *403 + installation: *618 + organization: *619 + enterprise: *617 + repository: *620 sender: *19 required: - action @@ -104600,11 +104229,11 @@ x-webhooks: type: string enum: - fixed - alert: *404 - installation: *619 - organization: *620 - enterprise: *618 - repository: *621 + alert: *403 + installation: *618 + organization: *619 + enterprise: *617 + repository: *620 sender: *19 required: - action @@ -104687,11 +104316,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *404 - installation: *619 - organization: *620 - enterprise: *618 - repository: *621 + alert: *403 + installation: *618 + organization: *619 + enterprise: *617 + repository: *620 sender: *19 required: - action @@ -104773,11 +104402,11 @@ x-webhooks: type: string enum: - reopened - alert: *404 - installation: *619 - organization: *620 - enterprise: *618 - repository: *621 + alert: *403 + installation: *618 + organization: *619 + enterprise: *617 + repository: *620 sender: *19 required: - action @@ -104854,9 +104483,9 @@ x-webhooks: type: string enum: - created - enterprise: *618 - installation: *619 - key: &629 + enterprise: *617 + installation: *618 + key: &628 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -104892,8 +104521,8 @@ x-webhooks: - verified - created_at - read_only - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 required: - action @@ -104970,11 +104599,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *618 - installation: *619 - key: *629 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + key: *628 + organization: *619 + repository: *620 sender: *19 required: - action @@ -105535,12 +105164,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 - workflow: &633 + workflow: &632 title: Workflow type: object nullable: true @@ -106266,13 +105895,13 @@ x-webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *410 + deployment: *409 pull_requests: type: array - items: *495 - repository: *621 - organization: *620 - installation: *619 + items: *494 + repository: *620 + organization: *619 + installation: *618 sender: *19 responses: '200': @@ -106343,7 +105972,7 @@ x-webhooks: type: string enum: - approved - approver: &630 + approver: &629 type: object properties: avatar_url: @@ -106386,11 +106015,11 @@ x-webhooks: type: string comment: type: string - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 - reviewers: &631 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 + reviewers: &630 type: array items: type: object @@ -106469,7 +106098,7 @@ x-webhooks: sender: *19 since: type: string - workflow_job_run: &632 + workflow_job_run: &631 type: object properties: conclusion: @@ -107200,18 +106829,18 @@ x-webhooks: type: string enum: - rejected - approver: *630 + approver: *629 comment: type: string - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 - reviewers: *631 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 + reviewers: *630 sender: *19 since: type: string - workflow_job_run: *632 + workflow_job_run: *631 workflow_job_runs: type: array items: @@ -107915,13 +107544,13 @@ x-webhooks: type: string enum: - requested - enterprise: *618 + enterprise: *617 environment: type: string - installation: *619 - organization: *620 - repository: *621 - requestor: &638 + installation: *618 + organization: *619 + repository: *620 + requestor: &637 title: User type: object nullable: true @@ -109820,12 +109449,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 - workflow: *633 + workflow: *632 workflow_run: title: Deployment Workflow Run type: object @@ -110505,7 +110134,7 @@ x-webhooks: type: string enum: - answered - answer: &636 + answer: &635 type: object properties: author_association: @@ -110662,7 +110291,7 @@ x-webhooks: - created_at - updated_at - body - discussion: &634 + discussion: &633 title: Discussion description: A Discussion in a repository. type: object @@ -110948,7 +110577,7 @@ x-webhooks: - id labels: type: array - items: *457 + items: *456 required: - repository_url - category @@ -110970,10 +110599,10 @@ x-webhooks: - author_association - active_lock_reason - body - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -111100,11 +110729,11 @@ x-webhooks: - from required: - category - discussion: *634 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + discussion: *633 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -111187,11 +110816,11 @@ x-webhooks: type: string enum: - closed - discussion: *634 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + discussion: *633 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -111273,7 +110902,7 @@ x-webhooks: type: string enum: - created - comment: &635 + comment: &634 type: object properties: author_association: @@ -111430,11 +111059,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *634 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + discussion: *633 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -111517,12 +111146,12 @@ x-webhooks: type: string enum: - deleted - comment: *635 - discussion: *634 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + comment: *634 + discussion: *633 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -111617,12 +111246,12 @@ x-webhooks: - from required: - body - comment: *635 - discussion: *634 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + comment: *634 + discussion: *633 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -111706,11 +111335,11 @@ x-webhooks: type: string enum: - created - discussion: *634 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + discussion: *633 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -111792,11 +111421,11 @@ x-webhooks: type: string enum: - deleted - discussion: *634 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + discussion: *633 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -111896,11 +111525,11 @@ x-webhooks: type: string required: - from - discussion: *634 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + discussion: *633 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -111982,10 +111611,10 @@ x-webhooks: type: string enum: - labeled - discussion: *634 - enterprise: *618 - installation: *619 - label: &637 + discussion: *633 + enterprise: *617 + installation: *618 + label: &636 title: Label type: object properties: @@ -112017,8 +111646,8 @@ x-webhooks: - color - default - description - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 required: - action @@ -112101,11 +111730,11 @@ x-webhooks: type: string enum: - locked - discussion: *634 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + discussion: *633 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -112187,11 +111816,11 @@ x-webhooks: type: string enum: - pinned - discussion: *634 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + discussion: *633 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -112273,11 +111902,11 @@ x-webhooks: type: string enum: - reopened - discussion: *634 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + discussion: *633 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -112362,16 +111991,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *634 - new_repository: *621 + new_discussion: *633 + new_repository: *620 required: - new_discussion - new_repository - discussion: *634 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + discussion: *633 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -112454,10 +112083,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *634 - old_answer: *636 - organization: *620 - repository: *621 + discussion: *633 + old_answer: *635 + organization: *619 + repository: *620 sender: *19 required: - action @@ -112539,12 +112168,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *634 - enterprise: *618 - installation: *619 - label: *637 - organization: *620 - repository: *621 + discussion: *633 + enterprise: *617 + installation: *618 + label: *636 + organization: *619 + repository: *620 sender: *19 required: - action @@ -112627,11 +112256,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *634 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + discussion: *633 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -112713,11 +112342,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *634 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + discussion: *633 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -112790,7 +112419,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *618 + enterprise: *617 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -113450,9 +113079,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *619 - organization: *620 - repository: *621 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - forkee @@ -113598,9 +113227,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 pages: description: The pages that were updated. type: array @@ -113637,7 +113266,7 @@ x-webhooks: - action - sha - html_url - repository: *621 + repository: *620 sender: *19 required: - pages @@ -113713,10 +113342,10 @@ x-webhooks: type: string enum: - created - enterprise: *618 + enterprise: *617 installation: *22 - organization: *620 - repositories: &639 + organization: *619 + repositories: &638 description: An array of repository objects that the installation can access. type: array @@ -113742,8 +113371,8 @@ x-webhooks: - name - full_name - private - repository: *621 - requester: *638 + repository: *620 + requester: *637 sender: *19 required: - action @@ -113818,11 +113447,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *618 + enterprise: *617 installation: *22 - organization: *620 - repositories: *639 - repository: *621 + organization: *619 + repositories: *638 + repository: *620 requester: nullable: true sender: *19 @@ -113898,11 +113527,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *618 + enterprise: *617 installation: *22 - organization: *620 - repositories: *639 - repository: *621 + organization: *619 + repositories: *638 + repository: *620 requester: nullable: true sender: *19 @@ -113978,10 +113607,10 @@ x-webhooks: type: string enum: - added - enterprise: *618 + enterprise: *617 installation: *22 - organization: *620 - repositories_added: &640 + organization: *619 + repositories_added: &639 description: An array of repository objects, which were added to the installation. type: array @@ -114027,15 +113656,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *621 - repository_selection: &641 + repository: *620 + repository_selection: &640 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *638 + requester: *637 sender: *19 required: - action @@ -114114,10 +113743,10 @@ x-webhooks: type: string enum: - removed - enterprise: *618 + enterprise: *617 installation: *22 - organization: *620 - repositories_added: *640 + organization: *619 + repositories_added: *639 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -114144,9 +113773,9 @@ x-webhooks: - name - full_name - private - repository: *621 - repository_selection: *641 - requester: *638 + repository: *620 + repository_selection: *640 + requester: *637 sender: *19 required: - action @@ -114225,11 +113854,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *618 + enterprise: *617 installation: *22 - organization: *620 - repositories: *639 - repository: *621 + organization: *619 + repositories: *638 + repository: *620 requester: nullable: true sender: *19 @@ -114407,10 +114036,10 @@ x-webhooks: type: string required: - from - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 target_type: type: string @@ -114489,11 +114118,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *618 + enterprise: *617 installation: *22 - organization: *620 - repositories: *639 - repository: *621 + organization: *619 + repositories: *638 + repository: *620 requester: nullable: true sender: *19 @@ -114617,8 +114246,8 @@ x-webhooks: first class actors within GitHub. type: object nullable: true - properties: *59 - required: *60 + properties: *54 + required: *55 reactions: title: Reactions type: object @@ -114745,8 +114374,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -115901,8 +115530,8 @@ x-webhooks: - state - locked - assignee - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 required: - action @@ -115982,7 +115611,7 @@ x-webhooks: type: string enum: - deleted - comment: &642 + comment: &641 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -116147,8 +115776,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -117301,8 +116930,8 @@ x-webhooks: - state - locked - assignee - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 required: - action @@ -117382,7 +117011,7 @@ x-webhooks: type: string enum: - edited - changes: &670 + changes: &669 description: The changes to the comment. type: object properties: @@ -117394,9 +117023,9 @@ x-webhooks: type: string required: - from - comment: *642 - enterprise: *618 - installation: *619 + comment: *641 + enterprise: *617 + installation: *618 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -118550,8 +118179,8 @@ x-webhooks: - state - locked - assignee - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 required: - action @@ -118633,10 +118262,10 @@ x-webhooks: type: string enum: - assigned - assignee: *638 - enterprise: *618 - installation: *619 - issue: &645 + assignee: *637 + enterprise: *617 + installation: *618 + issue: &644 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -119554,8 +119183,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 required: - action @@ -119635,8 +119264,8 @@ x-webhooks: type: string enum: - closed - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -120694,8 +120323,8 @@ x-webhooks: required: - state - closed_at - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 required: - action @@ -120774,8 +120403,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -121686,8 +121315,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 required: - action @@ -121766,8 +121395,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -122681,7 +122310,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &643 + milestone: &642 title: Milestone description: A collection of related issues and pull requests. type: object @@ -122819,8 +122448,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 required: - action @@ -122919,8 +122548,8 @@ x-webhooks: type: string required: - from - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -123838,9 +123467,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *637 - organization: *620 - repository: *621 + label: *636 + organization: *619 + repository: *620 sender: *19 required: - action @@ -123920,8 +123549,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -124838,9 +124467,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *637 - organization: *620 - repository: *621 + label: *636 + organization: *619 + repository: *620 sender: *19 required: - action @@ -124920,8 +124549,8 @@ x-webhooks: type: string enum: - locked - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -125839,8 +125468,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 required: - action @@ -125919,8 +125548,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -126832,9 +126461,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *643 - organization: *620 - repository: *621 + milestone: *642 + organization: *619 + repository: *620 sender: *19 required: - action @@ -128295,8 +127924,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -129213,8 +128842,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 required: - action @@ -129294,9 +128923,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *618 - installation: *619 - issue: &644 + enterprise: *617 + installation: *618 + issue: &643 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -130207,8 +129836,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 required: - action @@ -130287,8 +129916,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -131205,8 +130834,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 required: - action @@ -132668,11 +132297,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *618 - installation: *619 - issue: *644 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + issue: *643 + organization: *619 + repository: *620 sender: *19 required: - action @@ -132753,7 +132382,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &673 + assignee: &672 title: User type: object nullable: true @@ -132823,11 +132452,11 @@ x-webhooks: required: - login - id - enterprise: *618 - installation: *619 - issue: *645 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + issue: *644 + organization: *619 + repository: *620 sender: *19 required: - action @@ -132906,12 +132535,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *618 - installation: *619 - issue: *645 - label: *637 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + issue: *644 + label: *636 + organization: *619 + repository: *620 sender: *19 required: - action @@ -132991,8 +132620,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -133908,8 +133537,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 required: - action @@ -133989,11 +133618,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *618 - installation: *619 - issue: *644 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + issue: *643 + organization: *619 + repository: *620 sender: *19 required: - action @@ -134072,11 +133701,11 @@ x-webhooks: type: string enum: - created - enterprise: *618 - installation: *619 - label: *637 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + label: *636 + organization: *619 + repository: *620 sender: *19 required: - action @@ -134154,11 +133783,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *618 - installation: *619 - label: *637 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + label: *636 + organization: *619 + repository: *620 sender: *19 required: - action @@ -134268,11 +133897,11 @@ x-webhooks: type: string required: - from - enterprise: *618 - installation: *619 - label: *637 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + label: *636 + organization: *619 + repository: *620 sender: *19 required: - action @@ -134354,9 +133983,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *618 - installation: *619 - marketplace_purchase: &646 + enterprise: *617 + installation: *618 + marketplace_purchase: &645 title: Marketplace Purchase type: object required: @@ -134439,8 +134068,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *620 - previous_marketplace_purchase: &647 + organization: *619 + previous_marketplace_purchase: &646 title: Marketplace Purchase type: object properties: @@ -134520,7 +134149,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *621 + repository: *620 sender: *19 required: - action @@ -134600,10 +134229,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *618 - installation: *619 - marketplace_purchase: *646 - organization: *620 + enterprise: *617 + installation: *618 + marketplace_purchase: *645 + organization: *619 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -134686,7 +134315,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *621 + repository: *620 sender: *19 required: - action @@ -134768,10 +134397,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *618 - installation: *619 - marketplace_purchase: *646 - organization: *620 + enterprise: *617 + installation: *618 + marketplace_purchase: *645 + organization: *619 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -134853,7 +134482,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *621 + repository: *620 sender: *19 required: - action @@ -134934,8 +134563,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 marketplace_purchase: title: Marketplace Purchase type: object @@ -135017,9 +134646,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *620 - previous_marketplace_purchase: *647 - repository: *621 + organization: *619 + previous_marketplace_purchase: *646 + repository: *620 sender: *19 required: - action @@ -135099,12 +134728,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *618 - installation: *619 - marketplace_purchase: *646 - organization: *620 - previous_marketplace_purchase: *647 - repository: *621 + enterprise: *617 + installation: *618 + marketplace_purchase: *645 + organization: *619 + previous_marketplace_purchase: *646 + repository: *620 sender: *19 required: - action @@ -135206,11 +134835,11 @@ x-webhooks: type: string required: - to - enterprise: *618 - installation: *619 - member: *638 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + member: *637 + organization: *619 + repository: *620 sender: *19 required: - action @@ -135310,11 +134939,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *618 - installation: *619 - member: *638 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + member: *637 + organization: *619 + repository: *620 sender: *19 required: - action @@ -135393,11 +135022,11 @@ x-webhooks: type: string enum: - removed - enterprise: *618 - installation: *619 - member: *638 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + member: *637 + organization: *619 + repository: *620 sender: *19 required: - action @@ -135475,11 +135104,11 @@ x-webhooks: type: string enum: - added - enterprise: *618 - installation: *619 - member: *638 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + member: *637 + organization: *619 + repository: *620 scope: description: The scope of the membership. Currently, can only be `team`. @@ -135555,7 +135184,7 @@ x-webhooks: required: - login - id - team: &648 + team: &647 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -135745,11 +135374,11 @@ x-webhooks: type: string enum: - removed - enterprise: *618 - installation: *619 - member: *638 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + member: *637 + organization: *619 + repository: *620 scope: description: The scope of the membership. Currently, can only be `team`. @@ -135826,7 +135455,7 @@ x-webhooks: required: - login - id - team: *648 + team: *647 required: - action - scope @@ -135908,8 +135537,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *619 - merge_group: &650 + installation: *618 + merge_group: &649 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -135928,15 +135557,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *649 + head_commit: *648 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 required: - action @@ -136022,10 +135651,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *619 - merge_group: *650 - organization: *620 - repository: *621 + installation: *618 + merge_group: *649 + organization: *619 + repository: *620 sender: *19 required: - action @@ -136098,7 +135727,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *618 + enterprise: *617 hook: description: 'The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -136206,16 +135835,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *619 - organization: *620 + installation: *618 + organization: *619 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *651 - required: *652 + properties: *650 + required: *651 nullable: true sender: *19 required: @@ -136296,11 +135925,11 @@ x-webhooks: type: string enum: - closed - enterprise: *618 - installation: *619 - milestone: *643 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + milestone: *642 + organization: *619 + repository: *620 sender: *19 required: - action @@ -136379,9 +136008,9 @@ x-webhooks: type: string enum: - created - enterprise: *618 - installation: *619 - milestone: &653 + enterprise: *617 + installation: *618 + milestone: &652 title: Milestone description: A collection of related issues and pull requests. type: object @@ -136518,8 +136147,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 required: - action @@ -136598,11 +136227,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *618 - installation: *619 - milestone: *643 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + milestone: *642 + organization: *619 + repository: *620 sender: *19 required: - action @@ -136712,11 +136341,11 @@ x-webhooks: type: string required: - from - enterprise: *618 - installation: *619 - milestone: *643 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + milestone: *642 + organization: *619 + repository: *620 sender: *19 required: - action @@ -136796,11 +136425,11 @@ x-webhooks: type: string enum: - opened - enterprise: *618 - installation: *619 - milestone: *653 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + milestone: *652 + organization: *619 + repository: *620 sender: *19 required: - action @@ -136879,11 +136508,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *638 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + blocked_user: *637 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -136962,11 +136591,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *638 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + blocked_user: *637 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -137045,9 +136674,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *618 - installation: *619 - membership: &654 + enterprise: *617 + installation: *618 + membership: &653 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -137139,8 +136768,8 @@ x-webhooks: - role - organization_url - user - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 required: - action @@ -137218,11 +136847,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *618 - installation: *619 - membership: *654 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + membership: *653 + organization: *619 + repository: *620 sender: *19 required: - action @@ -137301,8 +136930,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -137418,10 +137047,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 - user: *638 + user: *637 required: - action - invitation @@ -137499,11 +137128,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *618 - installation: *619 - membership: *654 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + membership: *653 + organization: *619 + repository: *620 sender: *19 required: - action @@ -137590,11 +137219,11 @@ x-webhooks: properties: from: type: string - enterprise: *618 - installation: *619 - membership: *654 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + membership: *653 + organization: *619 + repository: *620 sender: *19 required: - action @@ -137670,9 +137299,9 @@ x-webhooks: type: string enum: - published - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 package: description: Information about the package. type: object @@ -138171,7 +137800,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &655 + items: &654 title: Ruby Gems metadata type: object properties: @@ -138266,7 +137895,7 @@ x-webhooks: - owner - package_version - registry - repository: *621 + repository: *620 sender: *19 required: - action @@ -138342,9 +137971,9 @@ x-webhooks: type: string enum: - updated - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 package: description: Information about the package. type: object @@ -138697,7 +138326,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *655 + items: *654 source_url: type: string format: uri @@ -138767,7 +138396,7 @@ x-webhooks: - owner - package_version - registry - repository: *621 + repository: *620 sender: *19 required: - action @@ -138944,12 +138573,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *618 + enterprise: *617 id: type: integer - installation: *619 - organization: *620 - repository: *621 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - id @@ -139029,7 +138658,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &656 + personal_access_token_request: &655 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -139175,10 +138804,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *618 - organization: *620 + enterprise: *617 + organization: *619 sender: *19 - installation: *619 + installation: *618 required: - action - personal_access_token_request @@ -139257,11 +138886,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *656 - enterprise: *618 - organization: *620 + personal_access_token_request: *655 + enterprise: *617 + organization: *619 sender: *19 - installation: *619 + installation: *618 required: - action - personal_access_token_request @@ -139339,11 +138968,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *656 - enterprise: *618 - organization: *620 + personal_access_token_request: *655 + enterprise: *617 + organization: *619 sender: *19 - installation: *619 + installation: *618 required: - action - personal_access_token_request @@ -139420,11 +139049,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *656 - organization: *620 - enterprise: *618 + personal_access_token_request: *655 + organization: *619 + enterprise: *617 sender: *19 - installation: *619 + installation: *618 required: - action - personal_access_token_request @@ -139528,7 +139157,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *657 + last_response: *656 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -139560,8 +139189,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 zen: description: Random string of GitHub zen. @@ -139806,10 +139435,10 @@ x-webhooks: - from required: - note - enterprise: *618 - installation: *619 - organization: *620 - project_card: &658 + enterprise: *617 + installation: *618 + organization: *619 + project_card: &657 title: Project Card type: object properties: @@ -139928,7 +139557,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *621 + repository: *620 sender: *19 required: - action @@ -140009,11 +139638,11 @@ x-webhooks: type: string enum: - created - enterprise: *618 - installation: *619 - organization: *620 - project_card: *658 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + project_card: *657 + repository: *620 sender: *19 required: - action @@ -140093,9 +139722,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 project_card: title: Project Card type: object @@ -140223,8 +139852,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *651 - required: *652 + properties: *650 + required: *651 nullable: true sender: *19 required: @@ -140318,11 +139947,11 @@ x-webhooks: - from required: - note - enterprise: *618 - installation: *619 - organization: *620 - project_card: *658 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + project_card: *657 + repository: *620 sender: *19 required: - action @@ -140416,9 +140045,9 @@ x-webhooks: - from required: - column_id - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 project_card: allOf: - title: Project Card @@ -140608,7 +140237,7 @@ x-webhooks: type: string required: - after_id - repository: *621 + repository: *620 sender: *19 required: - action @@ -140688,10 +140317,10 @@ x-webhooks: type: string enum: - closed - enterprise: *618 - installation: *619 - organization: *620 - project: &660 + enterprise: *617 + installation: *618 + organization: *619 + project: &659 title: Project type: object properties: @@ -140815,7 +140444,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *621 + repository: *620 sender: *19 required: - action @@ -140895,10 +140524,10 @@ x-webhooks: type: string enum: - created - enterprise: *618 - installation: *619 - organization: *620 - project_column: &659 + enterprise: *617 + installation: *618 + organization: *619 + project_column: &658 title: Project Column type: object properties: @@ -140937,7 +140566,7 @@ x-webhooks: - name - created_at - updated_at - repository: *621 + repository: *620 sender: *19 required: - action @@ -141016,18 +140645,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *618 - installation: *619 - organization: *620 - project_column: *659 + enterprise: *617 + installation: *618 + organization: *619 + project_column: *658 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *651 - required: *652 + properties: *650 + required: *651 nullable: true sender: *19 required: @@ -141117,11 +140746,11 @@ x-webhooks: type: string required: - from - enterprise: *618 - installation: *619 - organization: *620 - project_column: *659 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + project_column: *658 + repository: *620 sender: *19 required: - action @@ -141201,11 +140830,11 @@ x-webhooks: type: string enum: - moved - enterprise: *618 - installation: *619 - organization: *620 - project_column: *659 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + project_column: *658 + repository: *620 sender: *19 required: - action @@ -141285,11 +140914,11 @@ x-webhooks: type: string enum: - created - enterprise: *618 - installation: *619 - organization: *620 - project: *660 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + project: *659 + repository: *620 sender: *19 required: - action @@ -141369,18 +140998,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *618 - installation: *619 - organization: *620 - project: *660 + enterprise: *617 + installation: *618 + organization: *619 + project: *659 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *651 - required: *652 + properties: *650 + required: *651 nullable: true sender: *19 required: @@ -141482,11 +141111,11 @@ x-webhooks: type: string required: - from - enterprise: *618 - installation: *619 - organization: *620 - project: *660 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + project: *659 + repository: *620 sender: *19 required: - action @@ -141565,11 +141194,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *618 - installation: *619 - organization: *620 - project: *660 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + project: *659 + repository: *620 sender: *19 required: - action @@ -141650,9 +141279,9 @@ x-webhooks: type: string enum: - closed - installation: *619 - organization: *620 - projects_v2: &661 + installation: *618 + organization: *619 + projects_v2: &660 title: Projects v2 Project description: A projects v2 project type: object @@ -141795,9 +141424,9 @@ x-webhooks: type: string enum: - created - installation: *619 - organization: *620 - projects_v2: *661 + installation: *618 + organization: *619 + projects_v2: *660 sender: *19 required: - action @@ -141878,9 +141507,9 @@ x-webhooks: type: string enum: - deleted - installation: *619 - organization: *620 - projects_v2: *661 + installation: *618 + organization: *619 + projects_v2: *660 sender: *19 required: - action @@ -141997,9 +141626,9 @@ x-webhooks: type: string to: type: string - installation: *619 - organization: *620 - projects_v2: *661 + installation: *618 + organization: *619 + projects_v2: *660 sender: *19 required: - action @@ -142082,7 +141711,7 @@ x-webhooks: type: string enum: - archived - changes: &665 + changes: &664 type: object properties: archived_at: @@ -142096,9 +141725,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *619 - organization: *620 - projects_v2_item: &662 + installation: *618 + organization: *619 + projects_v2_item: &661 title: Projects v2 Item description: An item belonging to a project type: object @@ -142232,9 +141861,9 @@ x-webhooks: nullable: true to: type: string - installation: *619 - organization: *620 - projects_v2_item: *662 + installation: *618 + organization: *619 + projects_v2_item: *661 sender: *19 required: - action @@ -142316,9 +141945,9 @@ x-webhooks: type: string enum: - created - installation: *619 - organization: *620 - projects_v2_item: *662 + installation: *618 + organization: *619 + projects_v2_item: *661 sender: *19 required: - action @@ -142399,9 +142028,9 @@ x-webhooks: type: string enum: - deleted - installation: *619 - organization: *620 - projects_v2_item: *662 + installation: *618 + organization: *619 + projects_v2_item: *661 sender: *19 required: - action @@ -142507,7 +142136,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &663 + - &662 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -142525,7 +142154,7 @@ x-webhooks: required: - id - name - - &664 + - &663 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -142548,8 +142177,8 @@ x-webhooks: oneOf: - type: string - type: integer + - *662 - *663 - - *664 required: - field_value - type: object @@ -142565,9 +142194,9 @@ x-webhooks: nullable: true required: - body - installation: *619 - organization: *620 - projects_v2_item: *662 + installation: *618 + organization: *619 + projects_v2_item: *661 sender: *19 required: - action @@ -142662,9 +142291,9 @@ x-webhooks: to: type: string nullable: true - installation: *619 - organization: *620 - projects_v2_item: *662 + installation: *618 + organization: *619 + projects_v2_item: *661 sender: *19 required: - action @@ -142747,10 +142376,10 @@ x-webhooks: type: string enum: - restored - changes: *665 - installation: *619 - organization: *620 - projects_v2_item: *662 + changes: *664 + installation: *618 + organization: *619 + projects_v2_item: *661 sender: *19 required: - action @@ -142832,9 +142461,9 @@ x-webhooks: type: string enum: - reopened - installation: *619 - organization: *620 - projects_v2: *661 + installation: *618 + organization: *619 + projects_v2: *660 sender: *19 required: - action @@ -142915,9 +142544,9 @@ x-webhooks: type: string enum: - created - installation: *619 - organization: *620 - projects_v2_status_update: &666 + installation: *618 + organization: *619 + projects_v2_status_update: &665 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -143044,9 +142673,9 @@ x-webhooks: type: string enum: - deleted - installation: *619 - organization: *620 - projects_v2_status_update: *666 + installation: *618 + organization: *619 + projects_v2_status_update: *665 sender: *19 required: - action @@ -143182,9 +142811,9 @@ x-webhooks: type: string format: date nullable: true - installation: *619 - organization: *620 - projects_v2_status_update: *666 + installation: *618 + organization: *619 + projects_v2_status_update: *665 sender: *19 required: - action @@ -143255,10 +142884,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - repository @@ -143335,13 +142964,13 @@ x-webhooks: type: string enum: - assigned - assignee: *638 - enterprise: *618 - installation: *619 - number: &667 + assignee: *637 + enterprise: *617 + installation: *618 + number: &666 description: The pull request number. type: integer - organization: *620 + organization: *619 pull_request: title: Pull Request type: object @@ -145624,7 +145253,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *621 + repository: *620 sender: *19 required: - action @@ -145706,11 +145335,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 number: type: integer - organization: *620 + organization: *619 pull_request: title: Pull Request type: object @@ -147988,7 +147617,7 @@ x-webhooks: - draft reason: type: string - repository: *621 + repository: *620 sender: *19 required: - action @@ -148070,11 +147699,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 number: type: integer - organization: *620 + organization: *619 pull_request: title: Pull Request type: object @@ -150352,7 +149981,7 @@ x-webhooks: - draft reason: type: string - repository: *621 + repository: *620 sender: *19 required: - action @@ -150434,13 +150063,13 @@ x-webhooks: type: string enum: - closed - enterprise: *618 - installation: *619 - number: *667 - organization: *620 - pull_request: &668 + enterprise: *617 + installation: *618 + number: *666 + organization: *619 + pull_request: &667 allOf: - - *495 + - *494 - type: object properties: allow_auto_merge: @@ -150502,7 +150131,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *621 + repository: *620 sender: *19 required: - action @@ -150583,12 +150212,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *618 - installation: *619 - number: *667 - organization: *620 - pull_request: *668 - repository: *621 + enterprise: *617 + installation: *618 + number: *666 + organization: *619 + pull_request: *667 + repository: *620 sender: *19 required: - action @@ -150668,11 +150297,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *618 - milestone: *478 - number: *667 - organization: *620 - pull_request: &669 + enterprise: *617 + milestone: *477 + number: *666 + organization: *619 + pull_request: &668 title: Pull Request type: object properties: @@ -152935,7 +152564,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *621 + repository: *620 sender: *19 required: - action @@ -153014,11 +152643,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 number: type: integer - organization: *620 + organization: *619 pull_request: title: Pull Request type: object @@ -155300,7 +154929,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *621 + repository: *620 sender: *19 required: - action @@ -155424,12 +155053,12 @@ x-webhooks: type: string required: - from - enterprise: *618 - installation: *619 - number: *667 - organization: *620 - pull_request: *668 - repository: *621 + enterprise: *617 + installation: *618 + number: *666 + organization: *619 + pull_request: *667 + repository: *620 sender: *19 required: - action @@ -155509,11 +155138,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 number: type: integer - organization: *620 + organization: *619 pull_request: title: Pull Request type: object @@ -157780,7 +157409,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *621 + repository: *620 sender: *19 required: - action @@ -157860,11 +157489,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *618 - installation: *619 - label: *637 - number: *667 - organization: *620 + enterprise: *617 + installation: *618 + label: *636 + number: *666 + organization: *619 pull_request: title: Pull Request type: object @@ -160146,7 +159775,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *621 + repository: *620 sender: *19 required: - action @@ -160227,10 +159856,10 @@ x-webhooks: type: string enum: - locked - enterprise: *618 - installation: *619 - number: *667 - organization: *620 + enterprise: *617 + installation: *618 + number: *666 + organization: *619 pull_request: title: Pull Request type: object @@ -162510,7 +162139,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *621 + repository: *620 sender: *19 required: - action @@ -162590,12 +162219,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *618 - milestone: *478 - number: *667 - organization: *620 - pull_request: *669 - repository: *621 + enterprise: *617 + milestone: *477 + number: *666 + organization: *619 + pull_request: *668 + repository: *620 sender: *19 required: - action @@ -162674,12 +162303,12 @@ x-webhooks: type: string enum: - opened - enterprise: *618 - installation: *619 - number: *667 - organization: *620 - pull_request: *668 - repository: *621 + enterprise: *617 + installation: *618 + number: *666 + organization: *619 + pull_request: *667 + repository: *620 sender: *19 required: - action @@ -162760,12 +162389,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *618 - installation: *619 - number: *667 - organization: *620 - pull_request: *668 - repository: *621 + enterprise: *617 + installation: *618 + number: *666 + organization: *619 + pull_request: *667 + repository: *620 sender: *19 required: - action @@ -162845,12 +162474,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *618 - installation: *619 - number: *667 - organization: *620 - pull_request: *668 - repository: *621 + enterprise: *617 + installation: *618 + number: *666 + organization: *619 + pull_request: *667 + repository: *620 sender: *19 required: - action @@ -163216,9 +162845,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 pull_request: type: object properties: @@ -165388,7 +165017,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *621 + repository: *620 sender: *19 required: - action @@ -165468,7 +165097,7 @@ x-webhooks: type: string enum: - deleted - comment: &671 + comment: &670 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -165753,9 +165382,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 pull_request: type: object properties: @@ -167913,7 +167542,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *621 + repository: *620 sender: *19 required: - action @@ -167993,11 +167622,11 @@ x-webhooks: type: string enum: - edited - changes: *670 - comment: *671 - enterprise: *618 - installation: *619 - organization: *620 + changes: *669 + comment: *670 + enterprise: *617 + installation: *618 + organization: *619 pull_request: type: object properties: @@ -170158,7 +169787,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *621 + repository: *620 sender: *19 required: - action @@ -170239,9 +169868,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 pull_request: title: Simple Pull Request type: object @@ -172414,7 +172043,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *621 + repository: *620 review: description: The review that was affected. type: object @@ -172657,9 +172286,9 @@ x-webhooks: type: string required: - from - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 pull_request: title: Simple Pull Request type: object @@ -174713,8 +174342,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *621 - review: &672 + repository: *620 + review: &671 description: The review that was affected. type: object properties: @@ -174943,12 +174572,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 number: description: The pull request number. type: integer - organization: *620 + organization: *619 pull_request: title: Pull Request type: object @@ -177231,7 +176860,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *621 + repository: *620 requested_reviewer: title: User type: object @@ -177315,12 +176944,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 number: description: The pull request number. type: integer - organization: *620 + organization: *619 pull_request: title: Pull Request type: object @@ -179610,7 +179239,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *621 + repository: *620 requested_team: title: Team description: Groups of organization members that gives permissions @@ -179802,12 +179431,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 number: description: The pull request number. type: integer - organization: *620 + organization: *619 pull_request: title: Pull Request type: object @@ -182092,7 +181721,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *621 + repository: *620 requested_reviewer: title: User type: object @@ -182177,12 +181806,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *618 - installation: *619 + enterprise: *617 + installation: *618 number: description: The pull request number. type: integer - organization: *620 + organization: *619 pull_request: title: Pull Request type: object @@ -184458,7 +184087,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *621 + repository: *620 requested_team: title: Team description: Groups of organization members that gives permissions @@ -184639,9 +184268,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 pull_request: title: Simple Pull Request type: object @@ -186816,8 +186445,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *621 - review: *672 + repository: *620 + review: *671 sender: *19 required: - action @@ -186897,9 +186526,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 pull_request: title: Simple Pull Request type: object @@ -188969,7 +188598,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *621 + repository: *620 sender: *19 thread: type: object @@ -189352,9 +188981,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 pull_request: title: Simple Pull Request type: object @@ -191410,7 +191039,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *621 + repository: *620 sender: *19 thread: type: object @@ -191796,10 +191425,10 @@ x-webhooks: type: string before: type: string - enterprise: *618 - installation: *619 - number: *667 - organization: *620 + enterprise: *617 + installation: *618 + number: *666 + organization: *619 pull_request: title: Pull Request type: object @@ -194070,7 +193699,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *621 + repository: *620 sender: *19 required: - action @@ -194152,11 +193781,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *673 - enterprise: *618 - installation: *619 - number: *667 - organization: *620 + assignee: *672 + enterprise: *617 + installation: *618 + number: *666 + organization: *619 pull_request: title: Pull Request type: object @@ -196439,7 +196068,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *621 + repository: *620 sender: *19 required: - action @@ -196518,11 +196147,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *618 - installation: *619 - label: *637 - number: *667 - organization: *620 + enterprise: *617 + installation: *618 + label: *636 + number: *666 + organization: *619 pull_request: title: Pull Request type: object @@ -198795,7 +198424,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *621 + repository: *620 sender: *19 required: - action @@ -198876,10 +198505,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *618 - installation: *619 - number: *667 - organization: *620 + enterprise: *617 + installation: *618 + number: *666 + organization: *619 pull_request: title: Pull Request type: object @@ -201144,7 +200773,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *621 + repository: *620 sender: *19 required: - action @@ -201344,7 +200973,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *618 + enterprise: *617 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -201436,8 +201065,8 @@ x-webhooks: - url - author - committer - installation: *619 - organization: *620 + installation: *618 + organization: *619 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -202012,9 +201641,9 @@ x-webhooks: type: string enum: - published - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 registry_package: type: object properties: @@ -202460,7 +202089,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *655 + items: *654 summary: type: string tag_name: @@ -202514,7 +202143,7 @@ x-webhooks: - owner - package_version - registry - repository: *621 + repository: *620 sender: *19 required: - action @@ -202592,9 +202221,9 @@ x-webhooks: type: string enum: - updated - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 registry_package: type: object properties: @@ -202902,7 +202531,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *655 + items: *654 summary: type: string tag_name: @@ -202951,7 +202580,7 @@ x-webhooks: - owner - package_version - registry - repository: *621 + repository: *620 sender: *19 required: - action @@ -203028,10 +202657,10 @@ x-webhooks: type: string enum: - created - enterprise: *618 - installation: *619 - organization: *620 - release: &674 + enterprise: *617 + installation: *618 + organization: *619 + release: &673 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -203336,7 +202965,7 @@ x-webhooks: - tarball_url - zipball_url - body - repository: *621 + repository: *620 sender: *19 required: - action @@ -203413,11 +203042,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *618 - installation: *619 - organization: *620 - release: *674 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + release: *673 + repository: *620 sender: *19 required: - action @@ -203525,11 +203154,11 @@ x-webhooks: type: boolean required: - to - enterprise: *618 - installation: *619 - organization: *620 - release: *674 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + release: *673 + repository: *620 sender: *19 required: - action @@ -203607,9 +203236,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -203918,7 +203547,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *621 + repository: *620 sender: *19 required: - action @@ -203994,10 +203623,10 @@ x-webhooks: type: string enum: - published - enterprise: *618 - installation: *619 - organization: *620 - release: &675 + enterprise: *617 + installation: *618 + organization: *619 + release: &674 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -204303,7 +203932,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *621 + repository: *620 sender: *19 required: - action @@ -204379,11 +204008,11 @@ x-webhooks: type: string enum: - released - enterprise: *618 - installation: *619 - organization: *620 - release: *674 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + release: *673 + repository: *620 sender: *19 required: - action @@ -204459,11 +204088,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *618 - installation: *619 - organization: *620 - release: *675 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + release: *674 + repository: *620 sender: *19 required: - action @@ -204539,11 +204168,11 @@ x-webhooks: type: string enum: - published - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 - repository_advisory: *549 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 + repository_advisory: *548 sender: *19 required: - action @@ -204619,11 +204248,11 @@ x-webhooks: type: string enum: - reported - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 - repository_advisory: *549 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 + repository_advisory: *548 sender: *19 required: - action @@ -204699,10 +204328,10 @@ x-webhooks: type: string enum: - archived - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -204779,10 +204408,10 @@ x-webhooks: type: string enum: - created - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -204860,10 +204489,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -204947,10 +204576,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -205062,10 +204691,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -205137,10 +204766,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 status: type: string @@ -205221,10 +204850,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -205301,10 +204930,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -205398,10 +205027,10 @@ x-webhooks: - name required: - repository - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -205481,11 +205110,11 @@ x-webhooks: type: string enum: - created - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 - repository_ruleset: *227 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 + repository_ruleset: *221 sender: *19 required: - action @@ -205563,11 +205192,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 - repository_ruleset: *227 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 + repository_ruleset: *221 sender: *19 required: - action @@ -205645,11 +205274,11 @@ x-webhooks: type: string enum: - edited - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 - repository_ruleset: *227 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 + repository_ruleset: *221 changes: type: object properties: @@ -205668,16 +205297,16 @@ x-webhooks: properties: added: type: array - items: *221 + items: *215 deleted: type: array - items: *221 + items: *215 updated: type: array items: type: object properties: - condition: *221 + condition: *215 changes: type: object properties: @@ -205710,16 +205339,16 @@ x-webhooks: properties: added: type: array - items: *226 + items: *220 deleted: type: array - items: *226 + items: *220 updated: type: array items: type: object properties: - rule: *226 + rule: *220 changes: type: object properties: @@ -205953,10 +205582,10 @@ x-webhooks: - from required: - owner - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -206034,10 +205663,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -206115,7 +205744,7 @@ x-webhooks: type: string enum: - create - alert: &676 + alert: &675 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -206236,10 +205865,10 @@ x-webhooks: type: string enum: - open - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -206445,10 +206074,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -206526,11 +206155,11 @@ x-webhooks: type: string enum: - reopen - alert: *676 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + alert: *675 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -206729,10 +206358,10 @@ x-webhooks: enum: - fixed - open - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -206810,11 +206439,11 @@ x-webhooks: type: string enum: - created - alert: &677 + alert: &676 type: object properties: - number: *48 - created_at: *49 + number: *46 + created_at: *47 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -206822,8 +206451,8 @@ x-webhooks: format: date-time readOnly: true nullable: true - url: *50 - html_url: *51 + url: *48 + html_url: *49 locations_url: type: string format: uri @@ -206897,6 +206526,11 @@ x-webhooks: properties: *4 required: *5 nullable: true + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection + bypass. + nullable: true push_protection_bypass_request_comment: type: string description: An optional comment when requesting a push protection @@ -206916,10 +206550,10 @@ x-webhooks: description: Whether the detected secret was found in multiple repositories in the same organization or business. nullable: true - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -207000,11 +206634,11 @@ x-webhooks: type: string enum: - created - alert: *677 - installation: *619 - location: *678 - organization: *620 - repository: *621 + alert: *676 + installation: *618 + location: *677 + organization: *619 + repository: *620 sender: *19 required: - location @@ -207242,11 +206876,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *677 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + alert: *676 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -207324,11 +206958,11 @@ x-webhooks: type: string enum: - reopened - alert: *677 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + alert: *676 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -207406,11 +207040,11 @@ x-webhooks: type: string enum: - resolved - alert: *677 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + alert: *676 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -207488,11 +207122,11 @@ x-webhooks: type: string enum: - validated - alert: *677 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + alert: *676 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -207568,11 +207202,11 @@ x-webhooks: type: string enum: - published - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 - security_advisory: &679 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 + security_advisory: &678 description: The details of the security advisory, including summary, description, and severity. type: object @@ -207588,7 +207222,7 @@ x-webhooks: required: - vector_string - score - cvss_severities: *46 + cvss_severities: *43 cwes: type: array items: @@ -207755,11 +207389,11 @@ x-webhooks: type: string enum: - updated - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 - security_advisory: *679 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 + security_advisory: *678 sender: *19 required: - action @@ -207832,10 +207466,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -207852,7 +207486,7 @@ x-webhooks: required: - vector_string - score - cvss_severities: *46 + cvss_severities: *43 cwes: type: array items: @@ -208019,11 +207653,11 @@ x-webhooks: from: type: object properties: - security_and_analysis: *220 - enterprise: *618 - installation: *619 - organization: *620 - repository: *266 + security_and_analysis: *214 + enterprise: *617 + installation: *618 + organization: *619 + repository: *265 sender: *19 required: - changes @@ -208101,12 +207735,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 - sponsorship: &680 + sponsorship: &679 type: object properties: created_at: @@ -208407,12 +208041,12 @@ x-webhooks: type: string enum: - created - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 - sponsorship: *680 + sponsorship: *679 required: - action - sponsorship @@ -208500,12 +208134,12 @@ x-webhooks: type: string required: - from - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 - sponsorship: *680 + sponsorship: *679 required: - action - changes @@ -208582,17 +208216,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &681 + effective_date: &680 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: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 - sponsorship: *680 + sponsorship: *679 required: - action - sponsorship @@ -208666,7 +208300,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &682 + changes: &681 type: object properties: tier: @@ -208710,13 +208344,13 @@ x-webhooks: - from required: - tier - effective_date: *681 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + effective_date: *680 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 - sponsorship: *680 + sponsorship: *679 required: - action - changes @@ -208793,13 +208427,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *682 - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + changes: *681 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 - sponsorship: *680 + sponsorship: *679 required: - action - changes @@ -208873,10 +208507,10 @@ x-webhooks: type: string enum: - created - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 starred_at: description: 'The time the star was created. This is a timestamp @@ -208959,10 +208593,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 starred_at: description: 'The time the star was created. This is a timestamp @@ -209381,15 +209015,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *618 + enterprise: *617 id: description: The unique identifier of the status. type: integer - installation: *619 + installation: *618 name: type: string - organization: *620 - repository: *621 + organization: *619 + repository: *620 sender: *19 sha: description: The Commit SHA. @@ -209498,15 +209132,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *75 - parent_issue_repo: *58 + parent_issue: *70 + parent_issue_repo: *53 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *75 - installation: *619 - organization: *620 - repository: *621 + sub_issue: *70 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -209590,15 +209224,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *75 - parent_issue_repo: *58 + parent_issue: *70 + parent_issue_repo: *53 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *75 - installation: *619 - organization: *620 - repository: *621 + sub_issue: *70 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -209682,15 +209316,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *75 - sub_issue_repo: *58 + sub_issue: *70 + sub_issue_repo: *53 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *75 - installation: *619 - organization: *620 - repository: *621 + parent_issue: *70 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -209774,15 +209408,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *75 - sub_issue_repo: *58 + sub_issue: *70 + sub_issue_repo: *53 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *75 - installation: *619 - organization: *620 - repository: *621 + parent_issue: *70 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -209859,12 +209493,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 - team: &683 + team: &682 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -210054,9 +209688,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 repository: title: Repository description: A git repository @@ -210514,7 +210148,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *683 + team: *682 required: - action - team @@ -210590,9 +210224,9 @@ x-webhooks: type: string enum: - created - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 repository: title: Repository description: A git repository @@ -211050,7 +210684,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *683 + team: *682 required: - action - team @@ -211127,9 +210761,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 repository: title: Repository description: A git repository @@ -211587,7 +211221,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *683 + team: *682 required: - action - team @@ -211731,9 +211365,9 @@ x-webhooks: - from required: - permissions - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 repository: title: Repository description: A git repository @@ -212191,7 +211825,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *683 + team: *682 required: - action - changes @@ -212269,9 +211903,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *618 - installation: *619 - organization: *620 + enterprise: *617 + installation: *618 + organization: *619 repository: title: Repository description: A git repository @@ -212729,7 +212363,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *683 + team: *682 required: - action - team @@ -212805,10 +212439,10 @@ x-webhooks: type: string enum: - started - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 required: - action @@ -212881,16 +212515,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *618 + enterprise: *617 inputs: type: object nullable: true additionalProperties: true - installation: *619 - organization: *620 + installation: *618 + organization: *619 ref: type: string - repository: *621 + repository: *620 sender: *19 workflow: type: string @@ -212972,10 +212606,10 @@ x-webhooks: type: string enum: - completed - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 workflow_job: allOf: @@ -213212,7 +212846,7 @@ x-webhooks: type: string required: - conclusion - deployment: *410 + deployment: *409 required: - action - repository @@ -213291,10 +212925,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 workflow_job: allOf: @@ -213554,7 +213188,7 @@ x-webhooks: required: - status - steps - deployment: *410 + deployment: *409 required: - action - repository @@ -213633,10 +213267,10 @@ x-webhooks: type: string enum: - queued - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 workflow_job: type: object @@ -213771,7 +213405,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *410 + deployment: *409 required: - action - repository @@ -213850,10 +213484,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 workflow_job: type: object @@ -213989,7 +213623,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *410 + deployment: *409 required: - action - repository @@ -214069,12 +213703,12 @@ x-webhooks: type: string enum: - completed - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 - workflow: *633 + workflow: *632 workflow_run: title: Workflow Run type: object @@ -215073,12 +214707,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 - workflow: *633 + workflow: *632 workflow_run: title: Workflow Run type: object @@ -216062,12 +215696,12 @@ x-webhooks: type: string enum: - requested - enterprise: *618 - installation: *619 - organization: *620 - repository: *621 + enterprise: *617 + installation: *618 + organization: *619 + repository: *620 sender: *19 - workflow: *633 + workflow: *632 workflow_run: title: Workflow Run type: object diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json index 650de0485..cfc1c3640 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -26194,7 +26194,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-user-management" @@ -26834,7 +26834,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-metrics" @@ -27192,7 +27192,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-usage" @@ -29798,6 +29798,82 @@ } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Custom Property Set Payload", + "description": "Custom property set payload", + "type": "object", + "properties": { + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "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", @@ -30063,6 +30139,7011 @@ } } }, + "/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", + "nullable": true, + "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", + "nullable": true, + "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", + "nullable": true, + "properties": { + "href": { + "type": "string", + "description": "The html URL of the ruleset" + } + } + } + } + }, + "conditions": { + "nullable": true, + "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" + ] + } + ] + } + ] + } + ] + }, + "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", + "nullable": true, + "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", + "nullable": true, + "properties": { + "href": { + "type": "string", + "description": "The html URL of the ruleset" + } + } + } + } + }, + "conditions": { + "nullable": true, + "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" + ] + } + ] + } + ] + } + ] + }, + "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", + "nullable": true, + "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" + ] + } + } + }, + { + "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" + ] + } + } + } + ] + } + } + } + }, + "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": { + "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", + "nullable": true, + "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", + "nullable": true, + "properties": { + "href": { + "type": "string", + "description": "The html URL of the ruleset" + } + } + } + } + }, + "conditions": { + "nullable": true, + "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" + ] + } + ] + } + ] + } + ] + }, + "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" + } + }, + "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": [ + { + "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": { + "204": { + "description": "Response" + }, + "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}/secret-scanning/alerts": { "get": { "summary": "List secret scanning alerts for an enterprise", @@ -31088,6 +38169,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -31270,6 +38356,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", @@ -31361,6 +38448,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, @@ -33557,7 +40645,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-metrics" @@ -33924,7 +41012,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-usage" @@ -73093,6 +80181,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -128684,6 +135775,8 @@ "content": { "application/json": { "schema": { + "title": "Custom Property Set Payload", + "description": "Custom property set payload", "type": "object", "properties": { "value_type": { @@ -134854,7 +141947,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -134862,7 +141956,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -134871,7 +141966,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", @@ -134986,7 +142081,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", @@ -135453,6 +142548,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." @@ -136197,13 +143299,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", @@ -136253,7 +143356,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", @@ -136719,6 +143822,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." @@ -137392,7 +144502,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -137400,7 +144511,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -137409,7 +144521,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", @@ -137524,7 +144636,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", @@ -137991,6 +145103,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." @@ -139305,7 +146424,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -139313,7 +146433,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -139322,7 +146443,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", @@ -139437,7 +146558,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", @@ -139904,6 +147025,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." @@ -140674,12 +147802,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", @@ -140729,7 +147858,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", @@ -141195,6 +148324,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." @@ -141864,7 +149000,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -141872,7 +149009,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -141881,7 +149019,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", @@ -141996,7 +149134,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", @@ -142463,6 +149601,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." @@ -144308,6 +151453,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -144490,6 +151640,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", @@ -144581,6 +151732,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, @@ -166734,6 +173886,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": [ @@ -166834,6 +174010,12 @@ "used": 0, "remaining": 10, "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 } }, "rate": { @@ -197014,6 +204196,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -409489,6 +416674,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." @@ -410359,7 +417551,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -410367,7 +417560,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -410376,7 +417570,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", @@ -410491,7 +417685,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", @@ -410958,6 +418152,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." @@ -411717,7 +418918,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", @@ -412015,6 +419216,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." @@ -412678,7 +419886,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -412686,7 +419895,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -412695,7 +419905,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", @@ -412810,7 +420020,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", @@ -413277,6 +420487,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." @@ -414610,7 +421827,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -414618,7 +421836,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -414627,7 +421846,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", @@ -414742,7 +421961,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", @@ -415209,6 +422428,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." @@ -415983,7 +423209,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", @@ -416281,6 +423507,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." @@ -416940,7 +424173,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -416948,7 +424182,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -416957,7 +424192,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", @@ -417072,7 +424307,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", @@ -417539,6 +424774,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." @@ -418978,6 +426220,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -419088,6 +426335,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", @@ -419112,6 +426360,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, @@ -419672,6 +426921,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -419723,6 +426977,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, @@ -420330,6 +427585,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -420400,6 +427660,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", @@ -528555,6 +535816,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -564457,6 +571721,11 @@ "dismissed" ] }, + "reviewer_comment": { + "type": "string", + "description": "The comment the reviewer provided when responding to the exemption request.", + "nullable": true + }, "created_at": { "type": "string", "format": "date-time", @@ -566294,6 +573563,11 @@ "dismissed" ] }, + "reviewer_comment": { + "type": "string", + "description": "The comment the reviewer provided when responding to the exemption request.", + "nullable": true + }, "created_at": { "type": "string", "format": "date-time", @@ -568131,6 +575405,11 @@ "dismissed" ] }, + "reviewer_comment": { + "type": "string", + "description": "The comment the reviewer provided when responding to the exemption request.", + "nullable": true + }, "created_at": { "type": "string", "format": "date-time", @@ -569968,6 +577247,11 @@ "dismissed" ] }, + "reviewer_comment": { + "type": "string", + "description": "The comment the reviewer provided when responding to the exemption request.", + "nullable": true + }, "created_at": { "type": "string", "format": "date-time", @@ -570010,6 +577294,11 @@ "dismissed" ] }, + "reviewer_comment": { + "type": "string", + "description": "The comment the reviewer provided when responding to the exemption request.", + "nullable": true + }, "created_at": { "type": "string", "format": "date-time", @@ -571839,6 +579128,11 @@ "dismissed" ] }, + "reviewer_comment": { + "type": "string", + "description": "The comment the reviewer provided when responding to the exemption request.", + "nullable": true + }, "created_at": { "type": "string", "format": "date-time", @@ -571881,6 +579175,11 @@ "dismissed" ] }, + "reviewer_comment": { + "type": "string", + "description": "The comment the reviewer provided when responding to the exemption request.", + "nullable": true + }, "created_at": { "type": "string", "format": "date-time", @@ -573710,6 +581009,11 @@ "dismissed" ] }, + "reviewer_comment": { + "type": "string", + "description": "The comment the reviewer provided when responding to the exemption request.", + "nullable": true + }, "created_at": { "type": "string", "format": "date-time", @@ -575547,6 +582851,11 @@ "dismissed" ] }, + "reviewer_comment": { + "type": "string", + "description": "The comment the reviewer provided when responding to the exemption request.", + "nullable": true + }, "created_at": { "type": "string", "format": "date-time", @@ -577384,6 +584693,11 @@ "dismissed" ] }, + "reviewer_comment": { + "type": "string", + "description": "The comment the reviewer provided when responding to the exemption request.", + "nullable": true + }, "created_at": { "type": "string", "format": "date-time", @@ -579221,6 +586535,11 @@ "dismissed" ] }, + "reviewer_comment": { + "type": "string", + "description": "The comment the reviewer provided when responding to the exemption request.", + "nullable": true + }, "created_at": { "type": "string", "format": "date-time", @@ -579263,6 +586582,11 @@ "dismissed" ] }, + "reviewer_comment": { + "type": "string", + "description": "The comment the reviewer provided when responding to the exemption request.", + "nullable": true + }, "created_at": { "type": "string", "format": "date-time", @@ -581092,6 +588416,11 @@ "dismissed" ] }, + "reviewer_comment": { + "type": "string", + "description": "The comment the reviewer provided when responding to the exemption request.", + "nullable": true + }, "created_at": { "type": "string", "format": "date-time", @@ -581134,6 +588463,11 @@ "dismissed" ] }, + "reviewer_comment": { + "type": "string", + "description": "The comment the reviewer provided when responding to the exemption request.", + "nullable": true + }, "created_at": { "type": "string", "format": "date-time", @@ -1070639,7 +1077973,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -1070647,7 +1077982,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -1070656,7 +1077992,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", @@ -1070771,7 +1078107,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", @@ -1071238,6 +1078574,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." @@ -1073471,7 +1080814,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -1073479,7 +1080823,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -1073488,7 +1080833,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", @@ -1073603,7 +1080948,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", @@ -1074070,6 +1081415,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." @@ -1076303,7 +1083655,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -1076311,7 +1083664,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -1076320,7 +1083674,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", @@ -1076435,7 +1083789,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", @@ -1076902,6 +1084256,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." @@ -1077886,6 +1085247,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." @@ -1078698,6 +1086066,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." @@ -1079513,6 +1086888,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." @@ -1091356,6 +1098738,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -1093454,6 +1100841,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -1095968,6 +1103360,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -1098066,6 +1105463,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -1100164,6 +1107566,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -1102262,6 +1109669,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 817b69c9a..cb2dc4c22 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -846,7 +846,7 @@ paths: - subscriptions_url - type - url - type: &296 + type: &303 type: string description: The type of credit the user is receiving. enum: @@ -979,7 +979,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &149 + schema: &161 title: Validation Error Simple description: Validation Error Simple type: object @@ -1012,7 +1012,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &609 + - &616 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1130,7 +1130,7 @@ paths: GitHub. type: object nullable: true - properties: &107 + properties: &119 id: description: Unique identifier of the GitHub app example: 37 @@ -1219,7 +1219,7 @@ paths: type: string example: '"-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n"' - required: &108 + required: &120 - id - node_id - owner @@ -1524,7 +1524,7 @@ paths: schema: type: integer default: 30 - - &221 + - &233 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 @@ -1540,7 +1540,7 @@ paths: application/json: schema: type: array - items: &222 + items: &234 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1617,7 +1617,7 @@ paths: - installation_id - repository_id examples: - default: &223 + default: &235 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1649,7 +1649,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &619 + schema: &626 title: Scim Error description: Scim Error type: object @@ -1676,7 +1676,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &148 + schema: &160 title: Validation Error description: Validation Error type: object @@ -1745,7 +1745,7 @@ paths: description: Response content: application/json: - schema: &224 + schema: &236 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1859,7 +1859,7 @@ paths: - request - response examples: - default: &225 + default: &237 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1919,7 +1919,7 @@ paths: parameters: - *17 responses: - '202': &151 + '202': &163 description: Accepted content: application/json: @@ -2114,7 +2114,7 @@ paths: parameters: - *18 - *20 - - &112 + - &124 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) @@ -2840,7 +2840,7 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: &274 + properties: &287 id: description: Unique identifier of the repository example: 42 @@ -2860,7 +2860,7 @@ paths: title: License Simple description: License Simple type: object - properties: &123 + properties: &135 key: type: string example: mit @@ -2882,7 +2882,7 @@ paths: html_url: type: string format: uri - required: &124 + required: &136 - key - name - url @@ -3269,7 +3269,7 @@ paths: type: boolean description: Whether anonymous git access is enabled for this repository - required: &275 + required: &288 - archive_url - assignees_url - blobs_url @@ -7282,7 +7282,7 @@ paths: description: Response content: application/json: - schema: &152 + schema: &164 type: object properties: total_active_caches_count: @@ -7297,7 +7297,7 @@ paths: - total_active_caches_count - total_active_caches_size_in_bytes examples: - default: &153 + default: &165 value: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 @@ -7391,7 +7391,7 @@ paths: - all - local_only - selected - selected_actions_url: &156 + selected_actions_url: &168 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` @@ -7759,7 +7759,7 @@ paths: description: Success response content: application/json: - schema: &159 + schema: &171 type: object properties: default_workflow_permissions: &46 @@ -7807,7 +7807,7 @@ paths: required: true content: application/json: - schema: &160 + schema: &172 type: object properties: default_workflow_permissions: *46 @@ -8628,7 +8628,7 @@ paths: application/json: schema: type: array - items: &164 + items: &176 title: Runner Application description: Runner Application type: object @@ -8653,7 +8653,7 @@ paths: - download_url - filename examples: - default: &165 + default: &177 value: - os: osx architecture: x64 @@ -8737,7 +8737,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &166 + '201': &178 description: Response content: application/json: @@ -8847,7 +8847,7 @@ paths: - token - expires_at examples: - default: &167 + default: &179 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -8887,7 +8887,7 @@ paths: application/json: schema: *58 examples: - default: &168 + default: &180 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -8919,7 +8919,7 @@ paths: application/json: schema: *55 examples: - default: &169 + default: &181 value: id: 23 name: MBP @@ -9133,7 +9133,7 @@ paths: - *40 - *54 responses: - '200': &170 + '200': &182 description: Response content: application/json: @@ -9189,7 +9189,7 @@ paths: parameters: - *40 - *54 - - &171 + - &183 name: name description: The name of a self-hosted runner's custom label. in: path @@ -9280,7 +9280,7 @@ paths: required: true content: application/json: - schema: &178 + schema: &190 title: Enterprise Announcement description: Enterprise global announcement type: object @@ -9351,7 +9351,7 @@ paths: required: false schema: type: string - - &179 + - &191 name: include description: |- The event types to include: @@ -9369,7 +9369,7 @@ paths: - web - git - all - - &180 + - &192 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. @@ -9377,7 +9377,7 @@ paths: required: false schema: type: string - - &181 + - &193 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. @@ -9385,7 +9385,7 @@ paths: required: false schema: type: string - - &182 + - &194 name: order description: |- The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. @@ -9407,7 +9407,7 @@ paths: application/json: schema: type: array - items: &183 + items: &195 type: object properties: "@timestamp": @@ -9529,7 +9529,7 @@ paths: description: The repository visibility, for example `public` or `private`. examples: - default: &184 + default: &196 value: - "@timestamp": 1606929874512 action: team.add_member @@ -10091,7 +10091,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise parameters: - *40 - - &186 + - &198 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`, @@ -10101,7 +10101,7 @@ paths: schema: &79 type: string description: The name of the tool used to generate the code scanning analysis. - - &187 + - &199 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 @@ -10124,7 +10124,7 @@ paths: be returned. in: query required: false - schema: &188 + schema: &200 type: string description: State of a code scanning alert. enum: @@ -10149,7 +10149,7 @@ paths: application/json: schema: type: array - items: &189 + items: &201 type: object properties: number: &85 @@ -10178,7 +10178,7 @@ paths: description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &406 + instances_url: &413 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -10213,7 +10213,7 @@ paths: format: date-time readOnly: true nullable: true - dismissed_reason: &407 + dismissed_reason: &414 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -10222,13 +10222,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &408 + dismissed_comment: &415 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &409 + rule: &416 type: object properties: id: @@ -10281,7 +10281,7 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &410 + tool: &417 type: object properties: name: *79 @@ -10291,15 +10291,15 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *80 - most_recent_instance: &411 + most_recent_instance: &418 type: object properties: - ref: &404 + ref: &411 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &417 + analysis_key: &424 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -10310,7 +10310,7 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &418 + category: &425 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -10648,7 +10648,7 @@ paths: - most_recent_instance - repository examples: - default: &190 + default: &202 value: - number: 4 created_at: '2020-02-13T12:29:18Z' @@ -10879,7 +10879,7 @@ paths: headers: Link: *39 '404': *7 - '503': &100 + '503': &112 description: Service unavailable content: application/json: @@ -11288,7 +11288,7 @@ paths: or enterprise teams are only counted once. seats: type: array - items: &197 + items: &209 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -11306,7 +11306,7 @@ paths: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - &243 + - &255 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -11365,7 +11365,7 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: &256 + properties: &268 id: description: Unique identifier of the team type: integer @@ -11421,7 +11421,7 @@ paths: maps to within LDAP environment example: uid=example,ou=users,dc=github,dc=com type: string - required: &257 + required: &269 - id - node_id - url @@ -11536,7 +11536,7 @@ paths: - created_at additionalProperties: false examples: - default: &198 + default: &210 value: total_seats: 2 seats: @@ -11614,7 +11614,7 @@ paths: '403': *29 '404': *7 x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-user-management @@ -11671,7 +11671,7 @@ paths: application/json: schema: type: array - items: &102 + items: &114 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -11979,7 +11979,7 @@ paths: - date additionalProperties: true examples: - default: &103 + default: &115 value: - date: '2024-06-24' total_active_users: 24 @@ -12081,14 +12081,14 @@ paths: '500': *84 '403': *29 '404': *7 - '422': &104 + '422': &116 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 @@ -12151,7 +12151,7 @@ paths: application/json: schema: type: array - items: &105 + items: &117 title: Copilot Usage Metrics description: Summary of Copilot usage. type: object @@ -12307,7 +12307,7 @@ paths: '403': *29 '404': *7 x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-usage @@ -12330,7 +12330,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *40 - - &205 + - &217 name: state in: query description: |- @@ -12339,7 +12339,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &206 + - &218 name: severity in: query description: |- @@ -12348,7 +12348,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &207 + - &219 name: ecosystem in: query description: |- @@ -12357,14 +12357,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &208 + - &220 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 - - &209 + - &221 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -12374,7 +12374,7 @@ paths: enum: - development - runtime - - &210 + - &222 name: sort in: query description: |- @@ -12390,7 +12390,7 @@ paths: - *78 - *76 - *77 - - &211 + - &223 name: first description: |- **Deprecated**. The number of results per page (max 100), starting from the first matching result. @@ -12403,7 +12403,7 @@ paths: minimum: 1 maximum: 100 default: 30 - - &212 + - &224 name: last description: |- **Deprecated**. The number of results per page (max 100), starting from the last matching result. @@ -12423,7 +12423,7 @@ paths: application/json: schema: type: array - items: &213 + items: &225 type: object description: A Dependabot alert. properties: @@ -12473,7 +12473,7 @@ paths: enum: - development - runtime - security_advisory: &460 + security_advisory: &467 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -12704,7 +12704,7 @@ paths: nullable: true maxLength: 280 fixed_at: *94 - auto_dismissed_at: &461 + auto_dismissed_at: &468 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -12730,7 +12730,7 @@ paths: - repository additionalProperties: false examples: - default: &214 + default: &226 value: - number: 2 state: dismissed @@ -13376,6 +13376,61 @@ paths: parameters: - *40 - *98 + requestBody: + required: true + content: + application/json: + schema: &285 + title: Custom Property Set Payload + description: Custom property set payload + type: object + properties: + value_type: + type: string + example: single_select + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + nullable: true + description: Default value of the property + description: + type: string + nullable: true + description: Short description of the property + allowed_values: + type: array + items: + type: string + maxLength: 75 + maxItems: 200 + nullable: true + 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 @@ -13410,7 +13465,7 @@ paths: - *40 - *98 responses: - '204': &192 + '204': &204 description: A header with no content is returned. '403': *29 '404': *7 @@ -13419,6 +13474,1259 @@ 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: + - *40 + 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: &106 + 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: &107 + 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 + nullable: true + 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: &111 + 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: + - &100 + 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 + - &103 + 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 + - &102 + 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: + - *100 + - &105 + 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: &101 + 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: *101 + required: + - repository_property + - *102 + - type: object + title: organization_id_and_repository_name + description: Conditions to target organizations by id and all + repositories + allOf: + - &104 + 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 + - *103 + - *102 + - type: object + title: organization_id_and_repository_property + description: Conditions to target organization by id and repositories + by property + allOf: + - *104 + - *105 + - *102 + rules: + type: array + description: An array of rules within the ruleset. + items: &108 + title: Repository Rule + type: object + description: A repository rule. + oneOf: + - &577 + title: creation + description: Only allow users with bypass permission to create + matching refs. + type: object + required: + - type + properties: + type: + type: string + enum: + - creation + - &578 + 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 + - &580 + title: deletion + description: Only allow users with bypass permissions to delete + matching refs. + type: object + required: + - type + properties: + type: + type: string + enum: + - deletion + - &581 + 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 + - &582 + 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 + - &583 + 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 + - &584 + title: required_signatures + description: Commits pushed to matching refs must have verified + signatures. + type: object + required: + - type + properties: + type: + type: string + enum: + - required_signatures + - &585 + 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 + - &586 + 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 + - &587 + 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 + - &588 + 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 + - &589 + 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 + - &590 + 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 + - &591 + 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 + - &592 + 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 + - &593 + 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 + - &594 + 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: &109 + 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: *106 + bypass_actors: + type: array + description: The actors that can bypass the rules in this ruleset + items: *107 + 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 + nullable: true + properties: + href: + type: string + description: The html URL of the ruleset + conditions: + nullable: true + anyOf: + - *102 + - &292 + 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: + - *102 + - *103 + - type: object + title: repository_id_and_ref_name + description: Conditions to target repositories by id and refs + by name + allOf: + - *102 + - 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: + - *102 + - *105 + rules: + type: array + items: *108 + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + examples: + default: &110 + 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': *7 + '500': *84 + 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: + - *40 + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: *109 + examples: + default: *110 + '404': *7 + '500': *84 + 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: + - *40 + - 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: *106 + bypass_actors: + type: array + description: The actors that can bypass the rules in this ruleset + items: *107 + conditions: *111 + rules: + description: An array of rules within the ruleset. + type: array + items: *108 + 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: *109 + examples: + default: *110 + '404': *7 + '500': *84 + 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: + - *40 + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Response + '404': *7 + '500': *84 + 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 @@ -13433,7 +14741,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - *40 - - &287 + - &294 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -13444,7 +14752,7 @@ paths: enum: - open - resolved - - &288 + - &295 name: secret_type in: query description: |- @@ -13454,7 +14762,7 @@ paths: required: false schema: type: string - - &289 + - &296 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -13463,7 +14771,7 @@ paths: required: false schema: type: string - - &290 + - &297 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. @@ -13479,7 +14787,7 @@ paths: - *18 - *76 - *77 - - &291 + - &298 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -13488,7 +14796,7 @@ paths: required: false schema: type: string - - &292 + - &299 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -13497,7 +14805,7 @@ paths: schema: type: boolean default: false - - &293 + - &300 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -13513,7 +14821,7 @@ paths: application/json: schema: type: array - items: &294 + items: &301 type: object properties: number: *85 @@ -13532,14 +14840,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &601 + state: &608 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: &602 + resolution: &609 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -13599,6 +14907,11 @@ paths: properties: *4 required: *5 nullable: true + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection + bypass. + nullable: true push_protection_bypass_request_comment: type: string description: An optional comment when requesting a push protection @@ -13631,7 +14944,7 @@ paths: repositories in the same organization or enterprise. nullable: true examples: - default: &295 + default: &302 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -13768,6 +15081,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 @@ -13855,6 +15169,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: @@ -13864,7 +15179,7 @@ paths: headers: Link: *39 '404': *7 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -13892,7 +15207,7 @@ paths: description: Response content: application/json: - schema: &298 + schema: &305 type: object properties: total_minutes_used: @@ -13962,7 +15277,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &299 + default: &306 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -14000,7 +15315,7 @@ paths: description: Success content: application/json: - schema: &300 + schema: &307 type: object properties: total_advanced_security_committers: @@ -14055,7 +15370,7 @@ paths: required: - repositories examples: - default: &301 + default: &308 value: total_advanced_security_committers: 2 total_count: 2 @@ -14143,7 +15458,7 @@ paths: '400': *15 '403': *29 '500': *84 - '503': *100 + '503': *112 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -14164,7 +15479,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#add-users-to-a-cost-center parameters: - *40 - - &101 + - &113 name: cost_center_id description: The ID corresponding to the cost center. in: path @@ -14206,13 +15521,13 @@ paths: message: Resources successfully added to the cost center. '400': *15 '403': *29 - '409': &150 + '409': &162 description: Conflict content: application/json: schema: *3 '500': *84 - '503': *100 + '503': *112 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -14232,7 +15547,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#remove-users-from-a-cost-center parameters: - *40 - - *101 + - *113 requestBody: required: true content: @@ -14270,7 +15585,7 @@ paths: '400': *15 '403': *29 '500': *84 - '503': *100 + '503': *112 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -14298,7 +15613,7 @@ paths: description: Response content: application/json: - schema: &302 + schema: &309 type: object properties: total_gigabytes_bandwidth_used: @@ -14316,7 +15631,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &303 + default: &310 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -14348,7 +15663,7 @@ paths: description: Response content: application/json: - schema: &304 + schema: &311 type: object properties: days_left_in_billing_cycle: @@ -14366,7 +15681,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &305 + default: &312 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -14391,7 +15706,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-usage-report-for-an-enterprise parameters: - *40 - - &139 + - &151 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, @@ -14400,7 +15715,7 @@ paths: required: false schema: type: integer - - &140 + - &152 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. @@ -14408,7 +15723,7 @@ paths: required: false schema: type: integer - - &141 + - &153 name: day description: If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. @@ -14416,7 +15731,7 @@ paths: required: false schema: type: integer - - &142 + - &154 name: hour description: If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. @@ -14436,7 +15751,7 @@ paths: description: Response when getting a billing usage report content: application/json: - schema: &143 + schema: &155 type: object properties: usageItems: @@ -14489,7 +15804,7 @@ paths: - netAmount - organizationName examples: - default: &144 + default: &156 value: usageItems: - date: '2023-08-01' @@ -14506,7 +15821,7 @@ paths: '400': *15 '403': *29 '500': *84 - '503': *100 + '503': *112 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -14577,15 +15892,15 @@ paths: application/json: schema: type: array - items: *102 + items: *114 examples: - default: *103 + default: *115 '500': *84 '403': *29 '404': *7 - '422': *104 + '422': *116 x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-metrics @@ -14618,7 +15933,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-an-enterprise-team parameters: - *40 - - &255 + - &267 name: team_slug description: The slug of the team name. in: path @@ -14656,9 +15971,9 @@ paths: application/json: schema: type: array - items: *105 + items: *117 examples: - default: &199 + default: &211 value: - day: '2023-10-15' total_suggestions_count: 1000 @@ -14727,7 +16042,7 @@ paths: '403': *29 '404': *7 x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-usage @@ -14814,7 +16129,7 @@ paths: application/json: schema: type: array - items: &134 + items: &146 title: Event description: Event type: object @@ -14824,7 +16139,7 @@ paths: type: type: string nullable: true - actor: &106 + actor: &118 title: Actor description: Actor type: object @@ -14864,18 +16179,18 @@ paths: - id - name - url - org: *106 + org: *118 payload: type: object properties: action: type: string - issue: &122 + issue: &134 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &509 + properties: &516 id: type: integer format: int64 @@ -14986,7 +16301,7 @@ paths: description: A collection of related issues and pull requests. type: object - properties: &445 + properties: &452 url: type: string format: uri @@ -15056,7 +16371,7 @@ paths: format: date-time example: '2012-10-09T23:39:01Z' nullable: true - required: &446 + required: &453 - closed_issues - creator - description @@ -15145,9 +16460,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 - author_association: &109 + properties: *119 + required: *120 + author_association: &121 title: author_association type: string example: OWNER @@ -15161,7 +16476,7 @@ paths: - MEMBER - NONE - OWNER - reactions: &110 + reactions: &122 title: Reaction Rollup type: object properties: @@ -15211,7 +16526,7 @@ paths: - total - completed - percent_completed - required: &510 + required: &517 - assignee - closed_at - comments @@ -15233,7 +16548,7 @@ paths: - author_association - created_at - updated_at - comment: &507 + comment: &514 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -15281,7 +16596,7 @@ paths: issue_url: type: string format: uri - author_association: *109 + author_association: *121 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -15291,9 +16606,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 - reactions: *110 + properties: *119 + required: *120 + reactions: *122 required: - id - node_id @@ -15388,7 +16703,7 @@ paths: created_at: '2022-06-07T07:50:26Z' '304': *37 '403': *29 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15469,7 +16784,7 @@ paths: _links: type: object properties: - timeline: &111 + timeline: &123 title: Link With Type description: Hypermedia Link with Type type: object @@ -15481,17 +16796,17 @@ paths: required: - href - type - user: *111 - security_advisories: *111 - current_user: *111 - current_user_public: *111 - current_user_actor: *111 - current_user_organization: *111 + user: *123 + security_advisories: *123 + current_user: *123 + current_user_public: *123 + current_user_actor: *123 + current_user_organization: *123 current_user_organizations: type: array - items: *111 - repository_discussions: *111 - repository_discussions_category: *111 + items: *123 + repository_discussions: *123 + repository_discussions_category: *123 required: - timeline - user @@ -15553,7 +16868,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *112 + - *124 - *18 - *20 responses: @@ -15563,7 +16878,7 @@ paths: application/json: schema: type: array - items: &113 + items: &125 title: Base Gist description: Base Gist type: object @@ -15660,7 +16975,7 @@ paths: - created_at - updated_at examples: - default: &114 + default: &126 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -15781,7 +17096,7 @@ paths: description: Response content: application/json: - schema: &115 + schema: &127 title: Gist Simple description: Gist Simple type: object @@ -15798,7 +17113,7 @@ paths: url: type: string format: uri - user: &658 + user: &665 title: Public User description: Public User type: object @@ -16156,7 +17471,7 @@ paths: truncated: type: boolean examples: - default: &116 + default: &128 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -16259,7 +17574,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-public-gists parameters: - - *112 + - *124 - *18 - *20 responses: @@ -16269,9 +17584,9 @@ paths: application/json: schema: type: array - items: *113 + items: *125 examples: - default: *114 + default: *126 headers: Link: *39 '422': *16 @@ -16293,7 +17608,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-starred-gists parameters: - - *112 + - *124 - *18 - *20 responses: @@ -16303,9 +17618,9 @@ paths: application/json: schema: type: array - items: *113 + items: *125 examples: - default: *114 + default: *126 headers: Link: *39 '401': *25 @@ -16333,7 +17648,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist parameters: - - &117 + - &129 name: gist_id description: The unique identifier of the gist. in: path @@ -16345,10 +17660,10 @@ paths: description: Response content: application/json: - schema: *115 + schema: *127 examples: - default: *116 - '403': &120 + default: *128 + '403': &132 description: Forbidden Gist content: application/json: @@ -16396,7 +17711,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#update-a-gist parameters: - - *117 + - *129 requestBody: required: true content: @@ -16456,9 +17771,9 @@ paths: description: Response content: application/json: - schema: *115 + schema: *127 examples: - updateGist: *116 + updateGist: *128 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -16616,7 +17931,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#delete-a-gist parameters: - - *117 + - *129 responses: '204': description: Response @@ -16645,7 +17960,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#list-gist-comments parameters: - - *117 + - *129 - *18 - *20 responses: @@ -16655,7 +17970,7 @@ paths: application/json: schema: type: array - items: &118 + items: &130 title: Gist Comment description: A comment made to a gist. type: object @@ -16690,7 +18005,7 @@ paths: type: string format: date-time example: '2011-04-18T23:23:56Z' - author_association: *109 + author_association: *121 required: - url - id @@ -16755,7 +18070,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#create-a-gist-comment parameters: - - *117 + - *129 requestBody: required: true content: @@ -16780,9 +18095,9 @@ paths: description: Response content: application/json: - schema: *118 + schema: *130 examples: - default: &119 + default: &131 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -16840,8 +18155,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#get-a-gist-comment parameters: - - *117 - - &121 + - *129 + - &133 name: comment_id description: The unique identifier of the comment. in: path @@ -16854,12 +18169,12 @@ paths: description: Response content: application/json: - schema: *118 + schema: *130 examples: - default: *119 + default: *131 '304': *37 '404': *7 - '403': *120 + '403': *132 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -16881,8 +18196,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#update-a-gist-comment parameters: - - *117 - - *121 + - *129 + - *133 requestBody: required: true content: @@ -16907,9 +18222,9 @@ paths: description: Response content: application/json: - schema: *118 + schema: *130 examples: - default: *119 + default: *131 '404': *7 x-github: githubCloudOnly: false @@ -16926,8 +18241,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#delete-a-gist-comment parameters: - - *117 - - *121 + - *129 + - *133 responses: '204': description: Response @@ -16950,7 +18265,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-commits parameters: - - *117 + - *129 - *18 - *20 responses: @@ -17051,7 +18366,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-forks parameters: - - *117 + - *129 - *18 - *20 responses: @@ -17061,7 +18376,7 @@ paths: application/json: schema: type: array - items: *115 + items: *127 examples: default: value: @@ -17126,13 +18441,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#fork-a-gist parameters: - - *117 + - *129 responses: '201': description: Response content: application/json: - schema: *113 + schema: *125 examples: default: value: @@ -17203,7 +18518,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#check-if-a-gist-is-starred parameters: - - *117 + - *129 responses: '204': description: Response if gist is starred @@ -17233,7 +18548,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#star-a-gist parameters: - - *117 + - *129 responses: '204': description: Response @@ -17255,7 +18570,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#unstar-a-gist parameters: - - *117 + - *129 responses: '204': description: Response @@ -17284,7 +18599,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist-revision parameters: - - *117 + - *129 - name: sha in: path required: true @@ -17295,9 +18610,9 @@ paths: description: Response content: application/json: - schema: *115 + schema: *127 examples: - default: *116 + default: *128 '422': *16 '404': *7 '403': *29 @@ -17663,7 +18978,7 @@ paths: - closed - all default: open - - &244 + - &256 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -17682,7 +18997,7 @@ paths: - comments default: created - *78 - - *112 + - *124 - name: collab in: query required: false @@ -17712,9 +19027,9 @@ paths: application/json: schema: type: array - items: *122 + items: *134 examples: - default: &245 + default: &257 value: - id: 1 node_id: MDU6SXNzdWUx @@ -17998,8 +19313,8 @@ paths: title: License Simple description: License Simple type: object - properties: *123 - required: *124 + properties: *135 + required: *136 examples: default: value: @@ -18283,7 +19598,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &125 + X-CommonMarker-Version: &137 example: 0.17.4 schema: type: string @@ -18338,7 +19653,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *125 + X-CommonMarker-Version: *137 content: text/html: schema: @@ -18367,7 +19682,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: - - &128 + - &140 name: account_id description: account_id parameter in: path @@ -18379,7 +19694,7 @@ paths: description: Response content: application/json: - schema: &127 + schema: &139 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -18409,7 +19724,7 @@ paths: nullable: true id: type: integer - plan: &126 + plan: &138 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -18498,7 +19813,7 @@ paths: nullable: true updated_at: type: string - plan: *126 + plan: *138 required: - url - id @@ -18506,7 +19821,7 @@ paths: - login - marketplace_purchase examples: - default: &129 + default: &141 value: url: https://api.github.com/orgs/github type: Organization @@ -18591,9 +19906,9 @@ paths: application/json: schema: type: array - items: *126 + items: *138 examples: - default: &130 + default: &142 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -18633,14 +19948,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &131 + - &143 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &132 + - &144 name: sort description: The property to sort the results by. in: query @@ -18670,9 +19985,9 @@ paths: application/json: schema: type: array - items: *127 + items: *139 examples: - default: &133 + default: &145 value: - url: https://api.github.com/orgs/github type: Organization @@ -18746,15 +20061,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: - - *128 + - *140 responses: '200': description: Response content: application/json: - schema: *127 + schema: *139 examples: - default: *129 + default: *141 '404': description: Not Found when the account has not purchased the listing '401': *25 @@ -18786,9 +20101,9 @@ paths: application/json: schema: type: array - items: *126 + items: *138 examples: - default: *130 + default: *142 headers: Link: *39 '401': *25 @@ -18811,8 +20126,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *131 - - *132 + - *143 + - *144 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -18832,9 +20147,9 @@ paths: application/json: schema: type: array - items: *127 + items: *139 examples: - default: *133 + default: *145 headers: Link: *39 '401': *25 @@ -19083,14 +20398,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: - - &325 + - &332 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &326 + - &333 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -19107,7 +20422,7 @@ paths: application/json: schema: type: array - items: *134 + items: *146 examples: default: value: @@ -19161,7 +20476,7 @@ paths: '404': *7 '403': *29 '304': *37 - '301': &339 + '301': &346 description: Moved permanently content: application/json: @@ -19183,7 +20498,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &539 + - &546 name: all description: If `true`, show notifications marked as read. in: query @@ -19191,7 +20506,7 @@ paths: schema: type: boolean default: false - - &540 + - &547 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -19200,8 +20515,8 @@ paths: schema: type: boolean default: false - - *112 - - &541 + - *124 + - &548 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: @@ -19226,18 +20541,18 @@ paths: application/json: schema: type: array - items: &135 + items: &147 title: Thread description: Thread type: object properties: id: type: string - repository: &163 + repository: &175 title: Minimal Repository description: Minimal Repository type: object - properties: &216 + properties: &228 id: type: integer format: int64 @@ -19513,7 +20828,7 @@ paths: web_commit_signoff_required: type: boolean example: false - security_and_analysis: &276 + security_and_analysis: &289 nullable: true type: object properties: @@ -19577,7 +20892,7 @@ paths: enum: - enabled - disabled - required: &217 + required: &229 - archive_url - assignees_url - blobs_url @@ -19665,7 +20980,7 @@ paths: - url - subscription_url examples: - default: &542 + default: &549 value: - id: '1' repository: @@ -19831,7 +21146,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread parameters: - - &136 + - &148 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 @@ -19845,7 +21160,7 @@ paths: description: Response content: application/json: - schema: *135 + schema: *147 examples: default: value: @@ -19948,7 +21263,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-read parameters: - - *136 + - *148 responses: '205': description: Reset Content @@ -19971,7 +21286,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-done parameters: - - *136 + - *148 responses: '204': description: No content @@ -19994,13 +21309,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: - - *136 + - *148 responses: '200': description: Response content: application/json: - schema: &137 + schema: &149 title: Thread Subscription description: Thread Subscription type: object @@ -20037,7 +21352,7 @@ paths: - url - subscribed examples: - default: &138 + default: &150 value: subscribed: true ignored: false @@ -20068,7 +21383,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#set-a-thread-subscription parameters: - - *136 + - *148 requestBody: required: false content: @@ -20089,9 +21404,9 @@ paths: description: Response content: application/json: - schema: *137 + schema: *149 examples: - default: *138 + default: *150 '304': *37 '403': *29 '401': *25 @@ -20114,7 +21429,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#delete-a-thread-subscription parameters: - - *136 + - *148 responses: '204': description: Response @@ -20211,7 +21526,7 @@ paths: type: array items: *52 examples: - default: &676 + default: &683 value: - login: github id: 1 @@ -20275,7 +21590,7 @@ paths: type: integer custom_roles: type: array - items: &200 + items: &212 title: Organization Custom Repository Role description: Custom repository roles created by organization owners @@ -20323,7 +21638,7 @@ paths: - created_at - updated_at examples: - default: &201 + default: &213 value: id: 8030 name: Security Engineer @@ -20369,29 +21684,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: - - &145 + - &157 name: org description: The organization name. The name is not case sensitive. in: path required: true schema: type: string - - *139 - - *140 - - *141 - - *142 + - *151 + - *152 + - *153 + - *154 responses: '200': description: Billing usage report response for an organization content: application/json: - schema: *143 + schema: *155 examples: - default: *144 + default: *156 '400': *15 '403': *29 '500': *84 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20417,13 +21732,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-an-organization parameters: - - *145 + - *157 responses: '200': description: Response content: application/json: - schema: &146 + schema: &158 title: Organization Full description: |- Prevents users in the organization from using insecure methods of two-factor authentication to fulfill a two-factor requirement. @@ -20726,7 +22041,7 @@ paths: - updated_at - archived_at examples: - default-response: &147 + default-response: &159 value: login: github id: 1 @@ -20819,7 +22134,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#update-an-organization parameters: - - *145 + - *157 requestBody: required: false content: @@ -21042,18 +22357,18 @@ paths: description: Response content: application/json: - schema: *146 + schema: *158 examples: - default: *147 + default: *159 '422': description: Validation failed content: application/json: schema: oneOf: - - *148 - - *149 - '409': *150 + - *160 + - *161 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21076,9 +22391,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#delete-an-organization parameters: - - *145 + - *157 responses: - '202': *151 + '202': *163 '404': *7 '403': *29 x-github: @@ -21101,15 +22416,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: - - *145 + - *157 responses: '200': description: Response content: application/json: - schema: *152 + schema: *164 examples: - default: *153 + default: *165 headers: Link: *39 x-github: @@ -21132,7 +22447,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: - - *145 + - *157 - *18 - *20 responses: @@ -21150,7 +22465,7 @@ paths: type: integer repository_cache_usages: type: array - items: &344 + items: &351 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -21205,13 +22520,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: - - *145 + - *157 responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &154 + schema: &166 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -21225,7 +22540,7 @@ paths: required: - include_claim_keys examples: - default: &155 + default: &167 value: include_claim_keys: - repo @@ -21247,20 +22562,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: - - *145 + - *157 requestBody: required: true content: application/json: - schema: *154 + schema: *166 examples: - default: *155 + default: *167 responses: '201': description: Empty response content: application/json: - schema: &174 + schema: &186 title: Empty Object description: An object without any properties. type: object @@ -21290,7 +22605,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: - - *145 + - *157 responses: '200': description: Response @@ -21299,7 +22614,7 @@ paths: schema: type: object properties: - enabled_repositories: &157 + enabled_repositories: &169 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -21313,7 +22628,7 @@ paths: that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. allowed_actions: *42 - selected_actions_url: *156 + selected_actions_url: *168 required: - enabled_repositories examples: @@ -21342,7 +22657,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: - - *145 + - *157 responses: '204': description: Response @@ -21353,7 +22668,7 @@ paths: schema: type: object properties: - enabled_repositories: *157 + enabled_repositories: *169 allowed_actions: *42 required: - enabled_repositories @@ -21381,7 +22696,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: - - *145 + - *157 - *18 - *20 responses: @@ -21401,7 +22716,7 @@ paths: type: array items: *57 examples: - default: &670 + default: &677 value: total_count: 1 repositories: @@ -21541,7 +22856,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: - - *145 + - *157 responses: '204': description: Response @@ -21585,8 +22900,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: - - *145 - - &158 + - *157 + - &170 name: repository_id description: The unique identifier of the repository. in: path @@ -21614,8 +22929,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: - - *145 - - *158 + - *157 + - *170 responses: '204': description: Response @@ -21638,7 +22953,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: - - *145 + - *157 responses: '200': description: Response @@ -21669,7 +22984,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: - - *145 + - *157 responses: '204': description: Response @@ -21701,13 +23016,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: - - *145 + - *157 responses: '200': description: Response content: application/json: - schema: *159 + schema: *171 examples: default: *48 x-github: @@ -21730,7 +23045,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: - - *145 + - *157 responses: '204': description: Success response @@ -21741,7 +23056,7 @@ paths: required: false content: application/json: - schema: *160 + schema: *172 examples: default: *48 x-github: @@ -21763,7 +23078,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: - - *145 + - *157 - *18 - *20 - name: visible_to_repository @@ -21788,7 +23103,7 @@ paths: type: number runner_groups: type: array - items: &161 + items: &173 type: object properties: id: @@ -21900,7 +23215,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: - - *145 + - *157 requestBody: required: true content: @@ -21969,9 +23284,9 @@ paths: description: Response content: application/json: - schema: *161 + schema: *173 examples: - default: &162 + default: &174 value: id: 2 name: octo-runner-group @@ -22006,14 +23321,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: - - *145 + - *157 - *51 responses: '200': description: Response content: application/json: - schema: *161 + schema: *173 examples: default: value: @@ -22049,7 +23364,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: - - *145 + - *157 - *51 requestBody: required: true @@ -22100,9 +23415,9 @@ paths: description: Response content: application/json: - schema: *161 + schema: *173 examples: - default: *162 + default: *174 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -22121,7 +23436,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: - - *145 + - *157 - *51 responses: '204': @@ -22145,7 +23460,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: - - *145 + - *157 - *51 - *20 - *18 @@ -22164,9 +23479,9 @@ paths: type: number repositories: type: array - items: *163 + items: *175 examples: - default: &661 + default: &668 value: total_count: 1 repositories: @@ -22418,7 +23733,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: - - *145 + - *157 - *51 requestBody: required: true @@ -22463,9 +23778,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: - - *145 + - *157 - *51 - - *158 + - *170 responses: '204': description: Response @@ -22487,9 +23802,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: - - *145 + - *157 - *51 - - *158 + - *170 responses: '204': description: Response @@ -22512,7 +23827,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: - - *145 + - *157 - *51 - *18 - *20 @@ -22554,7 +23869,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: - - *145 + - *157 - *51 requestBody: required: true @@ -22599,7 +23914,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: - - *145 + - *157 - *51 - *54 responses: @@ -22623,7 +23938,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: - - *145 + - *157 - *51 - *54 responses: @@ -22655,7 +23970,7 @@ paths: in: query schema: type: string - - *145 + - *157 - *18 - *20 responses: @@ -22699,7 +24014,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: - - *145 + - *157 responses: '200': description: Response @@ -22707,9 +24022,9 @@ paths: application/json: schema: type: array - items: *164 + items: *176 examples: - default: *165 + default: *177 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22731,7 +24046,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: - - *145 + - *157 requestBody: required: true content: @@ -22774,7 +24089,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *166 + '201': *178 '404': *7 '422': *8 x-github: @@ -22804,7 +24119,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: - - *145 + - *157 responses: '201': description: Response @@ -22812,7 +24127,7 @@ paths: application/json: schema: *58 examples: - default: *167 + default: *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22840,7 +24155,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: - - *145 + - *157 responses: '201': description: Response @@ -22848,7 +24163,7 @@ paths: application/json: schema: *58 examples: - default: *168 + default: *180 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22870,7 +24185,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: - - *145 + - *157 - *54 responses: '200': @@ -22879,7 +24194,7 @@ paths: application/json: schema: *55 examples: - default: *169 + default: *181 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22900,7 +24215,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: - - *145 + - *157 - *54 responses: '204': @@ -22926,7 +24241,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: - - *145 + - *157 - *54 responses: '200': *60 @@ -22951,7 +24266,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: - - *145 + - *157 - *54 requestBody: required: true @@ -23000,7 +24315,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: - - *145 + - *157 - *54 requestBody: required: true @@ -23050,10 +24365,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: - - *145 + - *157 - *54 responses: - '200': *170 + '200': *182 '404': *7 x-github: githubCloudOnly: false @@ -23080,9 +24395,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: - - *145 + - *157 - *54 - - *171 + - *183 responses: '200': *60 '404': *7 @@ -23109,7 +24424,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-organization-secrets parameters: - - *145 + - *157 - *18 - *20 responses: @@ -23127,7 +24442,7 @@ paths: type: integer secrets: type: array - items: &172 + items: &184 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -23200,13 +24515,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key parameters: - - *145 + - *157 responses: '200': description: Response content: application/json: - schema: &364 + schema: &371 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -23235,7 +24550,7 @@ paths: - key_id - key examples: - default: &365 + default: &372 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -23260,8 +24575,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-secret parameters: - - *145 - - &173 + - *157 + - &185 name: secret_name description: The name of the secret. in: path @@ -23273,7 +24588,7 @@ paths: description: Response content: application/json: - schema: *172 + schema: *184 examples: default: value: @@ -23303,8 +24618,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *145 - - *173 + - *157 + - *185 requestBody: required: true content: @@ -23359,7 +24674,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -23385,8 +24700,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-organization-secret parameters: - - *145 - - *173 + - *157 + - *185 responses: '204': description: Response @@ -23412,8 +24727,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: - - *145 - - *173 + - *157 + - *185 - *20 - *18 responses: @@ -23431,9 +24746,9 @@ paths: type: integer repositories: type: array - items: *163 + items: *175 examples: - default: &177 + default: &189 value: total_count: 1 repositories: @@ -23525,8 +24840,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: - - *145 - - *173 + - *157 + - *185 requestBody: required: true content: @@ -23578,8 +24893,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: - - *145 - - *173 + - *157 + - *185 - name: repository_id in: path required: true @@ -23612,8 +24927,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: - - *145 - - *173 + - *157 + - *185 - name: repository_id in: path required: true @@ -23645,8 +24960,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables parameters: - - *145 - - &349 + - *157 + - &356 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)." @@ -23670,7 +24985,7 @@ paths: type: integer variables: type: array - items: &175 + items: &187 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -23755,7 +25070,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-organization-variable parameters: - - *145 + - *157 requestBody: required: true content: @@ -23803,7 +25118,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -23828,8 +25143,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-organization-variable parameters: - - *145 - - &176 + - *157 + - &188 name: name description: The name of the variable. in: path @@ -23841,7 +25156,7 @@ paths: description: Response content: application/json: - schema: *175 + schema: *187 examples: default: value: @@ -23871,8 +25186,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-organization-variable parameters: - - *145 - - *176 + - *157 + - *188 requestBody: required: true content: @@ -23934,8 +25249,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-organization-variable parameters: - - *145 - - *176 + - *157 + - *188 responses: '204': description: Response @@ -23961,8 +25276,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: - - *145 - - *176 + - *157 + - *188 - *20 - *18 responses: @@ -23980,9 +25295,9 @@ paths: type: integer repositories: type: array - items: *163 + items: *175 examples: - default: *177 + default: *189 '409': description: Response when the visibility of the variable is not set to `selected` @@ -24008,8 +25323,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: - - *145 - - *176 + - *157 + - *188 requestBody: required: true content: @@ -24058,8 +25373,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: - - *145 - - *176 + - *157 + - *188 - name: repository_id in: path required: true @@ -24093,8 +25408,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: - - *145 - - *176 + - *157 + - *188 - name: repository_id in: path required: true @@ -24125,7 +25440,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#get-announcement-banner-for-organization parameters: - - *145 + - *157 responses: '200': description: Response @@ -24152,11 +25467,11 @@ paths: required: true content: application/json: - schema: *178 + schema: *190 examples: default: *63 parameters: - - *145 + - *157 responses: '200': description: Response @@ -24180,7 +25495,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#remove-announcement-banner-from-organization parameters: - - *145 + - *157 responses: '204': description: Response @@ -24208,7 +25523,7 @@ paths: - *18 - *76 - *77 - - *145 + - *157 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -24248,8 +25563,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: &378 + default: &385 value: attestations: - bundle: @@ -24367,7 +25684,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: - - *145 + - *157 - 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). @@ -24375,10 +25692,10 @@ paths: required: false schema: type: string - - *179 - - *180 - - *181 - - *182 + - *191 + - *192 + - *193 + - *194 - *18 responses: '200': @@ -24387,9 +25704,9 @@ paths: application/json: schema: type: array - items: *183 + items: *195 examples: - default: *184 + default: *196 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -24406,7 +25723,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *145 + - *157 - *18 - *20 responses: @@ -24418,7 +25735,7 @@ paths: type: array items: *19 examples: - default: &246 + default: &258 value: - login: octocat id: 1 @@ -24456,8 +25773,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: - - *145 - - &185 + - *157 + - &197 name: username description: The handle for the GitHub user account. in: path @@ -24488,8 +25805,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#block-a-user-from-an-organization parameters: - - *145 - - *185 + - *157 + - *197 responses: '204': description: Response @@ -24509,8 +25826,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - - *145 - - *185 + - *157 + - *197 responses: '204': description: Response @@ -24535,9 +25852,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: - - *145 - - *186 - - *187 + - *157 + - *198 + - *199 - *76 - *77 - *20 @@ -24548,7 +25865,7 @@ paths: be returned. in: query required: false - schema: *188 + schema: *200 - name: sort description: The property by which to sort the results. in: query @@ -24564,7 +25881,7 @@ paths: be returned. in: query required: false - schema: &405 + schema: &412 type: string description: Severity of a code scanning alert. enum: @@ -24582,13 +25899,13 @@ paths: application/json: schema: type: array - items: *189 + items: *201 examples: - default: *190 + default: *202 headers: Link: *39 '404': *7 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24610,7 +25927,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: - - *145 + - *157 - name: target_type in: query description: The target type of the code security configuration @@ -24638,7 +25955,7 @@ paths: application/json: schema: type: array - items: &191 + items: &203 type: object description: A code security configuration properties: @@ -24896,7 +26213,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#create-a-code-security-configuration parameters: - - *145 + - *157 requestBody: required: true content: @@ -24969,7 +26286,7 @@ paths: - disabled - not_set default: disabled - code_scanning_default_setup_options: &195 + code_scanning_default_setup_options: &207 type: object description: Feature options for code scanning default setup nullable: true @@ -25086,9 +26403,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *191 + schema: *203 examples: - default: &193 + default: &205 value: id: 1325 target_type: organization @@ -25137,7 +26454,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-default-code-security-configurations parameters: - - *145 + - *157 responses: '200': description: Response @@ -25157,7 +26474,7 @@ paths: description: The visibility of newly created repositories for which the code security configuration will be applied to by default - configuration: *191 + configuration: *203 examples: default: value: @@ -25247,7 +26564,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *145 + - *157 requestBody: required: true content: @@ -25270,11 +26587,11 @@ paths: - 32 - 91 responses: - '204': *192 + '204': *204 '400': *15 '403': *29 '404': *7 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25296,8 +26613,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-a-code-security-configuration parameters: - - *145 - - &194 + - *157 + - &206 name: configuration_id description: The unique identifier of the code security configuration. in: path @@ -25309,9 +26626,9 @@ paths: description: Response content: application/json: - schema: *191 + schema: *203 examples: - default: *193 + default: *205 '304': *37 '403': *29 '404': *7 @@ -25335,8 +26652,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-code-security-configuration parameters: - - *145 - - *194 + - *157 + - *206 requestBody: required: true content: @@ -25402,7 +26719,7 @@ paths: - enabled - disabled - not_set - code_scanning_default_setup_options: *195 + code_scanning_default_setup_options: *207 secret_scanning: type: string description: The enablement status of secret scanning @@ -25489,7 +26806,7 @@ paths: description: Response when a configuration is updated content: application/json: - schema: *191 + schema: *203 examples: default: value: @@ -25543,14 +26860,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *145 - - *194 + - *157 + - *206 responses: - '204': *192 + '204': *204 '400': *15 '403': *29 '404': *7 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25574,8 +26891,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *145 - - *194 + - *157 + - *206 requestBody: required: true content: @@ -25614,7 +26931,7 @@ paths: - 32 - 91 responses: - '202': *151 + '202': *163 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25638,8 +26955,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: - - *145 - - *194 + - *157 + - *206 requestBody: required: true content: @@ -25679,12 +26996,12 @@ paths: - none - private_and_internal - public - configuration: *191 + configuration: *203 examples: default: value: default_for_new_repos: all - configuration: *193 + configuration: *205 '403': *29 '404': *7 x-github: @@ -25708,8 +27025,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: - - *145 - - *194 + - *157 + - *206 - 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)." @@ -25852,7 +27169,7 @@ paths: parameters: - *18 - *20 - - *145 + - *157 responses: '200': description: Response @@ -25868,7 +27185,7 @@ paths: type: integer codespaces: type: array - items: &247 + items: &259 type: object title: Codespace description: A codespace. @@ -25893,12 +27210,12 @@ paths: nullable: true owner: *19 billable_owner: *19 - repository: *163 + repository: *175 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &431 + properties: &438 name: type: string description: The name of the machine. @@ -25940,7 +27257,7 @@ paths: - ready - in_progress nullable: true - required: &432 + required: &439 - name - display_name - operating_system @@ -26145,7 +27462,7 @@ paths: - pulls_url - recent_folders examples: - default: &248 + default: &260 value: total_count: 3 codespaces: @@ -26577,7 +27894,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *145 + - *157 deprecated: true requestBody: required: true @@ -26644,7 +27961,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: - - *145 + - *157 deprecated: true requestBody: required: true @@ -26699,7 +28016,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *145 + - *157 requestBody: required: true content: @@ -26751,7 +28068,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *145 + - *157 - *18 - *20 responses: @@ -26769,7 +28086,7 @@ paths: type: integer secrets: type: array - items: &196 + items: &208 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -26808,7 +28125,7 @@ paths: - updated_at - visibility examples: - default: &433 + default: &440 value: total_count: 2 secrets: @@ -26840,13 +28157,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *145 + - *157 responses: '200': description: Response content: application/json: - schema: &434 + schema: &441 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -26875,7 +28192,7 @@ paths: - key_id - key examples: - default: &435 + default: &442 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -26898,16 +28215,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *145 - - *173 + - *157 + - *185 responses: '200': description: Response content: application/json: - schema: *196 + schema: *208 examples: - default: &437 + default: &444 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -26934,8 +28251,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: - - *145 - - *173 + - *157 + - *185 requestBody: required: true content: @@ -26990,7 +28307,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -27016,8 +28333,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *145 - - *173 + - *157 + - *185 responses: '204': description: Response @@ -27042,8 +28359,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: - - *145 - - *173 + - *157 + - *185 - *20 - *18 responses: @@ -27061,9 +28378,9 @@ paths: type: integer repositories: type: array - items: *163 + items: *175 examples: - default: *177 + default: *189 '404': *7 x-github: githubCloudOnly: false @@ -27085,8 +28402,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: - - *145 - - *173 + - *157 + - *185 requestBody: required: true content: @@ -27136,8 +28453,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: - - *145 - - *173 + - *157 + - *185 - name: repository_id in: path required: true @@ -27170,8 +28487,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: - - *145 - - *173 + - *157 + - *185 - name: repository_id in: path required: true @@ -27210,7 +28527,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: - - *145 + - *157 responses: '200': description: OK @@ -27353,7 +28670,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: - - *145 + - *157 - *20 - name: per_page description: The number of results per page (max 100). For more information, @@ -27376,9 +28693,9 @@ paths: currently being billed. seats: type: array - items: *197 + items: *209 examples: - default: *198 + default: *210 headers: Link: *39 '500': *84 @@ -27414,7 +28731,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: - - *145 + - *157 requestBody: content: application/json: @@ -27492,7 +28809,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: - - *145 + - *157 requestBody: content: application/json: @@ -27572,7 +28889,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: - - *145 + - *157 requestBody: content: application/json: @@ -27649,7 +28966,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: - - *145 + - *157 requestBody: content: application/json: @@ -27730,7 +29047,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: - - *145 + - *157 - 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`). @@ -27762,13 +29079,13 @@ paths: application/json: schema: type: array - items: *102 + items: *114 examples: - default: *103 + default: *115 '500': *84 '403': *29 '404': *7 - '422': *104 + '422': *116 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27799,7 +29116,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: - - *145 + - *157 - 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`). @@ -27831,9 +29148,9 @@ paths: application/json: schema: type: array - items: *105 + items: *117 examples: - default: *199 + default: *211 '500': *84 '401': *25 '403': *29 @@ -27859,7 +29176,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: - - *145 + - *157 - *18 - name: page description: Page token @@ -28003,7 +29320,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: - - *145 + - *157 - name: credential_id in: path required: true @@ -28034,7 +29351,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: - - *145 + - *157 responses: '200': description: Response - list of custom role names @@ -28049,7 +29366,7 @@ paths: type: integer custom_roles: type: array - items: *200 + items: *212 examples: default: value: @@ -28136,12 +29453,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role parameters: - - *145 + - *157 requestBody: required: true content: application/json: - schema: &203 + schema: &215 type: object properties: name: @@ -28182,9 +29499,9 @@ paths: description: Response content: application/json: - schema: *200 + schema: *212 examples: - default: *201 + default: *213 '422': *16 '404': *7 x-github: @@ -28208,8 +29525,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role parameters: - - *145 - - &202 + - *157 + - &214 name: role_id description: The unique identifier of the role. in: path @@ -28221,9 +29538,9 @@ paths: description: Response content: application/json: - schema: *200 + schema: *212 examples: - default: *201 + default: *213 '404': *7 x-github: githubCloudOnly: true @@ -28245,13 +29562,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role parameters: - - *145 - - *202 + - *157 + - *214 requestBody: required: true content: application/json: - schema: &204 + schema: &216 type: object properties: name: @@ -28289,9 +29606,9 @@ paths: description: Response content: application/json: - schema: *200 + schema: *212 examples: - default: *201 + default: *213 '422': *16 '404': *7 x-github: @@ -28315,8 +29632,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role parameters: - - *145 - - *202 + - *157 + - *214 responses: '204': description: Response @@ -28344,12 +29661,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: - - *145 + - *157 requestBody: required: true content: application/json: - schema: *203 + schema: *215 examples: default: value: @@ -28363,9 +29680,9 @@ paths: description: Response content: application/json: - schema: *200 + schema: *212 examples: - default: *201 + default: *213 '422': *16 '404': *7 x-github: @@ -28395,16 +29712,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: - - *145 - - *202 + - *157 + - *214 responses: '200': description: Response content: application/json: - schema: *200 + schema: *212 examples: - default: *201 + default: *213 '404': *7 x-github: githubCloudOnly: true @@ -28432,13 +29749,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: - - *145 - - *202 + - *157 + - *214 requestBody: required: true content: application/json: - schema: *204 + schema: *216 examples: default: value: @@ -28453,9 +29770,9 @@ paths: description: Response content: application/json: - schema: *200 + schema: *212 examples: - default: *201 + default: *213 '422': *16 '404': *7 x-github: @@ -28485,8 +29802,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: - - *145 - - *202 + - *157 + - *214 responses: '204': description: Response @@ -28514,18 +29831,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *145 - - *205 - - *206 - - *207 - - *208 - - *209 - - *210 + - *157 + - *217 + - *218 + - *219 + - *220 + - *221 + - *222 - *78 - *76 - *77 - - *211 - - *212 + - *223 + - *224 - *18 responses: '200': @@ -28534,9 +29851,9 @@ paths: application/json: schema: type: array - items: *213 + items: *225 examples: - default: *214 + default: *226 '304': *37 '400': *15 '403': *29 @@ -28562,7 +29879,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-organization-secrets parameters: - - *145 + - *157 - *18 - *20 responses: @@ -28580,7 +29897,7 @@ paths: type: integer secrets: type: array - items: &215 + items: &227 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -28651,13 +29968,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-public-key parameters: - - *145 + - *157 responses: '200': description: Response content: application/json: - schema: &464 + schema: &471 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -28674,7 +29991,7 @@ paths: - key_id - key examples: - default: &465 + default: &472 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -28697,14 +30014,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-secret parameters: - - *145 - - *173 + - *157 + - *185 responses: '200': description: Response content: application/json: - schema: *215 + schema: *227 examples: default: value: @@ -28732,8 +30049,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *145 - - *173 + - *157 + - *185 requestBody: required: true content: @@ -28788,7 +30105,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -28812,8 +30129,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-an-organization-secret parameters: - - *145 - - *173 + - *157 + - *185 responses: '204': description: Response @@ -28837,8 +30154,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: - - *145 - - *173 + - *157 + - *185 - *20 - *18 responses: @@ -28856,9 +30173,9 @@ paths: type: integer repositories: type: array - items: *163 + items: *175 examples: - default: *177 + default: *189 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28879,8 +30196,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: - - *145 - - *173 + - *157 + - *185 requestBody: required: true content: @@ -28930,8 +30247,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: - - *145 - - *173 + - *157 + - *185 - name: repository_id in: path required: true @@ -28962,8 +30279,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: - - *145 - - *173 + - *157 + - *185 - name: repository_id in: path required: true @@ -28993,7 +30310,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: - - *145 + - *157 responses: '200': description: Response @@ -29001,7 +30318,7 @@ paths: application/json: schema: type: array - items: &259 + items: &271 title: Package description: A software package type: object @@ -29051,8 +30368,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *216 - required: *217 + properties: *228 + required: *229 nullable: true created_at: type: string @@ -29071,7 +30388,7 @@ paths: - created_at - updated_at examples: - default: &260 + default: &272 value: - id: 197 name: hello_docker @@ -29149,7 +30466,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-organization-events parameters: - - *145 + - *157 - *18 - *20 responses: @@ -29159,7 +30476,7 @@ paths: application/json: schema: type: array - items: *134 + items: *146 examples: 200-response: value: @@ -29229,7 +30546,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#get-an-external-group parameters: - - *145 + - *157 - name: group_id description: The unique identifier of the group. in: path @@ -29255,7 +30572,7 @@ paths: description: Response content: application/json: - schema: &320 + schema: &327 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -29336,7 +30653,7 @@ paths: example: mona_lisa@github.com type: string examples: - default: &321 + default: &328 value: group_id: '123' group_name: Octocat admins @@ -29374,7 +30691,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: - - *145 + - *157 - *18 - name: page description: Page token @@ -29391,7 +30708,7 @@ paths: description: Response content: application/json: - schema: &318 + schema: &325 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -29428,7 +30745,7 @@ paths: example: 2019-06-03 22:27:15:000 -700 type: string examples: - default: &319 + default: &326 value: groups: - group_id: '123' @@ -29462,7 +30779,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-failed-organization-invitations parameters: - - *145 + - *157 - *18 - *20 responses: @@ -29472,7 +30789,7 @@ paths: application/json: schema: type: array - items: &240 + items: &252 title: Organization Invitation description: Organization Invitation type: object @@ -29519,7 +30836,7 @@ paths: - invitation_teams_url - node_id examples: - default: &241 + default: &253 value: - id: 1 login: monalisa @@ -29578,7 +30895,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: - - *145 + - *157 responses: '200': description: Response @@ -29586,7 +30903,7 @@ paths: application/json: schema: type: array - items: &277 + items: &290 title: Repository Fine-Grained Permission description: A fine-grained permission that protects repository resources. @@ -29600,7 +30917,7 @@ paths: - name - description examples: - default: &278 + default: &291 value: - name: add_assignee description: Assign or remove a user @@ -29631,7 +30948,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-organization-webhooks parameters: - - *145 + - *157 - *18 - *20 responses: @@ -29641,7 +30958,7 @@ paths: application/json: schema: type: array - items: &218 + items: &230 title: Org Hook description: Org Hook type: object @@ -29750,7 +31067,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#create-an-organization-webhook parameters: - - *145 + - *157 requestBody: required: true content: @@ -29810,9 +31127,9 @@ paths: description: Response content: application/json: - schema: *218 + schema: *230 examples: - default: &219 + default: &231 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -29856,8 +31173,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-an-organization-webhook parameters: - - *145 - - &220 + - *157 + - &232 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. @@ -29870,9 +31187,9 @@ paths: description: Response content: application/json: - schema: *218 + schema: *230 examples: - default: *219 + default: *231 '404': *7 x-github: githubCloudOnly: false @@ -29893,8 +31210,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-an-organization-webhook parameters: - - *145 - - *220 + - *157 + - *232 requestBody: required: false content: @@ -29939,7 +31256,7 @@ paths: description: Response content: application/json: - schema: *218 + schema: *230 examples: default: value: @@ -29978,8 +31295,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *145 - - *220 + - *157 + - *232 responses: '204': description: Response @@ -30004,8 +31321,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: - - *145 - - *220 + - *157 + - *232 responses: '200': description: Response @@ -30033,8 +31350,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: - - *145 - - *220 + - *157 + - *232 requestBody: required: false content: @@ -30082,10 +31399,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *145 - - *220 + - *157 + - *232 - *18 - - *221 + - *233 responses: '200': description: Response @@ -30093,9 +31410,9 @@ paths: application/json: schema: type: array - items: *222 + items: *234 examples: - default: *223 + default: *235 '400': *15 '422': *16 x-github: @@ -30118,17 +31435,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: - - *145 - - *220 + - *157 + - *232 - *17 responses: '200': description: Response content: application/json: - schema: *224 + schema: *236 examples: - default: *225 + default: *237 '400': *15 '422': *16 x-github: @@ -30151,11 +31468,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: - - *145 - - *220 + - *157 + - *232 - *17 responses: - '202': *151 + '202': *163 '400': *15 '422': *16 x-github: @@ -30178,8 +31495,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *145 - - *220 + - *157 + - *232 responses: '204': description: Response @@ -30201,8 +31518,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-route-stats-by-actor parameters: - - *145 - - &230 + - *157 + - &242 name: actor_type in: path description: The type of the actor @@ -30215,14 +31532,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &231 + - &243 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &226 + - &238 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`.' @@ -30230,7 +31547,7 @@ paths: required: true schema: type: string - - &227 + - &239 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) @@ -30323,13 +31640,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-subject-stats parameters: - - *145 - - *226 - - *227 + - *157 + - *238 + - *239 - *20 - *18 - *78 - - &236 + - &248 name: sort description: The property to sort the results by. in: query @@ -30407,15 +31724,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats parameters: - - *145 - - *226 - - *227 + - *157 + - *238 + - *239 responses: '200': description: Response content: application/json: - schema: &228 + schema: &240 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -30431,7 +31748,7 @@ paths: type: integer format: int64 examples: - default: &229 + default: &241 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -30451,24 +31768,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-user parameters: - - *145 - - &232 + - *157 + - &244 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *226 - - *227 + - *238 + - *239 responses: '200': description: Response content: application/json: - schema: *228 + schema: *240 examples: - default: *229 + default: *241 x-github: enabledForGitHubApps: true category: orgs @@ -30486,19 +31803,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-actor parameters: - - *145 - - *226 - - *227 - - *230 - - *231 + - *157 + - *238 + - *239 + - *242 + - *243 responses: '200': description: Response content: application/json: - schema: *228 + schema: *240 examples: - default: *229 + default: *241 x-github: enabledForGitHubApps: true category: orgs @@ -30515,10 +31832,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats parameters: - - *145 - - *226 - - *227 - - &233 + - *157 + - *238 + - *239 + - &245 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -30531,7 +31848,7 @@ paths: description: Response content: application/json: - schema: &234 + schema: &246 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -30547,7 +31864,7 @@ paths: type: integer format: int64 examples: - default: &235 + default: &247 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -30583,19 +31900,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-user parameters: - - *145 - - *232 - - *226 - - *227 - - *233 + - *157 + - *244 + - *238 + - *239 + - *245 responses: '200': description: Response content: application/json: - schema: *234 + schema: *246 examples: - default: *235 + default: *247 x-github: enabledForGitHubApps: true category: orgs @@ -30612,20 +31929,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-actor parameters: - - *145 - - *230 - - *231 - - *226 - - *227 - - *233 + - *157 + - *242 + - *243 + - *238 + - *239 + - *245 responses: '200': description: Response content: application/json: - schema: *234 + schema: *246 examples: - default: *235 + default: *247 x-github: enabledForGitHubApps: true category: orgs @@ -30642,14 +31959,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-user-stats parameters: - - *145 - - *232 - - *226 - - *227 + - *157 + - *244 + - *238 + - *239 - *20 - *18 - *78 - - *236 + - *248 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -30722,7 +32039,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: - - *145 + - *157 responses: '200': description: Response @@ -30730,7 +32047,7 @@ paths: application/json: schema: *22 examples: - default: &503 + default: &510 value: id: 1 account: @@ -30799,7 +32116,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *145 + - *157 - *18 - *20 responses: @@ -30888,7 +32205,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *145 + - *157 responses: '200': description: Response @@ -30896,12 +32213,12 @@ paths: application/json: schema: anyOf: - - &238 + - &250 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &237 + limit: &249 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -30926,7 +32243,7 @@ paths: properties: {} additionalProperties: false examples: - default: &239 + default: &251 value: limit: collaborators_only origin: organization @@ -30950,18 +32267,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *145 + - *157 requestBody: required: true content: application/json: - schema: &504 + schema: &511 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *237 + limit: *249 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -30985,9 +32302,9 @@ paths: description: Response content: application/json: - schema: *238 + schema: *250 examples: - default: *239 + default: *251 '422': *16 x-github: githubCloudOnly: false @@ -31005,7 +32322,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *145 + - *157 responses: '204': description: Response @@ -31031,7 +32348,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-pending-organization-invitations parameters: - - *145 + - *157 - *18 - *20 - name: role @@ -31065,9 +32382,9 @@ paths: application/json: schema: type: array - items: *240 + items: *252 examples: - default: *241 + default: *253 headers: Link: *39 '404': *7 @@ -31091,7 +32408,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#create-an-organization-invitation parameters: - - *145 + - *157 requestBody: required: false content: @@ -31145,7 +32462,7 @@ paths: description: Response content: application/json: - schema: *240 + schema: *252 examples: default: value: @@ -31201,8 +32518,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#cancel-an-organization-invitation parameters: - - *145 - - &242 + - *157 + - &254 name: invitation_id description: The unique identifier of the invitation. in: path @@ -31235,8 +32552,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-invitation-teams parameters: - - *145 - - *242 + - *157 + - *254 - *18 - *20 responses: @@ -31246,9 +32563,9 @@ paths: application/json: schema: type: array - items: *243 + items: *255 examples: - default: &258 + default: &270 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -31293,7 +32610,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: - - *145 + - *157 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -31323,7 +32640,7 @@ paths: - closed - all default: open - - *244 + - *256 - name: sort description: What to sort results by. in: query @@ -31336,7 +32653,7 @@ paths: - comments default: created - *78 - - *112 + - *124 - *18 - *20 responses: @@ -31346,9 +32663,9 @@ paths: application/json: schema: type: array - items: *122 + items: *134 examples: - default: *245 + default: *257 headers: Link: *39 '404': *7 @@ -31370,7 +32687,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-members parameters: - - *145 + - *157 - 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) @@ -31406,7 +32723,7 @@ paths: type: array items: *19 examples: - default: *246 + default: *258 headers: Link: *39 '422': *16 @@ -31426,8 +32743,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-organization-membership-for-a-user parameters: - - *145 - - *185 + - *157 + - *197 responses: '204': description: Response if requester is an organization member and user is @@ -31458,8 +32775,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-an-organization-member parameters: - - *145 - - *185 + - *157 + - *197 responses: '204': description: Response @@ -31485,8 +32802,8 @@ paths: parameters: - *18 - *20 - - *145 - - *185 + - *157 + - *197 responses: '200': description: Response @@ -31502,9 +32819,9 @@ paths: type: integer codespaces: type: array - items: *247 + items: *259 examples: - default: *248 + default: *260 '304': *37 '500': *84 '401': *25 @@ -31529,9 +32846,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - - *145 - - *185 - - &249 + - *157 + - *197 + - &261 name: codespace_name in: path required: true @@ -31539,7 +32856,7 @@ paths: schema: type: string responses: - '202': *151 + '202': *163 '304': *37 '500': *84 '401': *25 @@ -31564,17 +32881,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: - - *145 - - *185 - - *249 + - *157 + - *197 + - *261 responses: '200': description: Response content: application/json: - schema: *247 + schema: *259 examples: - default: &430 + default: &437 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -31747,14 +33064,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: - - *145 - - *185 + - *157 + - *197 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *197 + schema: *209 examples: default: value: @@ -31822,14 +33139,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user parameters: - - *145 - - *185 + - *157 + - *197 responses: '200': description: Response content: application/json: - schema: &250 + schema: &262 title: Org Membership description: Org Membership type: object @@ -31881,7 +33198,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &251 + response-if-user-has-an-active-admin-membership-with-organization: &263 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -31949,8 +33266,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-organization-membership-for-a-user parameters: - - *145 - - *185 + - *157 + - *197 requestBody: required: false content: @@ -31978,9 +33295,9 @@ paths: description: Response content: application/json: - schema: *250 + schema: *262 examples: - response-if-user-already-had-membership-with-organization: *251 + response-if-user-already-had-membership-with-organization: *263 '422': *16 '403': *29 x-github: @@ -32001,8 +33318,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-organization-membership-for-a-user parameters: - - *145 - - *185 + - *157 + - *197 responses: '204': description: Response @@ -32027,7 +33344,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-organization-migrations parameters: - - *145 + - *157 - *18 - *20 - name: exclude @@ -32048,7 +33365,7 @@ paths: application/json: schema: type: array - items: &252 + items: &264 title: Migration description: A migration. type: object @@ -32301,7 +33618,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#start-an-organization-migration parameters: - - *145 + - *157 requestBody: required: true content: @@ -32377,7 +33694,7 @@ paths: description: Response content: application/json: - schema: *252 + schema: *264 examples: default: value: @@ -32555,8 +33872,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#get-an-organization-migration-status parameters: - - *145 - - &253 + - *157 + - &265 name: migration_id description: The unique identifier of the migration. in: path @@ -32583,7 +33900,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *252 + schema: *264 examples: default: value: @@ -32752,8 +34069,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *145 - - *253 + - *157 + - *265 responses: '302': description: Response @@ -32774,8 +34091,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *145 - - *253 + - *157 + - *265 responses: '204': description: Response @@ -32798,9 +34115,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#unlock-an-organization-repository parameters: - - *145 - - *253 - - &675 + - *157 + - *265 + - &682 name: repo_name description: repo_name parameter in: path @@ -32827,8 +34144,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *145 - - *253 + - *157 + - *265 - *18 - *20 responses: @@ -32838,9 +34155,9 @@ paths: application/json: schema: type: array - items: *163 + items: *175 examples: - default: &265 + default: &277 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -32979,7 +34296,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: - - *145 + - *157 responses: '200': description: Response @@ -33033,7 +34350,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: - - *145 + - *157 responses: '200': description: Response - list of organization roles @@ -33049,7 +34366,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &254 + items: &266 title: Organization Role description: Organization roles type: object @@ -33209,7 +34526,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#create-a-custom-organization-role parameters: - - *145 + - *157 requestBody: required: true content: @@ -33256,7 +34573,7 @@ paths: description: Response content: application/json: - schema: *254 + schema: *266 examples: default: value: @@ -33285,7 +34602,7 @@ paths: updated_at: '2022-07-04T22:19:11Z' '422': *16 '404': *7 - '409': *150 + '409': *162 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -33307,8 +34624,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: - - *145 - - *255 + - *157 + - *267 responses: '204': description: Response @@ -33333,9 +34650,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: - - *145 - - *255 - - *202 + - *157 + - *267 + - *214 responses: '204': description: Response @@ -33364,9 +34681,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: - - *145 - - *255 - - *202 + - *157 + - *267 + - *214 responses: '204': description: Response @@ -33391,8 +34708,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: - - *145 - - *185 + - *157 + - *197 responses: '204': description: Response @@ -33417,9 +34734,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: - - *145 - - *185 - - *202 + - *157 + - *197 + - *214 responses: '204': description: Response @@ -33449,9 +34766,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: - - *145 - - *185 - - *202 + - *157 + - *197 + - *214 responses: '204': description: Response @@ -33479,14 +34796,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-an-organization-role parameters: - - *145 - - *202 + - *157 + - *214 responses: '200': description: Response content: application/json: - schema: *254 + schema: *266 examples: default: value: @@ -33543,8 +34860,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#update-a-custom-organization-role parameters: - - *145 - - *202 + - *157 + - *214 requestBody: required: true content: @@ -33583,7 +34900,7 @@ paths: description: Response content: application/json: - schema: *254 + schema: *266 examples: default: value: @@ -33611,7 +34928,7 @@ paths: created_at: '2022-07-04T22:19:11Z' updated_at: '2022-07-04T22:19:11Z' '422': *16 - '409': *150 + '409': *162 '404': *7 x-github: githubCloudOnly: true @@ -33636,8 +34953,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#delete-a-custom-organization-role parameters: - - *145 - - *202 + - *157 + - *214 responses: '204': description: Response @@ -33662,8 +34979,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: - - *145 - - *202 + - *157 + - *214 - *18 - *20 responses: @@ -33741,8 +35058,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *256 - required: *257 + properties: *268 + required: *269 nullable: true required: - id @@ -33757,7 +35074,7 @@ paths: - slug - parent examples: - default: *258 + default: *270 headers: Link: *39 '404': @@ -33786,8 +35103,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: - - *145 - - *202 + - *157 + - *214 - *18 - *20 responses: @@ -33815,13 +35132,13 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: &297 + items: &304 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *256 - required: *257 + properties: *268 + required: *269 name: nullable: true type: string @@ -33916,7 +35233,7 @@ paths: - type - url examples: - default: *246 + default: *258 headers: Link: *39 '404': @@ -33940,7 +35257,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: - - *145 + - *157 - 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) @@ -33964,7 +35281,7 @@ paths: type: array items: *19 examples: - default: *246 + default: *258 headers: Link: *39 x-github: @@ -33989,8 +35306,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: - - *145 - - *185 + - *157 + - *197 requestBody: required: false content: @@ -34047,8 +35364,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: - - *145 - - *185 + - *157 + - *197 responses: '204': description: Response @@ -34105,8 +35422,8 @@ paths: - docker - nuget - container - - *145 - - &677 + - *157 + - &684 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -34142,12 +35459,12 @@ paths: application/json: schema: type: array - items: *259 + items: *271 examples: - default: *260 + default: *272 '403': *29 '401': *25 - '400': &679 + '400': &686 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -34169,7 +35486,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-an-organization parameters: - - &261 + - &273 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 @@ -34187,20 +35504,20 @@ paths: - docker - nuget - container - - &262 + - &274 name: package_name description: The name of the package. in: path required: true schema: type: string - - *145 + - *157 responses: '200': description: Response content: application/json: - schema: *259 + schema: *271 examples: default: value: @@ -34252,9 +35569,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-an-organization parameters: - - *261 - - *262 - - *145 + - *273 + - *274 + - *157 responses: '204': description: Response @@ -34286,9 +35603,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-an-organization parameters: - - *261 - - *262 - - *145 + - *273 + - *274 + - *157 - name: token description: package token schema: @@ -34320,9 +35637,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: - - *261 - - *262 - - *145 + - *273 + - *274 + - *157 - *20 - *18 - name: state @@ -34342,7 +35659,7 @@ paths: application/json: schema: type: array - items: &263 + items: &275 title: Package Version description: A version of a software package type: object @@ -34467,10 +35784,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: - - *261 - - *262 - - *145 - - &264 + - *273 + - *274 + - *157 + - &276 name: package_version_id description: Unique identifier of the package version. in: path @@ -34482,7 +35799,7 @@ paths: description: Response content: application/json: - schema: *263 + schema: *275 examples: default: value: @@ -34518,10 +35835,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-an-organization parameters: - - *261 - - *262 - - *145 - - *264 + - *273 + - *274 + - *157 + - *276 responses: '204': description: Response @@ -34553,10 +35870,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-an-organization parameters: - - *261 - - *262 - - *145 - - *264 + - *273 + - *274 + - *157 + - *276 responses: '204': description: Response @@ -34583,10 +35900,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: - - *145 + - *157 - *18 - *20 - - &266 + - &278 name: sort description: The property by which to sort the results. in: query @@ -34597,7 +35914,7 @@ paths: - created_at default: created_at - *78 - - &267 + - &279 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -34608,7 +35925,7 @@ paths: items: type: string example: owner[]=octocat1,owner[]=octocat2 - - &268 + - &280 name: repository description: The name of the repository to use to filter the results. in: query @@ -34616,7 +35933,7 @@ paths: schema: type: string example: Hello-World - - &269 + - &281 name: permission description: The permission to use to filter the results. in: query @@ -34624,7 +35941,7 @@ paths: schema: type: string example: issues_read - - &270 + - &282 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) @@ -34634,7 +35951,7 @@ paths: schema: type: string format: date-time - - &271 + - &283 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) @@ -34797,7 +36114,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: - - *145 + - *157 requestBody: required: true content: @@ -34842,7 +36159,7 @@ paths: '422': *16 '404': *7 '403': *29 - '202': *151 + '202': *163 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34863,7 +36180,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: - - *145 + - *157 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -34903,7 +36220,7 @@ paths: '422': *16 '404': *7 '403': *29 - '204': *192 + '204': *204 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34924,7 +36241,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: - - *145 + - *157 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -34944,9 +36261,9 @@ paths: application/json: schema: type: array - items: *163 + items: *175 examples: - default: *265 + default: *277 headers: Link: *39 x-github: @@ -34969,16 +36286,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: - - *145 + - *157 - *18 - *20 - - *266 + - *278 - *78 - - *267 - - *268 - - *269 - - *270 - - *271 + - *279 + - *280 + - *281 + - *282 + - *283 responses: '500': *84 '422': *16 @@ -35127,7 +36444,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: - - *145 + - *157 requestBody: required: true content: @@ -35164,7 +36481,7 @@ paths: responses: '500': *84 '404': *7 - '202': *151 + '202': *163 '403': *29 '422': *16 x-github: @@ -35187,7 +36504,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: - - *145 + - *157 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -35217,7 +36534,7 @@ paths: responses: '500': *84 '404': *7 - '204': *192 + '204': *204 '403': *29 '422': *16 x-github: @@ -35239,7 +36556,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: - - *145 + - *157 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -35258,9 +36575,9 @@ paths: application/json: schema: type: array - items: *163 + items: *175 examples: - default: *265 + default: *277 headers: Link: *39 x-github: @@ -35282,7 +36599,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-organization-projects parameters: - - *145 + - *157 - name: state description: Indicates the state of the projects to return. in: query @@ -35303,7 +36620,7 @@ paths: application/json: schema: type: array - items: &272 + items: &284 title: Project description: Projects are a way to organize columns and cards of work. @@ -35447,7 +36764,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#create-an-organization-project parameters: - - *145 + - *157 requestBody: required: true content: @@ -35473,7 +36790,7 @@ paths: description: Response content: application/json: - schema: *272 + schema: *284 examples: default: value: @@ -35511,7 +36828,7 @@ paths: '401': *25 '403': *29 '404': *7 - '410': &336 + '410': &343 description: Gone content: application/json: @@ -35535,7 +36852,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: - - *145 + - *157 responses: '200': description: Response @@ -35568,7 +36885,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: - - *145 + - *157 requestBody: required: true content: @@ -35632,7 +36949,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: - - *145 + - *157 - *98 responses: '200': @@ -35664,51 +36981,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: - - *145 + - *157 - *98 requestBody: required: true content: application/json: - schema: - type: object - properties: - value_type: - type: string - example: single_select - enum: - - string - - single_select - - multi_select - - true_false - description: The type of the value for the property - required: - type: boolean - description: Whether the property is required. - default_value: - oneOf: - - type: string - - type: array - items: - type: string - nullable: true - description: Default value of the property - description: - type: string - nullable: true - description: Short description of the property - allowed_values: - type: array - items: - type: string - maxLength: 75 - maxItems: 200 - nullable: true - description: |- - An ordered list of the allowed values of the property. - The property can have up to 200 allowed values. - required: - - value_type + schema: *285 examples: default: value: @@ -35749,10 +37028,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: - - *145 + - *157 - *98 responses: - '204': *192 + '204': *204 '403': *29 '404': *7 x-github: @@ -35773,7 +37052,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: - - *145 + - *157 - *18 - *20 - name: repository_query @@ -35811,7 +37090,7 @@ paths: example: octocat/Hello-World properties: type: array - items: &273 + items: &286 title: Custom Property Value description: Custom property name and associated value type: object @@ -35878,7 +37157,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: - - *145 + - *157 requestBody: required: true content: @@ -35898,7 +37177,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *273 + items: *286 required: - repository_names - properties @@ -35939,7 +37218,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-public-organization-members parameters: - - *145 + - *157 - *18 - *20 responses: @@ -35951,7 +37230,7 @@ paths: type: array items: *19 examples: - default: *246 + default: *258 headers: Link: *39 x-github: @@ -35970,8 +37249,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: - - *145 - - *185 + - *157 + - *197 responses: '204': description: Response if user is a public member @@ -35995,8 +37274,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: - - *145 - - *185 + - *157 + - *197 responses: '204': description: Response @@ -36017,8 +37296,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: - - *145 - - *185 + - *157 + - *197 responses: '204': description: Response @@ -36042,7 +37321,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-organization-repositories parameters: - - *145 + - *157 - 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 @@ -36089,9 +37368,9 @@ paths: application/json: schema: type: array - items: *163 + items: *175 examples: - default: *265 + default: *277 headers: Link: *39 x-github: @@ -36112,7 +37391,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-organization-repository parameters: - - *145 + - *157 requestBody: required: true content: @@ -36294,7 +37573,7 @@ paths: description: Response content: application/json: - schema: &338 + schema: &345 title: Full Repository description: Full Repository type: object @@ -36571,8 +37850,8 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: *274 - required: *275 + properties: *287 + required: *288 nullable: true temp_clone_token: type: string @@ -36659,8 +37938,8 @@ paths: title: License Simple description: License Simple type: object - properties: *123 - required: *124 + properties: *135 + required: *136 nullable: true organization: title: Simple User @@ -36687,7 +37966,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &452 + properties: &459 url: type: string format: uri @@ -36703,12 +37982,12 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &453 + required: &460 - url - key - name - html_url - security_and_analysis: *276 + security_and_analysis: *289 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -36792,7 +38071,7 @@ paths: - network_count - subscribers_count examples: - default: &340 + default: &347 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -37310,7 +38589,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: - - *145 + - *157 responses: '200': description: Response @@ -37318,9 +38597,9 @@ paths: application/json: schema: type: array - items: *277 + items: *290 examples: - default: *278 + default: *291 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -37342,10 +38621,10 @@ paths: category: orgs subcategory: rules parameters: - - *145 + - *157 - *18 - *20 - - &588 + - &595 name: targets description: | A comma-separated list of rule targets to filter by. @@ -37363,931 +38642,7 @@ paths: application/json: schema: type: array - items: &285 - 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: &281 - 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: &282 - 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 - nullable: true - 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 - nullable: true - properties: - href: - type: string - description: The html URL of the ruleset - conditions: - nullable: true - anyOf: - - &279 - 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 - - &283 - 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: - - *279 - - 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: - - *279 - - 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: - - *279 - - 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: &280 - 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: *280 - required: - - repository_property - rules: - type: array - items: &284 - title: Repository Rule - type: object - description: A repository rule. - oneOf: - - &570 - title: creation - description: Only allow users with bypass permission to - create matching refs. - type: object - required: - - type - properties: - type: - type: string - enum: - - creation - - &571 - 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 - - &573 - title: deletion - description: Only allow users with bypass permissions to - delete matching refs. - type: object - required: - - type - properties: - type: - type: string - enum: - - deletion - - &574 - 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 - - &575 - 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 - - &576 - 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 - - &577 - title: required_signatures - description: Commits pushed to matching refs must have verified - signatures. - type: object - required: - - type - properties: - type: - type: string - enum: - - required_signatures - - &578 - 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 - - &579 - 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 - - &580 - 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 - - &581 - 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 - - &582 - 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 - - &583 - 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 - - &584 - 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 - - &585 - 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 - - &586 - 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 - - &587 - 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: *109 examples: default: value: @@ -38334,7 +38689,7 @@ paths: category: orgs subcategory: rules parameters: - - *145 + - *157 requestBody: description: Request body required: true @@ -38353,17 +38708,18 @@ paths: - branch - tag - push + - repository default: branch - enforcement: *281 + enforcement: *106 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *282 - conditions: *283 + items: *107 + conditions: *292 rules: type: array description: An array of rules within the ruleset. - items: *284 + items: *108 required: - name - enforcement @@ -38401,9 +38757,9 @@ paths: description: Response content: application/json: - schema: *285 + schema: *109 examples: - default: &286 + default: &293 value: id: 21 name: super cool ruleset @@ -38457,8 +38813,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *145 - - &589 + - *157 + - &596 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 @@ -38473,7 +38829,7 @@ paths: in: query schema: type: string - - &590 + - &597 name: time_period description: |- The time period to filter by. @@ -38489,14 +38845,14 @@ paths: - week - month default: day - - &591 + - &598 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 - - &592 + - &599 name: rule_suite_result description: The rule results to filter on. When specified, only suites with this result will be returned. @@ -38516,7 +38872,7 @@ paths: description: Response content: application/json: - schema: &593 + schema: &600 title: Rule Suites description: Response type: array @@ -38571,7 +38927,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &594 + default: &601 value: - id: 21 actor_id: 12 @@ -38614,8 +38970,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *145 - - &595 + - *157 + - &602 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -38631,7 +38987,7 @@ paths: description: Response content: application/json: - schema: &596 + schema: &603 title: Rule Suite description: Response type: object @@ -38730,7 +39086,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &597 + default: &604 value: id: 21 actor_id: 12 @@ -38791,7 +39147,7 @@ paths: category: orgs subcategory: rules parameters: - - *145 + - *157 - name: ruleset_id description: The ID of the ruleset. in: path @@ -38803,9 +39159,9 @@ paths: description: Response content: application/json: - schema: *285 + schema: *109 examples: - default: *286 + default: *293 '404': *7 '500': *84 put: @@ -38823,7 +39179,7 @@ paths: category: orgs subcategory: rules parameters: - - *145 + - *157 - name: ruleset_id description: The ID of the ruleset. in: path @@ -38848,16 +39204,17 @@ paths: - branch - tag - push - enforcement: *281 + - repository + enforcement: *106 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *282 - conditions: *283 + items: *107 + conditions: *292 rules: description: An array of rules within the ruleset. type: array - items: *284 + items: *108 examples: default: value: @@ -38892,9 +39249,9 @@ paths: description: Response content: application/json: - schema: *285 + schema: *109 examples: - default: *286 + default: *293 '404': *7 '500': *84 delete: @@ -38912,7 +39269,7 @@ paths: category: orgs subcategory: rules parameters: - - *145 + - *157 - name: ruleset_id description: The ID of the ruleset. in: path @@ -38940,15 +39297,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: - - *145 - - *287 - - *288 - - *289 - - *290 + - *157 + - *294 + - *295 + - *296 + - *297 - *78 - *20 - *18 - - &599 + - &606 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 @@ -38958,7 +39315,7 @@ paths: required: false schema: type: string - - &600 + - &607 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 @@ -38968,9 +39325,9 @@ paths: required: false schema: type: string - - *291 - - *292 - - *293 + - *298 + - *299 + - *300 responses: '200': description: Response @@ -38978,13 +39335,13 @@ paths: application/json: schema: type: array - items: *294 + items: *301 examples: - default: *295 + default: *302 headers: Link: *39 '404': *7 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39006,7 +39363,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: - - *145 + - *157 - *78 - name: sort description: The property to sort the results by. @@ -39050,7 +39407,7 @@ paths: application/json: schema: type: array - items: &607 + items: &614 description: A repository security advisory. type: object properties: @@ -39270,7 +39627,7 @@ paths: login: type: string description: The username of the user credited. - type: *296 + type: *303 credits_detailed: type: array nullable: true @@ -39280,7 +39637,7 @@ paths: type: object properties: user: *19 - type: *296 + type: *303 state: type: string description: The state of the user's acceptance of the @@ -39304,7 +39661,7 @@ paths: type: array description: A list of teams that collaborate on the advisory. nullable: true - items: *243 + items: *255 private_fork: readOnly: true nullable: true @@ -39341,7 +39698,7 @@ paths: - private_fork additionalProperties: false examples: - default: &608 + default: &615 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -39723,7 +40080,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#list-security-manager-teams parameters: - - *145 + - *157 responses: '200': description: Response @@ -39731,9 +40088,9 @@ paths: application/json: schema: type: array - items: *297 + items: *304 examples: - default: *258 + default: *270 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39756,8 +40113,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#add-a-security-manager-team parameters: - - *145 - - *255 + - *157 + - *267 responses: '204': description: Response @@ -39782,8 +40139,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *145 - - *255 + - *157 + - *267 responses: '204': description: Response @@ -39809,15 +40166,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: - - *145 + - *157 responses: '200': description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: *299 + default: *306 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -39841,7 +40198,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: - - *145 + - *157 - *18 - *20 responses: @@ -39849,9 +40206,9 @@ paths: description: Success content: application/json: - schema: *300 + schema: *307 examples: - default: *301 + default: *308 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -39873,15 +40230,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: - - *145 + - *157 responses: '200': description: Response content: application/json: - schema: *302 + schema: *309 examples: - default: *303 + default: *310 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -39903,15 +40260,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: - - *145 + - *157 responses: '200': description: Response content: application/json: - schema: *304 + schema: *311 examples: - default: *305 + default: *312 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -39928,7 +40285,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: - - *145 + - *157 - *18 - name: page description: Page token @@ -39947,7 +40304,7 @@ paths: description: Response content: application/json: - schema: &327 + schema: &334 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -39993,7 +40350,7 @@ paths: type: string nullable: true examples: - default: &328 + default: &335 value: groups: - group_id: '123' @@ -40038,8 +40395,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: - - *145 - - *255 + - *157 + - *267 - 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`). @@ -40071,13 +40428,13 @@ paths: application/json: schema: type: array - items: *102 + items: *114 examples: - default: *103 + default: *115 '500': *84 '403': *29 '404': *7 - '422': *104 + '422': *116 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40111,8 +40468,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: - - *145 - - *255 + - *157 + - *267 - 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`). @@ -40144,9 +40501,9 @@ paths: application/json: schema: type: array - items: *105 + items: *117 examples: - default: *199 + default: *211 '500': *84 '401': *25 '403': *29 @@ -40168,7 +40525,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-teams parameters: - - *145 + - *157 - *18 - *20 responses: @@ -40178,9 +40535,9 @@ paths: application/json: schema: type: array - items: *243 + items: *255 examples: - default: *258 + default: *270 headers: Link: *39 '403': *29 @@ -40202,7 +40559,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team parameters: - - *145 + - *157 requestBody: required: true content: @@ -40274,7 +40631,7 @@ paths: description: Response content: application/json: - schema: &306 + schema: &313 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -40337,8 +40694,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *256 - required: *257 + properties: *268 + required: *269 nullable: true members_count: type: integer @@ -40584,7 +40941,7 @@ paths: - repos_count - organization examples: - default: &307 + default: &314 value: id: 1 node_id: MDQ6VGVhbTE= @@ -40654,16 +41011,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name parameters: - - *145 - - *255 + - *157 + - *267 responses: '200': description: Response content: application/json: - schema: *306 + schema: *313 examples: - default: *307 + default: *314 '404': *7 x-github: githubCloudOnly: false @@ -40684,8 +41041,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team parameters: - - *145 - - *255 + - *157 + - *267 requestBody: required: false content: @@ -40747,16 +41104,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *306 + schema: *313 examples: - default: *307 + default: *314 '201': description: Response content: application/json: - schema: *306 + schema: *313 examples: - default: *307 + default: *314 '404': *7 '422': *16 '403': *29 @@ -40781,8 +41138,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team parameters: - - *145 - - *255 + - *157 + - *267 responses: '204': description: Response @@ -40808,8 +41165,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions parameters: - - *145 - - *255 + - *157 + - *267 - *78 - *18 - *20 @@ -40826,7 +41183,7 @@ paths: application/json: schema: type: array - items: &308 + items: &315 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -40905,7 +41262,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *110 + reactions: *122 required: - author - body @@ -40925,7 +41282,7 @@ paths: - updated_at - url examples: - default: &648 + default: &655 value: - author: login: octocat @@ -40999,8 +41356,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion parameters: - - *145 - - *255 + - *157 + - *267 requestBody: required: true content: @@ -41034,9 +41391,9 @@ paths: description: Response content: application/json: - schema: *308 + schema: *315 examples: - default: &309 + default: &316 value: author: login: octocat @@ -41108,9 +41465,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion parameters: - - *145 - - *255 - - &310 + - *157 + - *267 + - &317 name: discussion_number description: The number that identifies the discussion. in: path @@ -41122,9 +41479,9 @@ paths: description: Response content: application/json: - schema: *308 + schema: *315 examples: - default: *309 + default: *316 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41146,9 +41503,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion parameters: - - *145 - - *255 - - *310 + - *157 + - *267 + - *317 requestBody: required: false content: @@ -41171,9 +41528,9 @@ paths: description: Response content: application/json: - schema: *308 + schema: *315 examples: - default: &649 + default: &656 value: author: login: octocat @@ -41243,9 +41600,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion parameters: - - *145 - - *255 - - *310 + - *157 + - *267 + - *317 responses: '204': description: Response @@ -41271,9 +41628,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments parameters: - - *145 - - *255 - - *310 + - *157 + - *267 + - *317 - *78 - *18 - *20 @@ -41284,7 +41641,7 @@ paths: application/json: schema: type: array - items: &311 + items: &318 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -41341,7 +41698,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *110 + reactions: *122 required: - author - body @@ -41356,7 +41713,7 @@ paths: - updated_at - url examples: - default: &650 + default: &657 value: - author: login: octocat @@ -41424,9 +41781,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment parameters: - - *145 - - *255 - - *310 + - *157 + - *267 + - *317 requestBody: required: true content: @@ -41448,9 +41805,9 @@ paths: description: Response content: application/json: - schema: *311 + schema: *318 examples: - default: &312 + default: &319 value: author: login: octocat @@ -41516,10 +41873,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment parameters: - - *145 - - *255 - - *310 - - &313 + - *157 + - *267 + - *317 + - &320 name: comment_number description: The number that identifies the comment. in: path @@ -41531,9 +41888,9 @@ paths: description: Response content: application/json: - schema: *311 + schema: *318 examples: - default: *312 + default: *319 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41555,10 +41912,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment parameters: - - *145 - - *255 - - *310 - - *313 + - *157 + - *267 + - *317 + - *320 requestBody: required: true content: @@ -41580,9 +41937,9 @@ paths: description: Response content: application/json: - schema: *311 + schema: *318 examples: - default: &651 + default: &658 value: author: login: octocat @@ -41646,10 +42003,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment parameters: - - *145 - - *255 - - *310 - - *313 + - *157 + - *267 + - *317 + - *320 responses: '204': description: Response @@ -41675,10 +42032,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: - - *145 - - *255 - - *310 - - *313 + - *157 + - *267 + - *317 + - *320 - 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. @@ -41704,7 +42061,7 @@ paths: application/json: schema: type: array - items: &314 + items: &321 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -41747,7 +42104,7 @@ paths: - content - created_at examples: - default: &316 + default: &323 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -41797,10 +42154,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: - - *145 - - *255 - - *310 - - *313 + - *157 + - *267 + - *317 + - *320 requestBody: required: true content: @@ -41833,9 +42190,9 @@ paths: team discussion comment content: application/json: - schema: *314 + schema: *321 examples: - default: &315 + default: &322 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -41864,9 +42221,9 @@ paths: description: Response content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41889,11 +42246,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - - *145 - - *255 - - *310 - - *313 - - &317 + - *157 + - *267 + - *317 + - *320 + - &324 name: reaction_id description: The unique identifier of the reaction. in: path @@ -41925,9 +42282,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - - *145 - - *255 - - *310 + - *157 + - *267 + - *317 - 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. @@ -41953,9 +42310,9 @@ paths: application/json: schema: type: array - items: *314 + items: *321 examples: - default: *316 + default: *323 headers: Link: *39 x-github: @@ -41981,9 +42338,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - - *145 - - *255 - - *310 + - *157 + - *267 + - *317 requestBody: required: true content: @@ -42015,16 +42372,16 @@ paths: description: Response content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 '201': description: Response content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -42047,10 +42404,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-reaction parameters: - - *145 - - *255 - - *310 + - *157 + - *267 - *317 + - *324 responses: '204': description: Response @@ -42073,16 +42430,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: - - *145 - - *255 + - *157 + - *267 responses: '200': description: Response content: application/json: - schema: *318 + schema: *325 examples: - default: *319 + default: *326 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -42101,8 +42458,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: - - *145 - - *255 + - *157 + - *267 requestBody: required: true content: @@ -42125,9 +42482,9 @@ paths: description: Response content: application/json: - schema: *320 + schema: *327 examples: - default: *321 + default: *328 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -42146,8 +42503,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: - - *145 - - *255 + - *157 + - *267 responses: '204': description: Response @@ -42171,8 +42528,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations parameters: - - *145 - - *255 + - *157 + - *267 - *18 - *20 responses: @@ -42182,9 +42539,9 @@ paths: application/json: schema: type: array - items: *240 + items: *252 examples: - default: *241 + default: *253 headers: Link: *39 x-github: @@ -42206,8 +42563,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members parameters: - - *145 - - *255 + - *157 + - *267 - name: role description: Filters members returned by their role in the team. in: query @@ -42230,7 +42587,7 @@ paths: type: array items: *19 examples: - default: *246 + default: *258 headers: Link: *39 x-github: @@ -42260,15 +42617,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user parameters: - - *145 - - *255 - - *185 + - *157 + - *267 + - *197 responses: '200': description: Response content: application/json: - schema: &322 + schema: &329 title: Team Membership description: Team Membership type: object @@ -42295,7 +42652,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &652 + response-if-user-is-a-team-maintainer: &659 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -42331,9 +42688,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: - - *145 - - *255 - - *185 + - *157 + - *267 + - *197 requestBody: required: false content: @@ -42358,9 +42715,9 @@ paths: description: Response content: application/json: - schema: *322 + schema: *329 examples: - response-if-users-membership-with-team-is-now-pending: &653 + response-if-users-membership-with-team-is-now-pending: &660 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -42395,9 +42752,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user parameters: - - *145 - - *255 - - *185 + - *157 + - *267 + - *197 responses: '204': description: Response @@ -42423,8 +42780,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects parameters: - - *145 - - *255 + - *157 + - *267 - *18 - *20 responses: @@ -42434,7 +42791,7 @@ paths: application/json: schema: type: array - items: &323 + items: &330 title: Team Project description: A team's access to a project. type: object @@ -42502,7 +42859,7 @@ paths: - updated_at - permissions examples: - default: &654 + default: &661 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -42563,9 +42920,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project parameters: - - *145 - - *255 - - &324 + - *157 + - *267 + - &331 name: project_id description: The unique identifier of the project. in: path @@ -42577,9 +42934,9 @@ paths: description: Response content: application/json: - schema: *323 + schema: *330 examples: - default: &655 + default: &662 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -42639,9 +42996,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions parameters: - - *145 - - *255 - - *324 + - *157 + - *267 + - *331 requestBody: required: false content: @@ -42705,9 +43062,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team parameters: - - *145 - - *255 - - *324 + - *157 + - *267 + - *331 responses: '204': description: Response @@ -42731,8 +43088,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories parameters: - - *145 - - *255 + - *157 + - *267 - *18 - *20 responses: @@ -42742,9 +43099,9 @@ paths: application/json: schema: type: array - items: *163 + items: *175 examples: - default: *265 + default: *277 headers: Link: *39 x-github: @@ -42773,16 +43130,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *145 - - *255 - - *325 - - *326 + - *157 + - *267 + - *332 + - *333 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &656 + schema: &663 title: Team Repository description: A team's access to a repository. type: object @@ -42805,8 +43162,8 @@ paths: title: License Simple description: License Simple type: object - properties: *123 - required: *124 + properties: *135 + required: *136 nullable: true forks: type: integer @@ -43351,10 +43708,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *145 - - *255 - - *325 - - *326 + - *157 + - *267 + - *332 + - *333 requestBody: required: false content: @@ -43399,10 +43756,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team parameters: - - *145 - - *255 - - *325 - - *326 + - *157 + - *267 + - *332 + - *333 responses: '204': description: Response @@ -43428,16 +43785,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: - - *145 - - *255 + - *157 + - *267 responses: '200': description: Response content: application/json: - schema: *327 + schema: *334 examples: - default: *328 + default: *335 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -43459,8 +43816,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: - - *145 - - *255 + - *157 + - *267 requestBody: required: true content: @@ -43503,7 +43860,7 @@ paths: description: Response content: application/json: - schema: *327 + schema: *334 examples: default: value: @@ -43535,8 +43892,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams parameters: - - *145 - - *255 + - *157 + - *267 - *18 - *20 responses: @@ -43546,9 +43903,9 @@ paths: application/json: schema: type: array - items: *243 + items: *255 examples: - response-if-child-teams-exist: &657 + response-if-child-teams-exist: &664 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -43601,7 +43958,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: - - *145 + - *157 - name: security_product in: path description: The security feature to enable or disable. @@ -43672,7 +44029,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#get-a-project-card parameters: - - &329 + - &336 name: card_id description: The unique identifier of the card. in: path @@ -43684,7 +44041,7 @@ paths: description: Response content: application/json: - schema: &330 + schema: &337 title: Project Card description: Project cards represent a scope of work. type: object @@ -43751,7 +44108,7 @@ paths: - created_at - updated_at examples: - default: &331 + default: &338 value: url: https://api.github.com/projects/columns/cards/1478 id: 1478 @@ -43801,7 +44158,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#update-an-existing-project-card parameters: - - *329 + - *336 requestBody: required: false content: @@ -43828,9 +44185,9 @@ paths: description: Response content: application/json: - schema: *330 + schema: *337 examples: - default: *331 + default: *338 '304': *37 '403': *29 '401': *25 @@ -43851,7 +44208,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#delete-a-project-card parameters: - - *329 + - *336 responses: '204': description: Response @@ -43889,7 +44246,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#move-a-project-card parameters: - - *329 + - *336 requestBody: required: true content: @@ -43994,7 +44351,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#get-a-project-column parameters: - - &332 + - &339 name: column_id description: The unique identifier of the column. in: path @@ -44006,7 +44363,7 @@ paths: description: Response content: application/json: - schema: &333 + schema: &340 title: Project Column description: Project columns contain cards of work. type: object @@ -44052,7 +44409,7 @@ paths: - created_at - updated_at examples: - default: &334 + default: &341 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -44081,7 +44438,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#update-an-existing-project-column parameters: - - *332 + - *339 requestBody: required: true content: @@ -44105,9 +44462,9 @@ paths: description: Response content: application/json: - schema: *333 + schema: *340 examples: - default: *334 + default: *341 '304': *37 '403': *29 '401': *25 @@ -44126,7 +44483,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#delete-a-project-column parameters: - - *332 + - *339 responses: '204': description: Response @@ -44149,7 +44506,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#list-project-cards parameters: - - *332 + - *339 - name: archived_state description: Filters the project cards that are returned by the card's state. in: query @@ -44170,7 +44527,7 @@ paths: application/json: schema: type: array - items: *330 + items: *337 examples: default: value: @@ -44223,7 +44580,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#create-a-project-card parameters: - - *332 + - *339 requestBody: required: true content: @@ -44263,9 +44620,9 @@ paths: description: Response content: application/json: - schema: *330 + schema: *337 examples: - default: *331 + default: *338 '304': *37 '403': *29 '401': *25 @@ -44275,8 +44632,8 @@ paths: application/json: schema: oneOf: - - *148 - - *149 + - *160 + - *161 '503': description: Response content: @@ -44315,7 +44672,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#move-a-project-column parameters: - - *332 + - *339 requestBody: required: true content: @@ -44371,15 +44728,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-a-project parameters: - - *324 + - *331 responses: '200': description: Response content: application/json: - schema: *272 + schema: *284 examples: - default: &335 + default: &342 value: owner_url: https://api.github.com/repos/api-playground/projects-test url: https://api.github.com/projects/1002604 @@ -44432,7 +44789,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#update-a-project parameters: - - *324 + - *331 requestBody: required: false content: @@ -44478,9 +44835,9 @@ paths: description: Response content: application/json: - schema: *272 + schema: *284 examples: - default: *335 + default: *342 '404': description: Not Found if the authenticated user does not have access to the project @@ -44501,7 +44858,7 @@ paths: items: type: string '401': *25 - '410': *336 + '410': *343 '422': *8 x-github: githubCloudOnly: false @@ -44519,7 +44876,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#delete-a-project parameters: - - *324 + - *331 responses: '204': description: Delete Success @@ -44540,7 +44897,7 @@ paths: items: type: string '401': *25 - '410': *336 + '410': *343 '404': *7 x-github: githubCloudOnly: false @@ -44563,7 +44920,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#list-project-collaborators parameters: - - *324 + - *331 - 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 @@ -44590,7 +44947,7 @@ paths: type: array items: *19 examples: - default: *246 + default: *258 headers: Link: *39 '404': *7 @@ -44615,8 +44972,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#add-project-collaborator parameters: - - *324 - - *185 + - *331 + - *197 requestBody: required: false content: @@ -44663,8 +45020,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#remove-user-as-a-collaborator parameters: - - *324 - - *185 + - *331 + - *197 responses: '204': description: Response @@ -44692,8 +45049,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#get-project-permission-for-a-user parameters: - - *324 - - *185 + - *331 + - *197 responses: '200': description: Response @@ -44760,7 +45117,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#list-project-columns parameters: - - *324 + - *331 - *18 - *20 responses: @@ -44770,7 +45127,7 @@ paths: application/json: schema: type: array - items: *333 + items: *340 examples: default: value: @@ -44802,7 +45159,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#create-a-project-column parameters: - - *324 + - *331 requestBody: required: true content: @@ -44825,7 +45182,7 @@ paths: description: Response content: application/json: - schema: *333 + schema: *340 examples: default: value: @@ -44886,7 +45243,7 @@ paths: resources: type: object properties: - core: &337 + core: &344 title: Rate Limit type: object properties: @@ -44903,19 +45260,20 @@ paths: - remaining - reset - used - graphql: *337 - search: *337 - code_search: *337 - source_import: *337 - integration_manifest: *337 - code_scanning_upload: *337 - actions_runner_registration: *337 - scim: *337 - dependency_snapshots: *337 + graphql: *344 + search: *344 + code_search: *344 + source_import: *344 + integration_manifest: *344 + code_scanning_upload: *344 + actions_runner_registration: *344 + scim: *344 + dependency_snapshots: *344 + code_scanning_autofix: *344 required: - core - search - rate: *337 + rate: *344 required: - rate - resources @@ -44973,6 +45331,11 @@ paths: used: 0 remaining: 10 reset: 1691591091 + code_scanning_autofix: + limit: 10 + used: 0 + remaining: 10 + reset: 1691591091 rate: limit: 5000 used: 1 @@ -45014,14 +45377,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *338 + schema: *345 examples: default-response: summary: Default response @@ -45526,7 +45889,7 @@ paths: status: disabled '403': *29 '404': *7 - '301': *339 + '301': *346 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45544,8 +45907,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: false content: @@ -45791,10 +46154,10 @@ paths: description: Response content: application/json: - schema: *338 + schema: *345 examples: - default: *340 - '307': &341 + default: *347 + '307': &348 description: Temporary Redirect content: application/json: @@ -45823,8 +46186,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository parameters: - - *325 - - *326 + - *332 + - *333 responses: '204': description: Response @@ -45846,7 +46209,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': *341 + '307': *348 '404': *7 x-github: githubCloudOnly: false @@ -45869,11 +46232,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 - - &356 + - &363 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -45896,7 +46259,7 @@ paths: type: integer artifacts: type: array - items: &342 + items: &349 title: Artifact description: An artifact type: object @@ -45967,7 +46330,7 @@ paths: - expires_at - updated_at examples: - default: &357 + default: &364 value: total_count: 2 artifacts: @@ -46026,9 +46389,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact parameters: - - *325 - - *326 - - &343 + - *332 + - *333 + - &350 name: artifact_id description: The unique identifier of the artifact. in: path @@ -46040,7 +46403,7 @@ paths: description: Response content: application/json: - schema: *342 + schema: *349 examples: default: value: @@ -46077,9 +46440,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact parameters: - - *325 - - *326 - - *343 + - *332 + - *333 + - *350 responses: '204': description: Response @@ -46103,9 +46466,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact parameters: - - *325 - - *326 - - *343 + - *332 + - *333 + - *350 - name: archive_format in: path required: true @@ -46119,7 +46482,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': *336 + '410': *343 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46142,14 +46505,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *344 + schema: *351 examples: default: value: @@ -46175,11 +46538,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: - - *325 - - *326 + - *332 + - *333 - *18 - *20 - - &345 + - &352 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 @@ -46213,7 +46576,7 @@ paths: description: Response content: application/json: - schema: &346 + schema: &353 title: Repository actions caches description: Repository actions caches type: object @@ -46255,7 +46618,7 @@ paths: - total_count - actions_caches examples: - default: &347 + default: &354 value: total_count: 1 actions_caches: @@ -46287,23 +46650,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: - - *325 - - *326 + - *332 + - *333 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *345 + - *352 responses: '200': description: Response content: application/json: - schema: *346 + schema: *353 examples: - default: *347 + default: *354 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46323,8 +46686,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: - - *325 - - *326 + - *332 + - *333 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -46355,9 +46718,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: - - *325 - - *326 - - &348 + - *332 + - *333 + - &355 name: job_id description: The unique identifier of the job. in: path @@ -46369,7 +46732,7 @@ paths: description: Response content: application/json: - schema: &360 + schema: &367 title: Job description: Information of a job execution in a workflow run type: object @@ -46676,9 +47039,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: - - *325 - - *326 - - *348 + - *332 + - *333 + - *355 responses: '302': description: Response @@ -46706,9 +47069,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: - - *325 - - *326 - - *348 + - *332 + - *333 + - *355 requestBody: required: false content: @@ -46729,7 +47092,7 @@ paths: description: Response content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -46753,8 +47116,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Status response @@ -46804,8 +47167,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: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -46839,7 +47202,7 @@ paths: description: Empty response content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -46868,8 +47231,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -46887,7 +47250,7 @@ paths: type: integer secrets: type: array - items: &362 + items: &369 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -46907,7 +47270,7 @@ paths: - created_at - updated_at examples: - default: &363 + default: &370 value: total_count: 2 secrets: @@ -46940,9 +47303,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables parameters: - - *325 - - *326 - - *349 + - *332 + - *333 + - *356 - *20 responses: '200': @@ -46959,7 +47322,7 @@ paths: type: integer variables: type: array - items: &366 + items: &373 title: Actions Variable type: object properties: @@ -46989,7 +47352,7 @@ paths: - created_at - updated_at examples: - default: &367 + default: &374 value: total_count: 2 variables: @@ -47022,8 +47385,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -47032,11 +47395,11 @@ paths: schema: type: object properties: - enabled: &350 + enabled: &357 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *42 - selected_actions_url: *156 + selected_actions_url: *168 required: - enabled examples: @@ -47065,8 +47428,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: - - *325 - - *326 + - *332 + - *333 responses: '204': description: Response @@ -47077,7 +47440,7 @@ paths: schema: type: object properties: - enabled: *350 + enabled: *357 allowed_actions: *42 required: - enabled @@ -47108,14 +47471,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: &351 + schema: &358 type: object properties: access_level: @@ -47133,7 +47496,7 @@ paths: required: - access_level examples: - default: &352 + default: &359 value: access_level: organization x-github: @@ -47158,15 +47521,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: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: application/json: - schema: *351 + schema: *358 examples: - default: *352 + default: *359 responses: '204': description: Response @@ -47190,8 +47553,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -47222,8 +47585,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: - - *325 - - *326 + - *332 + - *333 responses: '204': description: Response @@ -47255,14 +47618,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *159 + schema: *171 examples: default: *48 x-github: @@ -47285,8 +47648,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: - - *325 - - *326 + - *332 + - *333 responses: '204': description: Success response @@ -47297,7 +47660,7 @@ paths: required: true content: application/json: - schema: *160 + schema: *172 examples: default: *48 x-github: @@ -47326,8 +47689,8 @@ paths: in: query schema: type: string - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -47371,8 +47734,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -47380,9 +47743,9 @@ paths: application/json: schema: type: array - items: *164 + items: *176 examples: - default: *165 + default: *177 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47404,8 +47767,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: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -47448,7 +47811,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *166 + '201': *178 '404': *7 '422': *8 x-github: @@ -47478,8 +47841,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: - - *325 - - *326 + - *332 + - *333 responses: '201': description: Response @@ -47487,7 +47850,7 @@ paths: application/json: schema: *58 examples: - default: *167 + default: *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47515,8 +47878,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: - - *325 - - *326 + - *332 + - *333 responses: '201': description: Response @@ -47524,7 +47887,7 @@ paths: application/json: schema: *58 examples: - default: *168 + default: *180 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47546,8 +47909,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: - - *325 - - *326 + - *332 + - *333 - *54 responses: '200': @@ -47556,7 +47919,7 @@ paths: application/json: schema: *55 examples: - default: *169 + default: *181 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47577,8 +47940,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: - - *325 - - *326 + - *332 + - *333 - *54 responses: '204': @@ -47604,8 +47967,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: - - *325 - - *326 + - *332 + - *333 - *54 responses: '200': *60 @@ -47630,8 +47993,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: - - *325 - - *326 + - *332 + - *333 - *54 requestBody: required: true @@ -47680,8 +48043,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: - - *325 - - *326 + - *332 + - *333 - *54 requestBody: required: true @@ -47731,11 +48094,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: - - *325 - - *326 + - *332 + - *333 - *54 responses: - '200': *170 + '200': *182 '404': *7 x-github: githubCloudOnly: false @@ -47762,10 +48125,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: - - *325 - - *326 + - *332 + - *333 - *54 - - *171 + - *183 responses: '200': *60 '404': *7 @@ -47793,9 +48156,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: - - *325 - - *326 - - &370 + - *332 + - *333 + - &377 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. @@ -47803,7 +48166,7 @@ paths: required: false schema: type: string - - &371 + - &378 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -47811,7 +48174,7 @@ paths: required: false schema: type: string - - &372 + - &379 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -47820,7 +48183,7 @@ paths: required: false schema: type: string - - &373 + - &380 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 @@ -47847,7 +48210,7 @@ paths: - pending - *18 - *20 - - &374 + - &381 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)." @@ -47856,7 +48219,7 @@ paths: schema: type: string format: date-time - - &353 + - &360 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -47865,13 +48228,13 @@ paths: schema: type: boolean default: false - - &375 + - &382 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &376 + - &383 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -47894,7 +48257,7 @@ paths: type: integer workflow_runs: type: array - items: &354 + items: &361 title: Workflow Run description: An invocation of a workflow type: object @@ -47989,7 +48352,7 @@ paths: that triggered the run. type: array nullable: true - items: &395 + items: &402 title: Pull Request Minimal type: object properties: @@ -48108,7 +48471,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &399 + properties: &406 id: type: string description: SHA for the commit @@ -48159,7 +48522,7 @@ paths: - name - email nullable: true - required: &400 + required: &407 - id - tree_id - message @@ -48167,8 +48530,8 @@ paths: - author - committer nullable: true - repository: *163 - head_repository: *163 + repository: *175 + head_repository: *175 head_repository_id: type: integer example: 5 @@ -48206,7 +48569,7 @@ paths: - workflow_url - pull_requests examples: - default: &377 + default: &384 value: total_count: 1 workflow_runs: @@ -48442,24 +48805,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run parameters: - - *325 - - *326 - - &355 + - *332 + - *333 + - &362 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *353 + - *360 responses: '200': description: Response content: application/json: - schema: *354 + schema: *361 examples: - default: &358 + default: &365 value: id: 30433642 name: Build @@ -48700,9 +49063,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *325 - - *326 - - *355 + - *332 + - *333 + - *362 responses: '204': description: Response @@ -48725,9 +49088,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: - - *325 - - *326 - - *355 + - *332 + - *333 + - *362 responses: '200': description: Response @@ -48846,15 +49209,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: - - *325 - - *326 - - *355 + - *332 + - *333 + - *362 responses: '201': description: Response content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -48881,12 +49244,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *325 - - *326 - - *355 + - *332 + - *333 + - *362 - *18 - *20 - - *356 + - *363 responses: '200': description: Response @@ -48902,9 +49265,9 @@ paths: type: integer artifacts: type: array - items: *342 + items: *349 examples: - default: *357 + default: *364 headers: Link: *39 x-github: @@ -48928,25 +49291,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *325 - - *326 - - *355 - - &359 + - *332 + - *333 + - *362 + - &366 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *353 + - *360 responses: '200': description: Response content: application/json: - schema: *354 + schema: *361 examples: - default: *358 + default: *365 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48969,10 +49332,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: - - *325 - - *326 - - *355 - - *359 + - *332 + - *333 + - *362 + - *366 - *18 - *20 responses: @@ -48990,9 +49353,9 @@ paths: type: integer jobs: type: array - items: *360 + items: *367 examples: - default: &361 + default: &368 value: total_count: 1 jobs: @@ -49105,10 +49468,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *325 - - *326 - - *355 - - *359 + - *332 + - *333 + - *362 + - *366 responses: '302': description: Response @@ -49136,19 +49499,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *325 - - *326 - - *355 + - *332 + - *333 + - *362 responses: '202': description: Response content: application/json: - schema: *174 + schema: *186 examples: default: value: - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49171,9 +49534,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: - - *325 - - *326 - - *355 + - *332 + - *333 + - *362 requestBody: required: true content: @@ -49240,19 +49603,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *325 - - *326 - - *355 + - *332 + - *333 + - *362 responses: '202': description: Response content: application/json: - schema: *174 + schema: *186 examples: default: value: - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49275,9 +49638,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: - - *325 - - *326 - - *355 + - *332 + - *333 + - *362 - 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 @@ -49307,9 +49670,9 @@ paths: type: integer jobs: type: array - items: *360 + items: *367 examples: - default: *361 + default: *368 headers: Link: *39 x-github: @@ -49334,9 +49697,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *325 - - *326 - - *355 + - *332 + - *333 + - *362 responses: '302': description: Response @@ -49363,9 +49726,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *325 - - *326 - - *355 + - *332 + - *333 + - *362 responses: '204': description: Response @@ -49392,9 +49755,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: - - *325 - - *326 - - *355 + - *332 + - *333 + - *362 responses: '200': description: Response @@ -49454,7 +49817,7 @@ paths: items: type: object properties: - type: &473 + type: &480 type: string description: The type of reviewer. enum: @@ -49464,7 +49827,7 @@ paths: reviewer: anyOf: - *19 - - *243 + - *255 required: - environment - wait_timer @@ -49539,9 +49902,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: - - *325 - - *326 - - *355 + - *332 + - *333 + - *362 requestBody: required: true content: @@ -49588,7 +49951,7 @@ paths: application/json: schema: type: array - items: &468 + items: &475 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -49676,8 +50039,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 required: - id - node_id @@ -49694,7 +50057,7 @@ paths: - created_at - updated_at examples: - default: &469 + default: &476 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -49750,9 +50113,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow parameters: - - *325 - - *326 - - *355 + - *332 + - *333 + - *362 requestBody: required: false content: @@ -49773,7 +50136,7 @@ paths: description: Response content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -49796,9 +50159,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: - - *325 - - *326 - - *355 + - *332 + - *333 + - *362 requestBody: required: false content: @@ -49819,7 +50182,7 @@ paths: description: Response content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -49844,9 +50207,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *325 - - *326 - - *355 + - *332 + - *333 + - *362 responses: '200': description: Response @@ -49983,8 +50346,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -50002,9 +50365,9 @@ paths: type: integer secrets: type: array - items: *362 + items: *369 examples: - default: *363 + default: *370 headers: Link: *39 x-github: @@ -50029,16 +50392,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *364 + schema: *371 examples: - default: *365 + default: *372 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50060,17 +50423,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret parameters: - - *325 - - *326 - - *173 + - *332 + - *333 + - *185 responses: '200': description: Response content: application/json: - schema: *362 + schema: *369 examples: - default: &486 + default: &493 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -50096,9 +50459,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *325 - - *326 - - *173 + - *332 + - *333 + - *185 requestBody: required: true content: @@ -50126,7 +50489,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -50152,9 +50515,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret parameters: - - *325 - - *326 - - *173 + - *332 + - *333 + - *185 responses: '204': description: Response @@ -50179,9 +50542,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables parameters: - - *325 - - *326 - - *349 + - *332 + - *333 + - *356 - *20 responses: '200': @@ -50198,9 +50561,9 @@ paths: type: integer variables: type: array - items: *366 + items: *373 examples: - default: *367 + default: *374 headers: Link: *39 x-github: @@ -50223,8 +50586,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -50251,7 +50614,7 @@ paths: description: Response content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -50276,17 +50639,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable parameters: - - *325 - - *326 - - *176 + - *332 + - *333 + - *188 responses: '200': description: Response content: application/json: - schema: *366 + schema: *373 examples: - default: &487 + default: &494 value: name: USERNAME value: octocat @@ -50312,9 +50675,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable parameters: - - *325 - - *326 - - *176 + - *332 + - *333 + - *188 requestBody: required: true content: @@ -50356,9 +50719,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable parameters: - - *325 - - *326 - - *176 + - *332 + - *333 + - *188 responses: '204': description: Response @@ -50383,8 +50746,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -50402,7 +50765,7 @@ paths: type: integer workflows: type: array - items: &368 + items: &375 title: Workflow description: A GitHub Actions workflow type: object @@ -50509,9 +50872,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow parameters: - - *325 - - *326 - - &369 + - *332 + - *333 + - &376 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -50526,7 +50889,7 @@ paths: description: Response content: application/json: - schema: *368 + schema: *375 examples: default: value: @@ -50559,9 +50922,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow parameters: - - *325 - - *326 - - *369 + - *332 + - *333 + - *376 responses: '204': description: Response @@ -50586,9 +50949,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *325 - - *326 - - *369 + - *332 + - *333 + - *376 responses: '204': description: Response @@ -50639,9 +51002,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow parameters: - - *325 - - *326 - - *369 + - *332 + - *333 + - *376 responses: '204': description: Response @@ -50668,19 +51031,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: - - *325 - - *326 - - *369 - - *370 - - *371 - - *372 - - *373 + - *332 + - *333 + - *376 + - *377 + - *378 + - *379 + - *380 - *18 - *20 - - *374 - - *353 - - *375 - - *376 + - *381 + - *360 + - *382 + - *383 responses: '200': description: Response @@ -50696,9 +51059,9 @@ paths: type: integer workflow_runs: type: array - items: *354 + items: *361 examples: - default: *377 + default: *384 headers: Link: *39 x-github: @@ -50724,9 +51087,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage parameters: - - *325 - - *326 - - *369 + - *332 + - *333 + - *376 responses: '200': description: Response @@ -50787,8 +51150,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities parameters: - - *325 - - *326 + - *332 + - *333 - *78 - *18 - *76 @@ -50952,8 +51315,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -50965,7 +51328,7 @@ paths: type: array items: *19 examples: - default: *246 + default: *258 headers: Link: *39 '404': *7 @@ -50990,8 +51353,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: - - *325 - - *326 + - *332 + - *333 - name: assignee in: path required: true @@ -51027,8 +51390,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-attestation parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -51140,8 +51503,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-attestations parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *76 - *77 @@ -51184,8 +51547,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: *378 + default: *385 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51205,8 +51570,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -51214,7 +51579,7 @@ paths: application/json: schema: type: array - items: &379 + items: &386 title: Autolink reference description: An autolink reference. type: object @@ -51264,8 +51629,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: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -51304,9 +51669,9 @@ paths: description: response content: application/json: - schema: *379 + schema: *386 examples: - default: &380 + default: &387 value: id: 1 key_prefix: TICKET- @@ -51337,9 +51702,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: - - *325 - - *326 - - &381 + - *332 + - *333 + - &388 name: autolink_id description: The unique identifier of the autolink. in: path @@ -51351,9 +51716,9 @@ paths: description: Response content: application/json: - schema: *379 + schema: *386 examples: - default: *380 + default: *387 '404': *7 x-github: githubCloudOnly: false @@ -51373,9 +51738,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: - - *325 - - *326 - - *381 + - *332 + - *333 + - *388 responses: '204': description: Response @@ -51399,8 +51764,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response if Dependabot is enabled @@ -51448,8 +51813,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-automated-security-fixes parameters: - - *325 - - *326 + - *332 + - *333 responses: '204': description: Response @@ -51470,8 +51835,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-automated-security-fixes parameters: - - *325 - - *326 + - *332 + - *333 responses: '204': description: Response @@ -51491,8 +51856,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches parameters: - - *325 - - *326 + - *332 + - *333 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -51530,7 +51895,7 @@ paths: - url protected: type: boolean - protection: &383 + protection: &390 title: Branch Protection description: Branch Protection type: object @@ -51572,7 +51937,7 @@ paths: required: - contexts - checks - enforce_admins: &386 + enforce_admins: &393 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -51587,7 +51952,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &388 + required_pull_request_reviews: &395 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -51608,7 +51973,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *243 + items: *255 apps: description: The list of apps with review dismissal access. @@ -51637,7 +52002,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *243 + items: *255 apps: description: The list of apps allowed to bypass pull request requirements. @@ -51663,7 +52028,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &385 + restrictions: &392 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -51970,9 +52335,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch parameters: - - *325 - - *326 - - &384 + - *332 + - *333 + - &391 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). @@ -51986,14 +52351,14 @@ paths: description: Response content: application/json: - schema: &394 + schema: &401 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &441 + commit: &448 title: Commit description: Commit type: object @@ -52027,7 +52392,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &382 + properties: &389 name: type: string example: '"Chris Wanstrath"' @@ -52042,7 +52407,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *382 + properties: *389 nullable: true message: type: string @@ -52063,7 +52428,7 @@ paths: required: - sha - url - verification: &493 + verification: &500 title: Verification type: object properties: @@ -52096,12 +52461,12 @@ paths: nullable: true oneOf: - *19 - - *174 + - *186 committer: nullable: true oneOf: - *19 - - *174 + - *186 parents: type: array items: @@ -52132,7 +52497,7 @@ paths: type: integer files: type: array - items: &456 + items: &463 title: Diff Entry description: Diff Entry type: object @@ -52215,7 +52580,7 @@ paths: - self protected: type: boolean - protection: *383 + protection: *390 protection_url: type: string format: uri @@ -52322,7 +52687,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *339 + '301': *346 '404': *7 x-github: githubCloudOnly: false @@ -52344,15 +52709,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 responses: '200': description: Response content: application/json: - schema: *383 + schema: *390 examples: default: value: @@ -52546,9 +52911,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 requestBody: required: true content: @@ -52803,7 +53168,7 @@ paths: url: type: string format: uri - required_status_checks: &391 + required_status_checks: &398 title: Status Check Policy description: Status Check Policy type: object @@ -52879,7 +53244,7 @@ paths: items: *19 teams: type: array - items: *243 + items: *255 apps: type: array items: *6 @@ -52897,7 +53262,7 @@ paths: items: *19 teams: type: array - items: *243 + items: *255 apps: type: array items: *6 @@ -52955,7 +53320,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *385 + restrictions: *392 required_conversation_resolution: type: object properties: @@ -53067,9 +53432,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 responses: '204': description: Response @@ -53094,17 +53459,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 responses: '200': description: Response content: application/json: - schema: *386 + schema: *393 examples: - default: &387 + default: &394 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -53126,17 +53491,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 responses: '200': description: Response content: application/json: - schema: *386 + schema: *393 examples: - default: *387 + default: *394 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53155,9 +53520,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 responses: '204': description: Response @@ -53182,17 +53547,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 responses: '200': description: Response content: application/json: - schema: *388 + schema: *395 examples: - default: &389 + default: &396 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -53288,9 +53653,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 requestBody: required: false content: @@ -53388,9 +53753,9 @@ paths: description: Response content: application/json: - schema: *388 + schema: *395 examples: - default: *389 + default: *396 '422': *16 x-github: githubCloudOnly: false @@ -53411,9 +53776,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 responses: '204': description: Response @@ -53440,17 +53805,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 responses: '200': description: Response content: application/json: - schema: *386 + schema: *393 examples: - default: &390 + default: &397 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -53473,17 +53838,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 responses: '200': description: Response content: application/json: - schema: *386 + schema: *393 examples: - default: *390 + default: *397 '404': *7 x-github: githubCloudOnly: false @@ -53503,9 +53868,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 responses: '204': description: Response @@ -53530,17 +53895,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 responses: '200': description: Response content: application/json: - schema: *391 + schema: *398 examples: - default: &392 + default: &399 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -53566,9 +53931,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 requestBody: required: false content: @@ -53620,9 +53985,9 @@ paths: description: Response content: application/json: - schema: *391 + schema: *398 examples: - default: *392 + default: *399 '404': *7 '422': *16 x-github: @@ -53644,9 +54009,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 responses: '204': description: Response @@ -53670,9 +54035,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 responses: '200': description: Response @@ -53706,9 +54071,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 requestBody: required: false content: @@ -53775,9 +54140,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 requestBody: required: false content: @@ -53841,9 +54206,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 requestBody: content: application/json: @@ -53909,15 +54274,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 responses: '200': description: Response content: application/json: - schema: *385 + schema: *392 examples: default: value: @@ -54008,9 +54373,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 responses: '204': description: Response @@ -54033,9 +54398,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: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 responses: '200': description: Response @@ -54045,7 +54410,7 @@ paths: type: array items: *6 examples: - default: &393 + default: &400 value: - id: 1 slug: octoapp @@ -54102,9 +54467,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 requestBody: required: true content: @@ -54138,7 +54503,7 @@ paths: type: array items: *6 examples: - default: *393 + default: *400 '422': *16 x-github: githubCloudOnly: false @@ -54159,9 +54524,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 requestBody: required: true content: @@ -54195,7 +54560,7 @@ paths: type: array items: *6 examples: - default: *393 + default: *400 '422': *16 x-github: githubCloudOnly: false @@ -54216,9 +54581,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 requestBody: required: true content: @@ -54252,7 +54617,7 @@ paths: type: array items: *6 examples: - default: *393 + default: *400 '422': *16 x-github: githubCloudOnly: false @@ -54274,9 +54639,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: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 responses: '200': description: Response @@ -54284,9 +54649,9 @@ paths: application/json: schema: type: array - items: *243 + items: *255 examples: - default: *258 + default: *270 '404': *7 x-github: githubCloudOnly: false @@ -54306,9 +54671,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 requestBody: required: false content: @@ -54344,9 +54709,9 @@ paths: application/json: schema: type: array - items: *243 + items: *255 examples: - default: *258 + default: *270 '422': *16 x-github: githubCloudOnly: false @@ -54367,9 +54732,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 requestBody: required: false content: @@ -54405,9 +54770,9 @@ paths: application/json: schema: type: array - items: *243 + items: *255 examples: - default: *258 + default: *270 '422': *16 x-github: githubCloudOnly: false @@ -54428,9 +54793,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 requestBody: content: application/json: @@ -54465,9 +54830,9 @@ paths: application/json: schema: type: array - items: *243 + items: *255 examples: - default: *258 + default: *270 '422': *16 x-github: githubCloudOnly: false @@ -54489,9 +54854,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: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 responses: '200': description: Response @@ -54501,7 +54866,7 @@ paths: type: array items: *19 examples: - default: *246 + default: *258 '404': *7 x-github: githubCloudOnly: false @@ -54525,9 +54890,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 requestBody: required: true content: @@ -54560,7 +54925,7 @@ paths: type: array items: *19 examples: - default: *246 + default: *258 '422': *16 x-github: githubCloudOnly: false @@ -54585,9 +54950,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 requestBody: required: true content: @@ -54620,7 +54985,7 @@ paths: type: array items: *19 examples: - default: *246 + default: *258 '422': *16 x-github: githubCloudOnly: false @@ -54645,9 +55010,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 requestBody: required: true content: @@ -54680,7 +55045,7 @@ paths: type: array items: *19 examples: - default: *246 + default: *258 '422': *16 x-github: githubCloudOnly: false @@ -54707,9 +55072,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 requestBody: required: true content: @@ -54731,7 +55096,7 @@ paths: description: Response content: application/json: - schema: *394 + schema: *401 examples: default: value: @@ -54847,8 +55212,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -55127,7 +55492,7 @@ paths: description: Response content: application/json: - schema: &396 + schema: &403 title: CheckRun description: A check performed on the code of a given code change type: object @@ -55238,16 +55603,16 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 pull_requests: description: Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check. type: array - items: *395 - deployment: &708 + items: *402 + deployment: &715 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -55314,8 +55679,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 required: - id - node_id @@ -55527,9 +55892,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run parameters: - - *325 - - *326 - - &397 + - *332 + - *333 + - &404 name: check_run_id description: The unique identifier of the check run. in: path @@ -55541,9 +55906,9 @@ paths: description: Response content: application/json: - schema: *396 + schema: *403 examples: - default: &398 + default: &405 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -55643,9 +56008,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run parameters: - - *325 - - *326 - - *397 + - *332 + - *333 + - *404 requestBody: required: true content: @@ -55885,9 +56250,9 @@ paths: description: Response content: application/json: - schema: *396 + schema: *403 examples: - default: *398 + default: *405 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55907,9 +56272,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations parameters: - - *325 - - *326 - - *397 + - *332 + - *333 + - *404 - *18 - *20 responses: @@ -56006,15 +56371,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run parameters: - - *325 - - *326 - - *397 + - *332 + - *333 + - *404 responses: '201': description: Response content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -56052,8 +56417,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -56075,7 +56440,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &401 + schema: &408 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -56139,7 +56504,7 @@ paths: nullable: true pull_requests: type: array - items: *395 + items: *402 nullable: true app: title: GitHub app @@ -56150,9 +56515,9 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 - repository: *163 + properties: *119 + required: *120 + repository: *175 created_at: type: string format: date-time @@ -56161,12 +56526,12 @@ paths: type: string format: date-time nullable: true - head_commit: &734 + head_commit: &741 title: Simple Commit description: A commit. type: object - properties: *399 - required: *400 + properties: *406 + required: *407 latest_check_runs_count: type: integer check_runs_url: @@ -56194,7 +56559,7 @@ paths: - check_runs_url - pull_requests examples: - default: &402 + default: &409 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -56485,9 +56850,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *401 + schema: *408 examples: - default: *402 + default: *409 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56506,8 +56871,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -56568,7 +56933,7 @@ paths: required: - app_id - setting - repository: *163 + repository: *175 examples: default: value: @@ -56816,9 +57181,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite parameters: - - *325 - - *326 - - &403 + - *332 + - *333 + - &410 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -56830,9 +57195,9 @@ paths: description: Response content: application/json: - schema: *401 + schema: *408 examples: - default: *402 + default: *409 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56855,17 +57220,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: - - *325 - - *326 - - *403 - - &449 + - *332 + - *333 + - *410 + - &456 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &450 + - &457 name: status description: Returns check runs with the specified `status`. in: query @@ -56904,9 +57269,9 @@ paths: type: integer check_runs: type: array - items: *396 + items: *403 examples: - default: &451 + default: &458 value: total_count: 1 check_runs: @@ -57008,15 +57373,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite parameters: - - *325 - - *326 - - *403 + - *332 + - *333 + - *410 responses: '201': description: Response content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -57043,21 +57408,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: - - *325 - - *326 - - *186 - - *187 + - *332 + - *333 + - *198 + - *199 - *20 - *18 - - &415 + - &422 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: *404 - - &416 + schema: *411 + - &423 name: pr description: The number of the pull request for the results you want to list. in: query @@ -57082,13 +57447,13 @@ paths: be returned. in: query required: false - schema: *188 + schema: *200 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *405 + schema: *412 responses: '200': description: Response @@ -57104,7 +57469,7 @@ paths: updated_at: *92 url: *89 html_url: *90 - instances_url: *406 + instances_url: *413 state: *81 fixed_at: *94 dismissed_by: @@ -57115,11 +57480,11 @@ paths: required: *5 nullable: true dismissed_at: *93 - dismissed_reason: *407 - dismissed_comment: *408 - rule: *409 - tool: *410 - most_recent_instance: *411 + dismissed_reason: *414 + dismissed_comment: *415 + rule: *416 + tool: *417 + most_recent_instance: *418 required: - number - created_at @@ -57235,14 +57600,14 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &412 + '403': &419 description: Response if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *7 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57262,9 +57627,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: - - *325 - - *326 - - &413 + - *332 + - *333 + - &420 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -57278,7 +57643,7 @@ paths: description: Response content: application/json: - schema: &414 + schema: &421 type: object properties: number: *85 @@ -57286,7 +57651,7 @@ paths: updated_at: *92 url: *89 html_url: *90 - instances_url: *406 + instances_url: *413 state: *81 fixed_at: *94 dismissed_by: @@ -57297,8 +57662,8 @@ paths: required: *5 nullable: true dismissed_at: *93 - dismissed_reason: *407 - dismissed_comment: *408 + dismissed_reason: *414 + dismissed_comment: *415 rule: type: object properties: @@ -57352,8 +57717,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *410 - most_recent_instance: *411 + tool: *417 + most_recent_instance: *418 required: - number - created_at @@ -57442,9 +57807,9 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *412 + '403': *419 '404': *7 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57462,9 +57827,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: - - *325 - - *326 - - *413 + - *332 + - *333 + - *420 requestBody: required: true content: @@ -57479,8 +57844,8 @@ paths: enum: - open - dismissed - dismissed_reason: *407 - dismissed_comment: *408 + dismissed_reason: *414 + dismissed_comment: *415 required: - state examples: @@ -57495,7 +57860,7 @@ paths: description: Response content: application/json: - schema: *414 + schema: *421 examples: default: value: @@ -57570,14 +57935,14 @@ paths: classifications: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances - '403': &421 + '403': &428 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *7 - '503': *100 + '503': *112 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -57597,13 +57962,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: - - *325 - - *326 - - *413 + - *332 + - *333 + - *420 - *20 - *18 - - *415 - - *416 + - *422 + - *423 responses: '200': description: Response @@ -57611,7 +57976,7 @@ paths: application/json: schema: type: array - items: *411 + items: *418 examples: default: value: @@ -57650,9 +58015,9 @@ paths: end_column: 50 classifications: - source - '403': *412 + '403': *419 '404': *7 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57684,25 +58049,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: - - *325 - - *326 - - *186 - - *187 + - *332 + - *333 + - *198 + - *199 - *20 - *18 - - *416 + - *423 - 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: *404 + schema: *411 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &419 + schema: &426 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -57723,23 +58088,23 @@ paths: application/json: schema: type: array - items: &420 + items: &427 type: object properties: - ref: *404 - commit_sha: &429 + ref: *411 + commit_sha: &436 description: The SHA of the commit to which the analysis you are uploading relates. type: string minLength: 40 maxLength: 40 pattern: "^[0-9a-fA-F]+$" - analysis_key: *417 + analysis_key: *424 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *418 + category: *425 error: type: string example: error reading field xyz @@ -57763,8 +58128,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *419 - tool: *410 + sarif_id: *426 + tool: *417 deletable: type: boolean warning: @@ -57825,9 +58190,9 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *412 + '403': *419 '404': *7 - '503': *100 + '503': *112 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -57861,8 +58226,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: - - *325 - - *326 + - *332 + - *333 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -57875,7 +58240,7 @@ paths: description: Response content: application/json: - schema: *420 + schema: *427 examples: response: summary: application/json response @@ -57929,9 +58294,9 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *412 + '403': *419 '404': *7 - '503': *100 + '503': *112 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -58011,8 +58376,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: - - *325 - - *326 + - *332 + - *333 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -58065,9 +58430,9 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *15 - '403': *421 + '403': *428 '404': *7 - '503': *100 + '503': *112 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -58087,8 +58452,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -58096,7 +58461,7 @@ paths: application/json: schema: type: array - items: &422 + items: &429 title: CodeQL Database description: A CodeQL database. type: object @@ -58207,9 +58572,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': *412 + '403': *419 '404': *7 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58236,8 +58601,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: - - *325 - - *326 + - *332 + - *333 - name: language in: path description: The language of the CodeQL database. @@ -58249,7 +58614,7 @@ paths: description: Response content: application/json: - schema: *422 + schema: *429 examples: default: value: @@ -58281,11 +58646,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': &458 + '302': &465 description: Found - '403': *412 + '403': *419 '404': *7 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58305,8 +58670,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *325 - - *326 + - *332 + - *333 - name: language in: path description: The language of the CodeQL database. @@ -58316,9 +58681,9 @@ paths: responses: '204': description: Response - '403': *421 + '403': *428 '404': *7 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58344,8 +58709,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: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -58354,7 +58719,7 @@ paths: type: object additionalProperties: false properties: - language: &423 + language: &430 type: string description: The language targeted by the CodeQL query enum: @@ -58432,7 +58797,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &427 + schema: &434 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -58442,7 +58807,7 @@ paths: description: The ID of the variant analysis. controller_repo: *95 actor: *19 - query_language: *423 + query_language: *430 query_pack_url: type: string description: The download url for the query pack. @@ -58489,7 +58854,7 @@ paths: items: type: object properties: - repository: &424 + repository: &431 title: Repository Identifier description: Repository Identifier type: object @@ -58525,7 +58890,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &428 + analysis_status: &435 type: string description: The new status of the CodeQL variant analysis repository task. @@ -58557,7 +58922,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &425 + access_mismatch_repos: &432 type: object properties: repository_count: @@ -58571,7 +58936,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: *424 + items: *431 required: - repository_count - repositories @@ -58593,8 +58958,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *425 - over_limit_repos: *425 + no_codeql_db_repos: *432 + over_limit_repos: *432 required: - access_mismatch_repos - not_found_repos @@ -58610,7 +58975,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &426 + value: &433 summary: Default response value: id: 1 @@ -58762,17 +59127,17 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *426 + value: *433 repository_lists: summary: Response for a successful variant analysis submission - value: *426 + value: *433 '404': *7 '422': description: Unable to process variant analysis submission content: application/json: schema: *3 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58793,8 +59158,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: - - *325 - - *326 + - *332 + - *333 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -58806,11 +59171,11 @@ paths: description: Response content: application/json: - schema: *427 + schema: *434 examples: - default: *426 + default: *433 '404': *7 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58831,7 +59196,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: - - *325 + - *332 - name: repo in: path description: The name of the controller repository. @@ -58866,7 +59231,7 @@ paths: type: object properties: repository: *95 - analysis_status: *428 + analysis_status: *435 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -58970,7 +59335,7 @@ paths: source_location_prefix: "/" artifact_url: https://example.com '404': *7 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58991,8 +59356,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -59053,9 +59418,9 @@ paths: query_suite: default updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *412 + '403': *419 '404': *7 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59074,8 +59439,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: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -59131,7 +59496,7 @@ paths: description: Response content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -59156,7 +59521,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *421 + '403': *428 '404': *7 '409': description: Response if there is already a validation run in progress with @@ -59164,7 +59529,7 @@ paths: content: application/json: schema: *3 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59221,8 +59586,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: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -59230,7 +59595,7 @@ paths: schema: type: object properties: - commit_sha: *429 + commit_sha: *436 ref: type: string description: |- @@ -59288,7 +59653,7 @@ paths: schema: type: object properties: - id: *419 + id: *426 url: type: string description: The REST API URL for checking the status of the upload. @@ -59302,11 +59667,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': *421 + '403': *428 '404': *7 '413': description: Payload Too Large if the sarif field is too large - '503': *100 + '503': *112 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -59325,8 +59690,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: - - *325 - - *326 + - *332 + - *333 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -59372,10 +59737,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': *412 + '403': *419 '404': description: Not Found if the sarif id does not match any upload - '503': *100 + '503': *112 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -59397,8 +59762,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -59422,7 +59787,7 @@ paths: - failed - updating - removed_by_enterprise - configuration: *191 + configuration: *203 examples: default: value: @@ -59451,7 +59816,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': *192 + '204': *204 '304': *37 '403': *29 '404': *7 @@ -59476,8 +59841,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors parameters: - - *325 - - *326 + - *332 + - *333 - 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 @@ -59597,8 +59962,8 @@ paths: parameters: - *18 - *20 - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -59614,7 +59979,7 @@ paths: type: integer codespaces: type: array - items: *247 + items: *259 examples: default: value: @@ -59912,8 +60277,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -59976,22 +60341,22 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *247 + schema: *259 examples: - default: *430 + default: *437 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *247 + schema: *259 examples: - default: *430 + default: *437 '400': *15 '401': *25 '403': *29 '404': *7 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -60015,8 +60380,8 @@ paths: parameters: - *18 - *20 - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -60080,8 +60445,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: - - *325 - - *326 + - *332 + - *333 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -60116,14 +60481,14 @@ paths: type: integer machines: type: array - items: &664 + items: &671 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *431 - required: *432 + properties: *438 + required: *439 examples: - default: &665 + default: &672 value: total_count: 2 machines: @@ -60163,8 +60528,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *325 - - *326 + - *332 + - *333 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -60248,8 +60613,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: - - *325 - - *326 + - *332 + - *333 - 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 @@ -60294,7 +60659,7 @@ paths: '403': *29 '404': *7 '422': *16 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60315,8 +60680,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -60334,7 +60699,7 @@ paths: type: integer secrets: type: array - items: &436 + items: &443 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -60354,7 +60719,7 @@ paths: - created_at - updated_at examples: - default: *433 + default: *440 headers: Link: *39 x-github: @@ -60377,16 +60742,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *434 + schema: *441 examples: - default: *435 + default: *442 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -60406,17 +60771,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *325 - - *326 - - *173 + - *332 + - *333 + - *185 responses: '200': description: Response content: application/json: - schema: *436 + schema: *443 examples: - default: *437 + default: *444 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60436,9 +60801,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: - - *325 - - *326 - - *173 + - *332 + - *333 + - *185 requestBody: required: true content: @@ -60466,7 +60831,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -60490,9 +60855,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *325 - - *326 - - *173 + - *332 + - *333 + - *185 responses: '204': description: Response @@ -60520,8 +60885,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators parameters: - - *325 - - *326 + - *332 + - *333 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -60563,7 +60928,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &438 + properties: &445 login: type: string example: octocat @@ -60656,7 +61021,7 @@ paths: user_view_type: type: string example: public - required: &439 + required: &446 - avatar_url - events_url - followers_url @@ -60730,9 +61095,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: - - *325 - - *326 - - *185 + - *332 + - *333 + - *197 responses: '204': description: Response if user is a collaborator @@ -60774,9 +61139,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *325 - - *326 - - *185 + - *332 + - *333 + - *197 requestBody: required: false content: @@ -60802,7 +61167,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &506 + schema: &513 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -60813,7 +61178,7 @@ paths: example: 42 type: integer format: int64 - repository: *163 + repository: *175 invitee: title: Simple User description: A GitHub user. @@ -61024,9 +61389,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *325 - - *326 - - *185 + - *332 + - *333 + - *197 responses: '204': description: No Content when collaborator was removed from the repository. @@ -61055,9 +61420,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *325 - - *326 - - *185 + - *332 + - *333 + - *197 responses: '200': description: if user has admin permissions @@ -61077,8 +61442,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *438 - required: *439 + properties: *445 + required: *446 nullable: true required: - permission @@ -61133,8 +61498,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -61144,7 +61509,7 @@ paths: application/json: schema: type: array - items: &440 + items: &447 title: Commit Comment description: Commit Comment type: object @@ -61185,8 +61550,8 @@ paths: updated_at: type: string format: date-time - author_association: *109 - reactions: *110 + author_association: *121 + reactions: *122 required: - url - html_url @@ -61202,7 +61567,7 @@ paths: - created_at - updated_at examples: - default: &443 + default: &450 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -61261,17 +61626,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment parameters: - - *325 - - *326 - - *121 + - *332 + - *333 + - *133 responses: '200': description: Response content: application/json: - schema: *440 + schema: *447 examples: - default: &444 + default: &451 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -61328,9 +61693,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment parameters: - - *325 - - *326 - - *121 + - *332 + - *333 + - *133 requestBody: required: true content: @@ -61352,7 +61717,7 @@ paths: description: Response content: application/json: - schema: *440 + schema: *447 examples: default: value: @@ -61403,9 +61768,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment parameters: - - *325 - - *326 - - *121 + - *332 + - *333 + - *133 responses: '204': description: Response @@ -61426,9 +61791,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *325 - - *326 - - *121 + - *332 + - *333 + - *133 - 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. @@ -61454,9 +61819,9 @@ paths: application/json: schema: type: array - items: *314 + items: *321 examples: - default: *316 + default: *323 headers: Link: *39 '404': *7 @@ -61477,9 +61842,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *325 - - *326 - - *121 + - *332 + - *333 + - *133 requestBody: required: true content: @@ -61511,16 +61876,16 @@ paths: description: Reaction exists content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 '201': description: Reaction created content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 '422': *16 x-github: githubCloudOnly: false @@ -61542,10 +61907,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *325 - - *326 - - *121 - - *317 + - *332 + - *333 + - *133 + - *324 responses: '204': description: Response @@ -61594,8 +61959,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits parameters: - - *325 - - *326 + - *332 + - *333 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -61651,9 +62016,9 @@ paths: application/json: schema: type: array - items: *441 + items: *448 examples: - default: &557 + default: &564 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -61727,7 +62092,7 @@ paths: '500': *84 '400': *15 '404': *7 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61747,9 +62112,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit parameters: - - *325 - - *326 - - &442 + - *332 + - *333 + - &449 name: commit_sha description: The SHA of the commit. in: path @@ -61796,7 +62161,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc protected: false '422': *16 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61821,9 +62186,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments parameters: - - *325 - - *326 - - *442 + - *332 + - *333 + - *449 - *18 - *20 responses: @@ -61833,9 +62198,9 @@ paths: application/json: schema: type: array - items: *440 + items: *447 examples: - default: *443 + default: *450 headers: Link: *39 x-github: @@ -61863,9 +62228,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment parameters: - - *325 - - *326 - - *442 + - *332 + - *333 + - *449 requestBody: required: true content: @@ -61900,9 +62265,9 @@ paths: description: Response content: application/json: - schema: *440 + schema: *447 examples: - default: *444 + default: *451 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -61930,9 +62295,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: - - *325 - - *326 - - *442 + - *332 + - *333 + - *449 - *18 - *20 responses: @@ -61942,7 +62307,7 @@ paths: application/json: schema: type: array - items: &548 + items: &555 title: Pull Request Simple description: Pull Request Simple type: object @@ -62048,8 +62413,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *445 - required: *446 + properties: *452 + required: *453 nullable: true active_lock_reason: type: string @@ -62094,7 +62459,7 @@ paths: nullable: true requested_teams: type: array - items: *243 + items: *255 nullable: true head: type: object @@ -62145,7 +62510,7 @@ paths: _links: type: object properties: - comments: &447 + comments: &454 title: Link description: Hypermedia Link type: object @@ -62154,13 +62519,13 @@ paths: type: string required: - href - commits: *447 - statuses: *447 - html: *447 - issue: *447 - review_comments: *447 - review_comment: *447 - self: *447 + commits: *454 + statuses: *454 + html: *454 + issue: *454 + review_comments: *454 + review_comment: *454 + self: *454 required: - comments - commits @@ -62170,8 +62535,8 @@ paths: - review_comments - review_comment - self - author_association: *109 - auto_merge: &550 + author_association: *121 + auto_merge: &557 title: Auto merge description: The status of auto merging a pull request. type: object @@ -62234,7 +62599,7 @@ paths: - author_association - auto_merge examples: - default: &549 + default: &556 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -62714,7 +63079,7 @@ paths: draft: false headers: Link: *39 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62771,11 +63136,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit parameters: - - *325 - - *326 + - *332 + - *333 - *20 - *18 - - &448 + - &455 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)" @@ -62790,9 +63155,9 @@ paths: description: Response content: application/json: - schema: *441 + schema: *448 examples: - default: &535 + default: &542 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -62879,8 +63244,8 @@ paths: '422': *16 '404': *7 '500': *84 - '503': *100 - '409': *150 + '503': *112 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62905,11 +63270,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: - - *325 - - *326 - - *448 - - *449 - - *450 + - *332 + - *333 + - *455 + - *456 + - *457 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -62943,9 +63308,9 @@ paths: type: integer check_runs: type: array - items: *396 + items: *403 examples: - default: *451 + default: *458 headers: Link: *39 x-github: @@ -62970,9 +63335,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: - - *325 - - *326 - - *448 + - *332 + - *333 + - *455 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -62980,7 +63345,7 @@ paths: schema: type: integer example: 1 - - *449 + - *456 - *18 - *20 responses: @@ -62998,7 +63363,7 @@ paths: type: integer check_suites: type: array - items: *401 + items: *408 examples: default: value: @@ -63198,9 +63563,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: - - *325 - - *326 - - *448 + - *332 + - *333 + - *455 - *18 - *20 responses: @@ -63267,7 +63632,7 @@ paths: type: string total_count: type: integer - repository: *163 + repository: *175 commit_url: type: string format: uri @@ -63398,9 +63763,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *325 - - *326 - - *448 + - *332 + - *333 + - *455 - *18 - *20 responses: @@ -63410,7 +63775,7 @@ paths: application/json: schema: type: array - items: &612 + items: &619 title: Status description: The status of a commit. type: object @@ -63491,7 +63856,7 @@ paths: site_admin: false headers: Link: *39 - '301': *339 + '301': *346 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63519,8 +63884,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -63549,20 +63914,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *452 - required: *453 + properties: *459 + required: *460 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &454 + properties: &461 url: type: string format: uri html_url: type: string format: uri - required: &455 + required: &462 - url - html_url nullable: true @@ -63570,32 +63935,32 @@ paths: title: License Simple description: License Simple type: object - properties: *123 - required: *124 + properties: *135 + required: *136 nullable: true contributing: title: Community Health File type: object - properties: *454 - required: *455 + properties: *461 + required: *462 nullable: true readme: title: Community Health File type: object - properties: *454 - required: *455 + properties: *461 + required: *462 nullable: true issue_template: title: Community Health File type: object - properties: *454 - required: *455 + properties: *461 + required: *462 nullable: true pull_request_template: title: Community Health File type: object - properties: *454 - required: *455 + properties: *461 + required: *462 nullable: true required: - code_of_conduct @@ -63722,8 +64087,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits parameters: - - *325 - - *326 + - *332 + - *333 - *20 - *18 - name: basehead @@ -63766,8 +64131,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *441 - merge_base_commit: *441 + base_commit: *448 + merge_base_commit: *448 status: type: string enum: @@ -63787,10 +64152,10 @@ paths: example: 6 commits: type: array - items: *441 + items: *448 files: type: array - items: *456 + items: *463 required: - url - html_url @@ -64034,7 +64399,7 @@ paths: module Test" '404': *7 '500': *84 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64076,8 +64441,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content parameters: - - *325 - - *326 + - *332 + - *333 - name: path description: path parameter in: path @@ -64218,7 +64583,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &457 + response-if-content-is-a-file: &464 summary: Response if content is a file value: type: file @@ -64350,7 +64715,7 @@ paths: - size - type - url - - &562 + - &569 title: Content File description: Content File type: object @@ -64551,7 +64916,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *457 + response-if-content-is-a-file: *464 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -64620,7 +64985,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *7 '403': *29 - '302': *458 + '302': *465 '304': *37 x-github: githubCloudOnly: false @@ -64643,8 +65008,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents parameters: - - *325 - - *326 + - *332 + - *333 - name: path description: path parameter in: path @@ -64737,7 +65102,7 @@ paths: description: Response content: application/json: - schema: &459 + schema: &466 title: File Commit description: File Commit type: object @@ -64889,7 +65254,7 @@ paths: description: Response content: application/json: - schema: *459 + schema: *466 examples: example-for-creating-a-file: value: @@ -64943,7 +65308,7 @@ paths: schema: oneOf: - *3 - - &488 + - &495 description: Repository rule violation was detected type: object properties: @@ -64964,7 +65329,7 @@ paths: items: type: object properties: - placeholder_id: &604 + placeholder_id: &611 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -64996,8 +65361,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file parameters: - - *325 - - *326 + - *332 + - *333 - name: path description: path parameter in: path @@ -65058,7 +65423,7 @@ paths: description: Response content: application/json: - schema: *459 + schema: *466 examples: default: value: @@ -65092,8 +65457,8 @@ paths: verified_at: '422': *16 '404': *7 - '409': *150 - '503': *100 + '409': *162 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65113,8 +65478,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors parameters: - - *325 - - *326 + - *332 + - *333 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -65237,20 +65602,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *325 - - *326 - - *205 - - *206 - - *207 - - *208 + - *332 + - *333 + - *217 + - *218 + - *219 + - *220 - 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 - - *209 - - *210 + - *221 + - *222 - *78 - name: page description: "**Closing down notice**. Page number of the results to fetch. @@ -65270,8 +65635,8 @@ paths: default: 30 - *76 - *77 - - *211 - - *212 + - *223 + - *224 responses: '200': description: Response @@ -65279,7 +65644,7 @@ paths: application/json: schema: type: array - items: &462 + items: &469 type: object description: A Dependabot alert. properties: @@ -65312,7 +65677,7 @@ paths: enum: - development - runtime - security_advisory: *460 + security_advisory: *467 security_vulnerability: *88 url: *89 html_url: *90 @@ -65343,7 +65708,7 @@ paths: nullable: true maxLength: 280 fixed_at: *94 - auto_dismissed_at: *461 + auto_dismissed_at: *468 required: - number - state @@ -65570,9 +65935,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *325 - - *326 - - &463 + - *332 + - *333 + - &470 name: alert_number in: path description: |- @@ -65587,7 +65952,7 @@ paths: description: Response content: application/json: - schema: *462 + schema: *469 examples: default: value: @@ -65697,9 +66062,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *325 - - *326 - - *463 + - *332 + - *333 + - *470 requestBody: required: true content: @@ -65744,7 +66109,7 @@ paths: description: Response content: application/json: - schema: *462 + schema: *469 examples: default: value: @@ -65850,7 +66215,7 @@ paths: '400': *15 '403': *29 '404': *7 - '409': *150 + '409': *162 '422': *8 x-github: githubCloudOnly: false @@ -65873,8 +66238,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -65892,7 +66257,7 @@ paths: type: integer secrets: type: array - items: &466 + items: &473 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -65945,16 +66310,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *464 + schema: *471 examples: - default: *465 + default: *472 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65974,15 +66339,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret parameters: - - *325 - - *326 - - *173 + - *332 + - *333 + - *185 responses: '200': description: Response content: application/json: - schema: *466 + schema: *473 examples: default: value: @@ -66008,9 +66373,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *325 - - *326 - - *173 + - *332 + - *333 + - *185 requestBody: required: true content: @@ -66038,7 +66403,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -66062,9 +66427,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret parameters: - - *325 - - *326 - - *173 + - *332 + - *333 + - *185 responses: '204': description: Response @@ -66086,8 +66451,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: - - *325 - - *326 + - *332 + - *333 - 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 @@ -66247,8 +66612,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -66487,8 +66852,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: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -66563,7 +66928,7 @@ paths: - version - url additionalProperties: false - metadata: &467 + metadata: &474 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -66596,7 +66961,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *467 + metadata: *474 resolved: type: object description: A collection of resolved package dependencies. @@ -66609,7 +66974,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *467 + metadata: *474 relationship: type: string description: A notation of whether a dependency is requested @@ -66738,8 +67103,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments parameters: - - *325 - - *326 + - *332 + - *333 - name: sha description: The SHA recorded at creation time. in: query @@ -66779,9 +67144,9 @@ paths: application/json: schema: type: array - items: *468 + items: *475 examples: - default: *469 + default: *476 headers: Link: *39 x-github: @@ -66847,8 +67212,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -66929,7 +67294,7 @@ paths: description: Response content: application/json: - schema: *468 + schema: *475 examples: simple-example: summary: Simple example @@ -67002,9 +67367,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment parameters: - - *325 - - *326 - - &470 + - *332 + - *333 + - &477 name: deployment_id description: deployment_id parameter in: path @@ -67016,7 +67381,7 @@ paths: description: Response content: application/json: - schema: *468 + schema: *475 examples: default: value: @@ -67081,9 +67446,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment parameters: - - *325 - - *326 - - *470 + - *332 + - *333 + - *477 responses: '204': description: Response @@ -67105,9 +67470,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses parameters: - - *325 - - *326 - - *470 + - *332 + - *333 + - *477 - *18 - *20 responses: @@ -67117,7 +67482,7 @@ paths: application/json: schema: type: array - items: &471 + items: &478 title: Deployment Status description: The status of a deployment. type: object @@ -67208,8 +67573,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 required: - id - node_id @@ -67278,9 +67643,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status parameters: - - *325 - - *326 - - *470 + - *332 + - *333 + - *477 requestBody: required: true content: @@ -67355,9 +67720,9 @@ paths: description: Response content: application/json: - schema: *471 + schema: *478 examples: - default: &472 + default: &479 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -67413,9 +67778,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status parameters: - - *325 - - *326 - - *470 + - *332 + - *333 + - *477 - name: status_id in: path required: true @@ -67426,9 +67791,9 @@ paths: description: Response content: application/json: - schema: *471 + schema: *478 examples: - default: *472 + default: *479 '404': *7 x-github: githubCloudOnly: false @@ -67453,8 +67818,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -67511,8 +67876,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -67529,7 +67894,7 @@ paths: type: integer environments: type: array - items: &474 + items: &481 title: Environment description: Details of a deployment environment type: object @@ -67581,7 +67946,7 @@ paths: type: type: string example: wait_timer - wait_timer: &476 + wait_timer: &483 type: integer example: 30 description: The amount of time to delay a job after @@ -67618,11 +67983,11 @@ paths: items: type: object properties: - type: *473 + type: *480 reviewer: anyOf: - *19 - - *243 + - *255 required: - id - node_id @@ -67642,7 +68007,7 @@ paths: - id - node_id - type - deployment_branch_policy: &477 + deployment_branch_policy: &484 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -67758,9 +68123,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment parameters: - - *325 - - *326 - - &475 + - *332 + - *333 + - &482 name: environment_name in: path required: true @@ -67773,9 +68138,9 @@ paths: description: Response content: application/json: - schema: *474 + schema: *481 examples: - default: &478 + default: &485 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -67859,9 +68224,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment parameters: - - *325 - - *326 - - *475 + - *332 + - *333 + - *482 requestBody: required: false content: @@ -67870,7 +68235,7 @@ paths: type: object nullable: true properties: - wait_timer: *476 + wait_timer: *483 prevent_self_review: type: boolean example: false @@ -67887,13 +68252,13 @@ paths: items: type: object properties: - type: *473 + type: *480 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *477 + deployment_branch_policy: *484 additionalProperties: false examples: default: @@ -67913,9 +68278,9 @@ paths: description: Response content: application/json: - schema: *474 + schema: *481 examples: - default: *478 + default: *485 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -67939,9 +68304,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment parameters: - - *325 - - *326 - - *475 + - *332 + - *333 + - *482 responses: '204': description: Default response @@ -67966,9 +68331,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *325 - - *326 - - *475 + - *332 + - *333 + - *482 - *18 - *20 responses: @@ -67986,7 +68351,7 @@ paths: example: 2 branch_policies: type: array - items: &479 + items: &486 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -68043,9 +68408,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *325 - - *326 - - *475 + - *332 + - *333 + - *482 requestBody: required: true content: @@ -68091,9 +68456,9 @@ paths: description: Response content: application/json: - schema: *479 + schema: *486 examples: - example-wildcard: &480 + example-wildcard: &487 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -68135,10 +68500,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *325 - - *326 - - *475 - - &481 + - *332 + - *333 + - *482 + - &488 name: branch_policy_id in: path required: true @@ -68150,9 +68515,9 @@ paths: description: Response content: application/json: - schema: *479 + schema: *486 examples: - default: *480 + default: *487 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68171,10 +68536,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *325 - - *326 - - *475 - - *481 + - *332 + - *333 + - *482 + - *488 requestBody: required: true content: @@ -68202,9 +68567,9 @@ paths: description: Response content: application/json: - schema: *479 + schema: *486 examples: - default: *480 + default: *487 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68223,10 +68588,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *325 - - *326 - - *475 - - *481 + - *332 + - *333 + - *482 + - *488 responses: '204': description: Response @@ -68251,9 +68616,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: - - *475 - - *326 - - *325 + - *482 + - *333 + - *332 responses: '200': description: List of deployment protection rules @@ -68269,7 +68634,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &482 + items: &489 title: Deployment protection rule description: Deployment protection rule type: object @@ -68288,7 +68653,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &483 + app: &490 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -68387,9 +68752,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: - - *475 - - *326 - - *325 + - *482 + - *333 + - *332 requestBody: content: application/json: @@ -68410,9 +68775,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *482 + schema: *489 examples: - default: &484 + default: &491 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -68447,9 +68812,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: - - *475 - - *326 - - *325 + - *482 + - *333 + - *332 - *20 - *18 responses: @@ -68468,7 +68833,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *483 + items: *490 examples: default: value: @@ -68503,10 +68868,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: - - *325 - - *326 - - *475 - - &485 + - *332 + - *333 + - *482 + - &492 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -68518,9 +68883,9 @@ paths: description: Response content: application/json: - schema: *482 + schema: *489 examples: - default: *484 + default: *491 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68541,10 +68906,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: - - *475 - - *326 - - *325 - - *485 + - *482 + - *333 + - *332 + - *492 responses: '204': description: Response @@ -68570,9 +68935,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets parameters: - - *325 - - *326 - - *475 + - *332 + - *333 + - *482 - *18 - *20 responses: @@ -68590,9 +68955,9 @@ paths: type: integer secrets: type: array - items: *362 + items: *369 examples: - default: *363 + default: *370 headers: Link: *39 x-github: @@ -68617,17 +68982,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key parameters: - - *325 - - *326 - - *475 + - *332 + - *333 + - *482 responses: '200': description: Response content: application/json: - schema: *364 + schema: *371 examples: - default: *365 + default: *372 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68649,18 +69014,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret parameters: - - *325 - - *326 - - *475 - - *173 + - *332 + - *333 + - *482 + - *185 responses: '200': description: Response content: application/json: - schema: *362 + schema: *369 examples: - default: *486 + default: *493 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68682,10 +69047,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *325 - - *326 - - *475 - - *173 + - *332 + - *333 + - *482 + - *185 requestBody: required: true content: @@ -68716,7 +69081,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -68742,10 +69107,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret parameters: - - *325 - - *326 - - *475 - - *173 + - *332 + - *333 + - *482 + - *185 responses: '204': description: Default response @@ -68770,10 +69135,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables parameters: - - *325 - - *326 - - *475 - - *349 + - *332 + - *333 + - *482 + - *356 - *20 responses: '200': @@ -68790,9 +69155,9 @@ paths: type: integer variables: type: array - items: *366 + items: *373 examples: - default: *367 + default: *374 headers: Link: *39 x-github: @@ -68815,9 +69180,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable parameters: - - *325 - - *326 - - *475 + - *332 + - *333 + - *482 requestBody: required: true content: @@ -68844,7 +69209,7 @@ paths: description: Response content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -68869,18 +69234,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable parameters: - - *325 - - *326 - - *475 - - *176 + - *332 + - *333 + - *482 + - *188 responses: '200': description: Response content: application/json: - schema: *366 + schema: *373 examples: - default: *487 + default: *494 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68901,10 +69266,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable parameters: - - *325 - - *326 - - *176 - - *475 + - *332 + - *333 + - *188 + - *482 requestBody: required: true content: @@ -68946,10 +69311,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable parameters: - - *325 - - *326 - - *176 - - *475 + - *332 + - *333 + - *188 + - *482 responses: '204': description: Response @@ -68971,8 +69336,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -68982,7 +69347,7 @@ paths: application/json: schema: type: array - items: *134 + items: *146 examples: 200-response: value: @@ -69049,8 +69414,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks parameters: - - *325 - - *326 + - *332 + - *333 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -69072,7 +69437,7 @@ paths: application/json: schema: type: array - items: *163 + items: *175 examples: default: value: @@ -69209,8 +69574,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: false content: @@ -69242,9 +69607,9 @@ paths: description: Response content: application/json: - schema: *338 + schema: *345 examples: - default: *340 + default: *347 '400': *15 '422': *16 '403': *29 @@ -69265,8 +69630,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -69317,7 +69682,7 @@ paths: schema: type: string '404': *7 - '409': *150 + '409': *162 '403': *29 '422': description: Validation failed @@ -69325,8 +69690,8 @@ paths: application/json: schema: oneOf: - - *148 - - *488 + - *160 + - *495 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69351,8 +69716,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob parameters: - - *325 - - *326 + - *332 + - *333 - name: file_sha in: path required: true @@ -69403,7 +69768,7 @@ paths: '404': *7 '422': *16 '403': *29 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69451,8 +69816,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -69561,7 +69926,7 @@ paths: description: Response content: application/json: - schema: &489 + schema: &496 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -69724,7 +70089,7 @@ paths: type: string '422': *16 '404': *7 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69774,15 +70139,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object parameters: - - *325 - - *326 - - *442 + - *332 + - *333 + - *449 responses: '200': description: Response content: application/json: - schema: *489 + schema: *496 examples: default: value: @@ -69813,7 +70178,7 @@ paths: payload: verified_at: '404': *7 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69838,9 +70203,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references parameters: - - *325 - - *326 - - &490 + - *332 + - *333 + - &497 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. @@ -69857,7 +70222,7 @@ paths: application/json: schema: type: array - items: &491 + items: &498 title: Git Reference description: Git references within a repository type: object @@ -69911,7 +70276,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: Link: *39 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69932,17 +70297,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference parameters: - - *325 - - *326 - - *490 + - *332 + - *333 + - *497 responses: '200': description: Response content: application/json: - schema: *491 + schema: *498 examples: - default: &492 + default: &499 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -69952,7 +70317,7 @@ paths: sha: aa218f56b14c9653891f9e74264a383fa43fefbd url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd '404': *7 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69971,8 +70336,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -70001,16 +70366,16 @@ paths: description: Response content: application/json: - schema: *491 + schema: *498 examples: - default: *492 + default: *499 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA schema: type: string '422': *16 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70029,9 +70394,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference parameters: - - *325 - - *326 - - *490 + - *332 + - *333 + - *497 requestBody: required: true content: @@ -70060,11 +70425,11 @@ paths: description: Response content: application/json: - schema: *491 + schema: *498 examples: - default: *492 + default: *499 '422': *16 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70080,14 +70445,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference parameters: - - *325 - - *326 - - *490 + - *332 + - *333 + - *497 responses: '204': description: Response '422': *16 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70135,8 +70500,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -70203,7 +70568,7 @@ paths: description: Response content: application/json: - schema: &494 + schema: &501 title: Git Tag description: Metadata for a Git tag type: object @@ -70254,7 +70619,7 @@ paths: - sha - type - url - verification: *493 + verification: *500 required: - sha - url @@ -70264,7 +70629,7 @@ paths: - tag - message examples: - default: &495 + default: &502 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -70291,7 +70656,7 @@ paths: schema: type: string '422': *16 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70337,8 +70702,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag parameters: - - *325 - - *326 + - *332 + - *333 - name: tag_sha in: path required: true @@ -70349,11 +70714,11 @@ paths: description: Response content: application/json: - schema: *494 + schema: *501 examples: - default: *495 + default: *502 '404': *7 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70375,8 +70740,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -70449,7 +70814,7 @@ paths: description: Response content: application/json: - schema: &496 + schema: &503 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -70538,7 +70903,7 @@ paths: '422': *16 '404': *7 '403': *29 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70561,8 +70926,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree parameters: - - *325 - - *326 + - *332 + - *333 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -70585,7 +70950,7 @@ paths: description: Response content: application/json: - schema: *496 + schema: *503 examples: default-response: summary: Default response @@ -70626,7 +70991,7 @@ paths: truncated: false '422': *16 '404': *7 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70644,8 +71009,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -70655,7 +71020,7 @@ paths: application/json: schema: type: array - items: &497 + items: &504 title: Webhook description: Webhooks for repositories. type: object @@ -70709,7 +71074,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &742 + last_response: &749 title: Hook Response type: object properties: @@ -70783,8 +71148,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: false content: @@ -70836,9 +71201,9 @@ paths: description: Response content: application/json: - schema: *497 + schema: *504 examples: - default: &498 + default: &505 value: type: Repository id: 12345678 @@ -70886,17 +71251,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook parameters: - - *325 - - *326 - - *220 + - *332 + - *333 + - *232 responses: '200': description: Response content: application/json: - schema: *497 + schema: *504 examples: - default: *498 + default: *505 '404': *7 x-github: githubCloudOnly: false @@ -70916,9 +71281,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook parameters: - - *325 - - *326 - - *220 + - *332 + - *333 + - *232 requestBody: required: true content: @@ -70963,9 +71328,9 @@ paths: description: Response content: application/json: - schema: *497 + schema: *504 examples: - default: *498 + default: *505 '422': *16 '404': *7 x-github: @@ -70986,9 +71351,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook parameters: - - *325 - - *326 - - *220 + - *332 + - *333 + - *232 responses: '204': description: Response @@ -71012,9 +71377,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: - - *325 - - *326 - - *220 + - *332 + - *333 + - *232 responses: '200': description: Response @@ -71041,9 +71406,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: - - *325 - - *326 - - *220 + - *332 + - *333 + - *232 requestBody: required: false content: @@ -71087,11 +71452,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *325 - - *326 - - *220 + - *332 + - *333 + - *232 - *18 - - *221 + - *233 responses: '200': description: Response @@ -71099,9 +71464,9 @@ paths: application/json: schema: type: array - items: *222 + items: *234 examples: - default: *223 + default: *235 '400': *15 '422': *16 x-github: @@ -71120,18 +71485,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: - - *325 - - *326 - - *220 + - *332 + - *333 + - *232 - *17 responses: '200': description: Response content: application/json: - schema: *224 + schema: *236 examples: - default: *225 + default: *237 '400': *15 '422': *16 x-github: @@ -71150,12 +71515,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: - - *325 - - *326 - - *220 + - *332 + - *333 + - *232 - *17 responses: - '202': *151 + '202': *163 '400': *15 '422': *16 x-github: @@ -71175,9 +71540,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook parameters: - - *325 - - *326 - - *220 + - *332 + - *333 + - *232 responses: '204': description: Response @@ -71202,9 +71567,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *325 - - *326 - - *220 + - *332 + - *333 + - *232 responses: '204': description: Response @@ -71262,14 +71627,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: &499 + schema: &506 title: Import description: A repository import from an external source. type: object @@ -71368,7 +71733,7 @@ paths: - html_url - authors_url examples: - default: &502 + default: &509 value: vcs: subversion use_lfs: true @@ -71384,7 +71749,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *7 - '503': &500 + '503': &507 description: Unavailable due to service under maintenance. content: application/json: @@ -71413,8 +71778,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -71462,7 +71827,7 @@ paths: description: Response content: application/json: - schema: *499 + schema: *506 examples: default: value: @@ -71487,7 +71852,7 @@ paths: type: string '422': *16 '404': *7 - '503': *500 + '503': *507 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71515,8 +71880,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: false content: @@ -71565,7 +71930,7 @@ paths: description: Response content: application/json: - schema: *499 + schema: *506 examples: example-1: summary: Example 1 @@ -71613,7 +71978,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': *500 + '503': *507 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71636,12 +72001,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import parameters: - - *325 - - *326 + - *332 + - *333 responses: '204': description: Response - '503': *500 + '503': *507 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71667,9 +72032,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors parameters: - - *325 - - *326 - - &688 + - *332 + - *333 + - &695 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -71683,7 +72048,7 @@ paths: application/json: schema: type: array - items: &501 + items: &508 title: Porter Author description: Porter Author type: object @@ -71737,7 +72102,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *7 - '503': *500 + '503': *507 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71762,8 +72127,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author parameters: - - *325 - - *326 + - *332 + - *333 - name: author_id in: path required: true @@ -71793,7 +72158,7 @@ paths: description: Response content: application/json: - schema: *501 + schema: *508 examples: default: value: @@ -71806,7 +72171,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *16 '404': *7 - '503': *500 + '503': *507 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71830,8 +72195,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -71872,7 +72237,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *500 + '503': *507 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71900,8 +72265,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -71928,11 +72293,11 @@ paths: description: Response content: application/json: - schema: *499 + schema: *506 examples: - default: *502 + default: *509 '422': *16 - '503': *500 + '503': *507 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71955,8 +72320,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -71964,8 +72329,8 @@ paths: application/json: schema: *22 examples: - default: *503 - '301': *339 + default: *510 + '301': *346 '404': *7 x-github: githubCloudOnly: false @@ -71985,8 +72350,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -71994,12 +72359,12 @@ paths: application/json: schema: anyOf: - - *238 + - *250 - type: object properties: {} additionalProperties: false examples: - default: &505 + default: &512 value: limit: collaborators_only origin: repository @@ -72024,13 +72389,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: application/json: - schema: *504 + schema: *511 examples: default: summary: Example request body @@ -72042,9 +72407,9 @@ paths: description: Response content: application/json: - schema: *238 + schema: *250 examples: - default: *505 + default: *512 '409': description: Response x-github: @@ -72066,8 +72431,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *325 - - *326 + - *332 + - *333 responses: '204': description: Response @@ -72090,8 +72455,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -72101,9 +72466,9 @@ paths: application/json: schema: type: array - items: *506 + items: *513 examples: - default: &681 + default: &688 value: - id: 1 repository: @@ -72234,9 +72599,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation parameters: - - *325 - - *326 - - *242 + - *332 + - *333 + - *254 requestBody: required: false content: @@ -72265,7 +72630,7 @@ paths: description: Response content: application/json: - schema: *506 + schema: *513 examples: default: value: @@ -72396,9 +72761,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *325 - - *326 - - *242 + - *332 + - *333 + - *254 responses: '204': description: Response @@ -72429,8 +72794,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues parameters: - - *325 - - *326 + - *332 + - *333 - 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 @@ -72470,7 +72835,7 @@ paths: required: false schema: type: string - - *244 + - *256 - name: sort description: What to sort results by. in: query @@ -72483,7 +72848,7 @@ paths: - comments default: created - *78 - - *112 + - *124 - *18 - *20 responses: @@ -72493,9 +72858,9 @@ paths: application/json: schema: type: array - items: *122 + items: *134 examples: - default: &517 + default: &524 value: - id: 1 node_id: MDU6SXNzdWUx @@ -72643,7 +73008,7 @@ paths: state_reason: completed headers: Link: *39 - '301': *339 + '301': *346 '422': *16 '404': *7 x-github: @@ -72672,8 +73037,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -72748,9 +73113,9 @@ paths: description: Response content: application/json: - schema: *122 + schema: *134 examples: - default: &512 + default: &519 value: id: 1 node_id: MDU6SXNzdWUx @@ -72904,9 +73269,9 @@ paths: '400': *15 '403': *29 '422': *16 - '503': *100 + '503': *112 '404': *7 - '410': *336 + '410': *343 x-github: triggersNotification: true githubCloudOnly: false @@ -72934,9 +73299,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *325 - - *326 - - *132 + - *332 + - *333 + - *144 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -72946,7 +73311,7 @@ paths: enum: - asc - desc - - *112 + - *124 - *18 - *20 responses: @@ -72956,9 +73321,9 @@ paths: application/json: schema: type: array - items: *507 + items: *514 examples: - default: &514 + default: &521 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -73016,17 +73381,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment parameters: - - *325 - - *326 - - *121 + - *332 + - *333 + - *133 responses: '200': description: Response content: application/json: - schema: *507 + schema: *514 examples: - default: &508 + default: &515 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -73080,9 +73445,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment parameters: - - *325 - - *326 - - *121 + - *332 + - *333 + - *133 requestBody: required: true content: @@ -73104,9 +73469,9 @@ paths: description: Response content: application/json: - schema: *507 + schema: *514 examples: - default: *508 + default: *515 '422': *16 x-github: githubCloudOnly: false @@ -73124,9 +73489,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment parameters: - - *325 - - *326 - - *121 + - *332 + - *333 + - *133 responses: '204': description: Response @@ -73146,9 +73511,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *325 - - *326 - - *121 + - *332 + - *333 + - *133 - 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. @@ -73174,9 +73539,9 @@ paths: application/json: schema: type: array - items: *314 + items: *321 examples: - default: *316 + default: *323 headers: Link: *39 '404': *7 @@ -73197,9 +73562,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *325 - - *326 - - *121 + - *332 + - *333 + - *133 requestBody: required: true content: @@ -73231,16 +73596,16 @@ paths: description: Reaction exists content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 '201': description: Reaction created content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 '422': *16 x-github: githubCloudOnly: false @@ -73262,10 +73627,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *325 - - *326 - - *121 - - *317 + - *332 + - *333 + - *133 + - *324 responses: '204': description: Response @@ -73285,8 +73650,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -73296,7 +73661,7 @@ paths: application/json: schema: type: array - items: &511 + items: &518 title: Issue Event description: Issue Event type: object @@ -73339,8 +73704,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *509 - required: *510 + properties: *516 + required: *517 nullable: true label: title: Issue Event Label @@ -73384,7 +73749,7 @@ paths: properties: *4 required: *5 nullable: true - requested_team: *243 + requested_team: *255 dismissed_review: title: Issue Event Dismissed Review type: object @@ -73449,7 +73814,7 @@ paths: required: - from - to - author_association: *109 + author_association: *121 lock_reason: type: string nullable: true @@ -73462,8 +73827,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 required: - id - node_id @@ -73647,8 +74012,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event parameters: - - *325 - - *326 + - *332 + - *333 - name: event_id in: path required: true @@ -73659,7 +74024,7 @@ paths: description: Response content: application/json: - schema: *511 + schema: *518 examples: default: value: @@ -73852,7 +74217,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *7 - '410': *336 + '410': *343 '403': *29 x-github: githubCloudOnly: false @@ -73886,9 +74251,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue parameters: - - *325 - - *326 - - &513 + - *332 + - *333 + - &520 name: issue_number description: The number that identifies the issue. in: path @@ -73900,12 +74265,12 @@ paths: description: Response content: application/json: - schema: *122 + schema: *134 examples: - default: *512 - '301': *339 + default: *519 + '301': *346 '404': *7 - '410': *336 + '410': *343 '304': *37 x-github: githubCloudOnly: false @@ -73930,9 +74295,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 requestBody: required: false content: @@ -74027,15 +74392,15 @@ paths: description: Response content: application/json: - schema: *122 + schema: *134 examples: - default: *512 + default: *519 '422': *16 - '503': *100 + '503': *112 '403': *29 - '301': *339 + '301': *346 '404': *7 - '410': *336 + '410': *343 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74053,9 +74418,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 requestBody: required: false content: @@ -74081,9 +74446,9 @@ paths: description: Response content: application/json: - schema: *122 + schema: *134 examples: - default: *512 + default: *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74099,9 +74464,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 requestBody: content: application/json: @@ -74126,9 +74491,9 @@ paths: description: Response content: application/json: - schema: *122 + schema: *134 examples: - default: *512 + default: *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74150,9 +74515,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: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 - name: assignee in: path required: true @@ -74192,10 +74557,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments parameters: - - *325 - - *326 - - *513 - - *112 + - *332 + - *333 + - *520 + - *124 - *18 - *20 responses: @@ -74205,13 +74570,13 @@ paths: application/json: schema: type: array - items: *507 + items: *514 examples: - default: *514 + default: *521 headers: Link: *39 '404': *7 - '410': *336 + '410': *343 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74240,9 +74605,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 requestBody: required: true content: @@ -74264,16 +74629,16 @@ paths: description: Response content: application/json: - schema: *507 + schema: *514 examples: - default: *508 + default: *515 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *336 + '410': *343 '422': *16 '404': *7 x-github: @@ -74293,9 +74658,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 - *18 - *20 responses: @@ -74309,7 +74674,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &518 + - &525 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -74340,8 +74705,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 label: type: object properties: @@ -74363,7 +74728,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &519 + - &526 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -74394,8 +74759,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 label: type: object properties: @@ -74483,8 +74848,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 assignee: *19 assigner: *19 required: @@ -74499,7 +74864,7 @@ paths: - performed_via_github_app - assignee - assigner - - &520 + - &527 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -74530,8 +74895,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 milestone: type: object properties: @@ -74550,7 +74915,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &521 + - &528 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -74581,8 +74946,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 milestone: type: object properties: @@ -74601,7 +74966,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &522 + - &529 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -74632,8 +74997,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 rename: type: object properties: @@ -74655,7 +75020,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &523 + - &530 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -74686,10 +75051,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 review_requester: *19 - requested_team: *243 + requested_team: *255 requested_reviewer: *19 required: - review_requester @@ -74702,7 +75067,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &524 + - &531 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -74733,10 +75098,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 review_requester: *19 - requested_team: *243 + requested_team: *255 requested_reviewer: *19 required: - review_requester @@ -74749,7 +75114,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &525 + - &532 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -74780,8 +75145,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 dismissed_review: type: object properties: @@ -74809,7 +75174,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &526 + - &533 title: Locked Issue Event description: Locked Issue Event type: object @@ -74840,8 +75205,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 lock_reason: type: string example: '"off-topic"' @@ -74857,7 +75222,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &527 + - &534 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -74888,8 +75253,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 project_card: type: object properties: @@ -74923,7 +75288,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &528 + - &535 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -74954,8 +75319,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 project_card: type: object properties: @@ -74989,7 +75354,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &529 + - &536 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -75020,8 +75385,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 project_card: type: object properties: @@ -75055,7 +75420,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &530 + - &537 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -75146,7 +75511,7 @@ paths: color: red headers: Link: *39 - '410': *336 + '410': *343 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75163,9 +75528,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 - *18 - *20 responses: @@ -75175,7 +75540,7 @@ paths: application/json: schema: type: array - items: &515 + items: &522 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -75222,7 +75587,7 @@ paths: - color - default examples: - default: &516 + default: &523 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -75240,9 +75605,9 @@ paths: default: false headers: Link: *39 - '301': *339 + '301': *346 '404': *7 - '410': *336 + '410': *343 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75259,9 +75624,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 requestBody: required: false content: @@ -75320,12 +75685,12 @@ paths: application/json: schema: type: array - items: *515 + items: *522 examples: - default: *516 - '301': *339 + default: *523 + '301': *346 '404': *7 - '410': *336 + '410': *343 '422': *16 x-github: githubCloudOnly: false @@ -75342,9 +75707,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 requestBody: required: false content: @@ -75404,12 +75769,12 @@ paths: application/json: schema: type: array - items: *515 + items: *522 examples: - default: *516 - '301': *339 + default: *523 + '301': *346 '404': *7 - '410': *336 + '410': *343 '422': *16 x-github: githubCloudOnly: false @@ -75426,15 +75791,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 responses: '204': description: Response - '301': *339 + '301': *346 '404': *7 - '410': *336 + '410': *343 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75453,9 +75818,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 - name: name in: path required: true @@ -75468,7 +75833,7 @@ paths: application/json: schema: type: array - items: *515 + items: *522 examples: default: value: @@ -75479,9 +75844,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *339 + '301': *346 '404': *7 - '410': *336 + '410': *343 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75501,9 +75866,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 requestBody: required: false content: @@ -75531,7 +75896,7 @@ paths: '204': description: Response '403': *29 - '410': *336 + '410': *343 '404': *7 '422': *16 x-github: @@ -75549,9 +75914,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 responses: '204': description: Response @@ -75573,9 +75938,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 - 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. @@ -75601,13 +75966,13 @@ paths: application/json: schema: type: array - items: *314 + items: *321 examples: - default: *316 + default: *323 headers: Link: *39 '404': *7 - '410': *336 + '410': *343 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75625,9 +75990,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 requestBody: required: true content: @@ -75659,16 +76024,16 @@ paths: description: Response content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 '201': description: Response content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 '422': *16 x-github: githubCloudOnly: false @@ -75690,10 +76055,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction parameters: - - *325 - - *326 - - *513 - - *317 + - *332 + - *333 + - *520 + - *324 responses: '204': description: Response @@ -75722,9 +76087,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 requestBody: required: true content: @@ -75746,9 +76111,9 @@ paths: description: Response content: application/json: - schema: *122 + schema: *134 examples: - default: *512 + default: *519 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -75781,9 +76146,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 - *18 - *20 responses: @@ -75793,13 +76158,13 @@ paths: application/json: schema: type: array - items: *122 + items: *134 examples: - default: *517 + default: *524 headers: Link: *39 '404': *7 - '410': *336 + '410': *343 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75827,9 +76192,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 requestBody: required: true content: @@ -75855,16 +76220,16 @@ paths: description: Response content: application/json: - schema: *122 + schema: *134 examples: - default: *512 + default: *519 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *336 + '410': *343 '422': *16 '404': *7 x-github: @@ -75884,9 +76249,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 requestBody: required: true content: @@ -75917,13 +76282,13 @@ paths: description: Response content: application/json: - schema: *122 + schema: *134 examples: - default: *512 + default: *519 '403': *29 '404': *7 '422': *8 - '503': *100 + '503': *112 x-github: triggersNotification: true githubCloudOnly: false @@ -75941,9 +76306,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 - *18 - *20 responses: @@ -75958,19 +76323,19 @@ paths: description: Timeline Event type: object anyOf: - - *518 - - *519 - - *520 - - *521 - - *522 - - *523 - - *524 - *525 - *526 - *527 - *528 - *529 - *530 + - *531 + - *532 + - *533 + - *534 + - *535 + - *536 + - *537 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -76013,7 +76378,7 @@ paths: issue_url: type: string format: uri - author_association: *109 + author_association: *121 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. They @@ -76023,9 +76388,9 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 - reactions: *110 + properties: *119 + required: *120 + reactions: *122 required: - event - actor @@ -76056,7 +76421,7 @@ paths: properties: type: type: string - issue: *122 + issue: *134 required: - event - created_at @@ -76251,7 +76616,7 @@ paths: type: string body_text: type: string - author_association: *109 + author_association: *121 required: - event - id @@ -76274,7 +76639,7 @@ paths: type: string comments: type: array - items: &551 + items: &558 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -76363,7 +76728,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *109 + author_association: *121 _links: type: object properties: @@ -76447,7 +76812,7 @@ paths: enum: - line - file - reactions: *110 + reactions: *122 body_html: type: string example: '"

comment body

"' @@ -76483,7 +76848,7 @@ paths: type: string comments: type: array - items: *440 + items: *447 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -76514,8 +76879,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 assignee: *19 required: - id @@ -76558,8 +76923,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 assignee: *19 required: - id @@ -76602,8 +76967,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 state_reason: type: string nullable: true @@ -76772,7 +77137,7 @@ paths: headers: Link: *39 '404': *7 - '410': *336 + '410': *343 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76789,8 +77154,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -76800,7 +77165,7 @@ paths: application/json: schema: type: array - items: &531 + items: &538 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -76865,8 +77230,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -76902,9 +77267,9 @@ paths: description: Response content: application/json: - schema: *531 + schema: *538 examples: - default: &532 + default: &539 value: id: 1 key: ssh-rsa AAA... @@ -76938,9 +77303,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *325 - - *326 - - &533 + - *332 + - *333 + - &540 name: key_id description: The unique identifier of the key. in: path @@ -76952,9 +77317,9 @@ paths: description: Response content: application/json: - schema: *531 + schema: *538 examples: - default: *532 + default: *539 '404': *7 x-github: githubCloudOnly: false @@ -76972,9 +77337,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *325 - - *326 - - *533 + - *332 + - *333 + - *540 responses: '204': description: Response @@ -76994,8 +77359,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -77005,9 +77370,9 @@ paths: application/json: schema: type: array - items: *515 + items: *522 examples: - default: *516 + default: *523 headers: Link: *39 '404': *7 @@ -77028,8 +77393,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -77065,9 +77430,9 @@ paths: description: Response content: application/json: - schema: *515 + schema: *522 examples: - default: &534 + default: &541 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -77099,8 +77464,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label parameters: - - *325 - - *326 + - *332 + - *333 - name: name in: path required: true @@ -77111,9 +77476,9 @@ paths: description: Response content: application/json: - schema: *515 + schema: *522 examples: - default: *534 + default: *541 '404': *7 x-github: githubCloudOnly: false @@ -77130,8 +77495,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label parameters: - - *325 - - *326 + - *332 + - *333 - name: name in: path required: true @@ -77170,7 +77535,7 @@ paths: description: Response content: application/json: - schema: *515 + schema: *522 examples: default: value: @@ -77196,8 +77561,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label parameters: - - *325 - - *326 + - *332 + - *333 - name: name in: path required: true @@ -77223,8 +77588,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -77260,10 +77625,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *325 - - *326 + - *332 + - *333 responses: - '202': *151 + '202': *163 '403': description: |- We will return a 403 with one of the following messages: @@ -77289,8 +77654,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *325 - - *326 + - *332 + - *333 responses: '204': description: Response @@ -77316,9 +77681,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *325 - - *326 - - *415 + - *332 + - *333 + - *422 responses: '200': description: Response @@ -77380,8 +77745,8 @@ paths: title: License Simple description: License Simple type: object - properties: *123 - required: *124 + properties: *135 + required: *136 nullable: true required: - _links @@ -77463,8 +77828,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: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -77529,8 +77894,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -77564,9 +77929,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *441 + schema: *448 examples: - default: *535 + default: *542 '204': description: Response when already merged '404': @@ -77591,8 +77956,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones parameters: - - *325 - - *326 + - *332 + - *333 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -77633,12 +77998,12 @@ paths: application/json: schema: type: array - items: &536 + items: &543 title: Milestone description: A collection of related issues and pull requests. type: object - properties: *445 - required: *446 + properties: *452 + required: *453 examples: default: value: @@ -77694,8 +78059,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -77735,9 +78100,9 @@ paths: description: Response content: application/json: - schema: *536 + schema: *543 examples: - default: &537 + default: &544 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -77796,9 +78161,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone parameters: - - *325 - - *326 - - &538 + - *332 + - *333 + - &545 name: milestone_number description: The number that identifies the milestone. in: path @@ -77810,9 +78175,9 @@ paths: description: Response content: application/json: - schema: *536 + schema: *543 examples: - default: *537 + default: *544 '404': *7 x-github: githubCloudOnly: false @@ -77829,9 +78194,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone parameters: - - *325 - - *326 - - *538 + - *332 + - *333 + - *545 requestBody: required: false content: @@ -77869,9 +78234,9 @@ paths: description: Response content: application/json: - schema: *536 + schema: *543 examples: - default: *537 + default: *544 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77887,9 +78252,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone parameters: - - *325 - - *326 - - *538 + - *332 + - *333 + - *545 responses: '204': description: Response @@ -77910,9 +78275,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: - - *325 - - *326 - - *538 + - *332 + - *333 + - *545 - *18 - *20 responses: @@ -77922,9 +78287,9 @@ paths: application/json: schema: type: array - items: *515 + items: *522 examples: - default: *516 + default: *523 headers: Link: *39 x-github: @@ -77943,12 +78308,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: - - *325 - - *326 - - *539 - - *540 - - *112 - - *541 + - *332 + - *333 + - *546 + - *547 + - *124 + - *548 - *18 - *20 responses: @@ -77958,9 +78323,9 @@ paths: application/json: schema: type: array - items: *135 + items: *147 examples: - default: *542 + default: *549 headers: Link: *39 x-github: @@ -77984,8 +78349,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: false content: @@ -78043,14 +78408,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: &543 + schema: &550 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -78175,7 +78540,7 @@ paths: - custom_404 - public examples: - default: &544 + default: &551 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -78216,8 +78581,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -78271,11 +78636,11 @@ paths: description: Response content: application/json: - schema: *543 + schema: *550 examples: - default: *544 + default: *551 '422': *16 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78296,8 +78661,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: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -78383,7 +78748,7 @@ paths: description: Response '422': *16 '400': *15 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78404,14 +78769,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site parameters: - - *325 - - *326 + - *332 + - *333 responses: '204': description: Response '422': *16 '404': *7 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78431,8 +78796,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -78442,7 +78807,7 @@ paths: application/json: schema: type: array - items: &545 + items: &552 title: Page Build description: Page Build type: object @@ -78536,8 +78901,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build parameters: - - *325 - - *326 + - *332 + - *333 responses: '201': description: Response @@ -78582,16 +78947,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *545 + schema: *552 examples: - default: &546 + default: &553 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -78639,8 +79004,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build parameters: - - *325 - - *326 + - *332 + - *333 - name: build_id in: path required: true @@ -78651,9 +79016,9 @@ paths: description: Response content: application/json: - schema: *545 + schema: *552 examples: - default: *546 + default: *553 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78673,8 +79038,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -78780,9 +79145,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: - - *325 - - *326 - - &547 + - *332 + - *333 + - &554 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -78840,11 +79205,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *325 - - *326 - - *547 + - *332 + - *333 + - *554 responses: - '204': *192 + '204': *204 '404': *7 x-github: githubCloudOnly: false @@ -78869,8 +79234,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -79101,7 +79466,7 @@ paths: description: Empty response content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -79128,8 +79493,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Private vulnerability reporting status @@ -79166,10 +79531,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: - - *325 - - *326 + - *332 + - *333 responses: - '204': *192 + '204': *204 '422': *15 x-github: githubCloudOnly: false @@ -79188,10 +79553,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: - - *325 - - *326 + - *332 + - *333 responses: - '204': *192 + '204': *204 '422': *15 x-github: githubCloudOnly: false @@ -79212,8 +79577,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-repository-projects parameters: - - *325 - - *326 + - *332 + - *333 - name: state description: Indicates the state of the projects to return. in: query @@ -79234,7 +79599,7 @@ paths: application/json: schema: type: array - items: *272 + items: *284 examples: default: value: @@ -79274,7 +79639,7 @@ paths: '401': *25 '403': *29 '404': *7 - '410': *336 + '410': *343 '422': *8 x-github: githubCloudOnly: false @@ -79294,8 +79659,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#create-a-repository-project parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -79321,13 +79686,13 @@ paths: description: Response content: application/json: - schema: *272 + schema: *284 examples: - default: *335 + default: *342 '401': *25 '403': *29 '404': *7 - '410': *336 + '410': *343 '422': *8 x-github: githubCloudOnly: false @@ -79347,8 +79712,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -79356,7 +79721,7 @@ paths: application/json: schema: type: array - items: *273 + items: *286 examples: default: value: @@ -79387,8 +79752,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: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -79400,7 +79765,7 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *273 + items: *286 required: - properties examples: @@ -79450,8 +79815,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests parameters: - - *325 - - *326 + - *332 + - *333 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -79511,9 +79876,9 @@ paths: application/json: schema: type: array - items: *548 + items: *555 examples: - default: *549 + default: *556 headers: Link: *39 '304': *37 @@ -79545,8 +79910,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -79611,7 +79976,7 @@ paths: description: Response content: application/json: - schema: &553 + schema: &560 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -79722,8 +80087,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *445 - required: *446 + properties: *452 + required: *453 nullable: true active_lock_reason: type: string @@ -79768,7 +80133,7 @@ paths: nullable: true requested_teams: type: array - items: *297 + items: *304 nullable: true head: type: object @@ -79807,14 +80172,14 @@ paths: _links: type: object properties: - comments: *447 - commits: *447 - statuses: *447 - html: *447 - issue: *447 - review_comments: *447 - review_comment: *447 - self: *447 + comments: *454 + commits: *454 + statuses: *454 + html: *454 + issue: *454 + review_comments: *454 + review_comment: *454 + self: *454 required: - comments - commits @@ -79824,8 +80189,8 @@ paths: - review_comments - review_comment - self - author_association: *109 - auto_merge: *550 + author_association: *121 + auto_merge: *557 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -79917,7 +80282,7 @@ paths: - merged_by - review_comments examples: - default: &554 + default: &561 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -80444,8 +80809,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *325 - - *326 + - *332 + - *333 - name: sort in: query required: false @@ -80464,7 +80829,7 @@ paths: enum: - asc - desc - - *112 + - *124 - *18 - *20 responses: @@ -80474,9 +80839,9 @@ paths: application/json: schema: type: array - items: *551 + items: *558 examples: - default: &556 + default: &563 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -80553,17 +80918,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: - - *325 - - *326 - - *121 + - *332 + - *333 + - *133 responses: '200': description: Response content: application/json: - schema: *551 + schema: *558 examples: - default: &552 + default: &559 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -80638,9 +81003,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: - - *325 - - *326 - - *121 + - *332 + - *333 + - *133 requestBody: required: true content: @@ -80662,9 +81027,9 @@ paths: description: Response content: application/json: - schema: *551 + schema: *558 examples: - default: *552 + default: *559 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80680,9 +81045,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: - - *325 - - *326 - - *121 + - *332 + - *333 + - *133 responses: '204': description: Response @@ -80703,9 +81068,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: - - *325 - - *326 - - *121 + - *332 + - *333 + - *133 - 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. @@ -80731,9 +81096,9 @@ paths: application/json: schema: type: array - items: *314 + items: *321 examples: - default: *316 + default: *323 headers: Link: *39 '404': *7 @@ -80754,9 +81119,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: - - *325 - - *326 - - *121 + - *332 + - *333 + - *133 requestBody: required: true content: @@ -80788,16 +81153,16 @@ paths: description: Reaction exists content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 '201': description: Reaction created content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 '422': *16 x-github: githubCloudOnly: false @@ -80819,10 +81184,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *325 - - *326 - - *121 - - *317 + - *332 + - *333 + - *133 + - *324 responses: '204': description: Response @@ -80865,9 +81230,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request parameters: - - *325 - - *326 - - &555 + - *332 + - *333 + - &562 name: pull_number description: The number that identifies the pull request. in: path @@ -80880,9 +81245,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *553 + schema: *560 examples: - default: *554 + default: *561 '304': *37 '404': *7 '406': @@ -80891,7 +81256,7 @@ paths: application/json: schema: *3 '500': *84 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80917,9 +81282,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request parameters: - - *325 - - *326 - - *555 + - *332 + - *333 + - *562 requestBody: required: false content: @@ -80961,9 +81326,9 @@ paths: description: Response content: application/json: - schema: *553 + schema: *560 examples: - default: *554 + default: *561 '422': *16 '403': *29 x-github: @@ -80985,9 +81350,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: - - *325 - - *326 - - *555 + - *332 + - *333 + - *562 requestBody: required: true content: @@ -81047,21 +81412,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *247 + schema: *259 examples: - default: *430 + default: *437 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *247 + schema: *259 examples: - default: *430 + default: *437 '401': *25 '403': *29 '404': *7 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -81087,10 +81452,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: - - *325 - - *326 - - *555 - - *132 + - *332 + - *333 + - *562 + - *144 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -81100,7 +81465,7 @@ paths: enum: - asc - desc - - *112 + - *124 - *18 - *20 responses: @@ -81110,9 +81475,9 @@ paths: application/json: schema: type: array - items: *551 + items: *558 examples: - default: *556 + default: *563 headers: Link: *39 x-github: @@ -81145,9 +81510,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: - - *325 - - *326 - - *555 + - *332 + - *333 + - *562 requestBody: required: true content: @@ -81252,7 +81617,7 @@ paths: description: Response content: application/json: - schema: *551 + schema: *558 examples: example-for-a-multi-line-comment: value: @@ -81340,10 +81705,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: - - *325 - - *326 - - *555 - - *121 + - *332 + - *333 + - *562 + - *133 requestBody: required: true content: @@ -81365,7 +81730,7 @@ paths: description: Response content: application/json: - schema: *551 + schema: *558 examples: default: value: @@ -81451,9 +81816,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *325 - - *326 - - *555 + - *332 + - *333 + - *562 - *18 - *20 responses: @@ -81463,9 +81828,9 @@ paths: application/json: schema: type: array - items: *441 + items: *448 examples: - default: *557 + default: *564 headers: Link: *39 x-github: @@ -81495,9 +81860,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files parameters: - - *325 - - *326 - - *555 + - *332 + - *333 + - *562 - *18 - *20 responses: @@ -81507,7 +81872,7 @@ paths: application/json: schema: type: array - items: *456 + items: *463 examples: default: value: @@ -81526,7 +81891,7 @@ paths: Link: *39 '422': *16 '500': *84 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81545,9 +81910,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: - - *325 - - *326 - - *555 + - *332 + - *333 + - *562 responses: '204': description: Response if pull request has been merged @@ -81570,9 +81935,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request parameters: - - *325 - - *326 - - *555 + - *332 + - *333 + - *562 requestBody: required: false content: @@ -81683,9 +82048,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: - - *325 - - *326 - - *555 + - *332 + - *333 + - *562 responses: '200': description: Response @@ -81701,7 +82066,7 @@ paths: items: *19 teams: type: array - items: *243 + items: *255 required: - users - teams @@ -81760,9 +82125,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: - - *325 - - *326 - - *555 + - *332 + - *333 + - *562 requestBody: required: false content: @@ -81799,7 +82164,7 @@ paths: description: Response content: application/json: - schema: *548 + schema: *555 examples: default: value: @@ -82335,9 +82700,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: - - *325 - - *326 - - *555 + - *332 + - *333 + - *562 requestBody: required: true content: @@ -82371,7 +82736,7 @@ paths: description: Response content: application/json: - schema: *548 + schema: *555 examples: default: value: @@ -82876,9 +83241,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *325 - - *326 - - *555 + - *332 + - *333 + - *562 - *18 - *20 responses: @@ -82888,7 +83253,7 @@ paths: application/json: schema: type: array - items: &558 + items: &565 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -82957,7 +83322,7 @@ paths: type: string body_text: type: string - author_association: *109 + author_association: *121 required: - id - node_id @@ -83039,9 +83404,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: - - *325 - - *326 - - *555 + - *332 + - *333 + - *562 requestBody: required: false content: @@ -83127,9 +83492,9 @@ paths: description: Response content: application/json: - schema: *558 + schema: *565 examples: - default: &560 + default: &567 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -83192,10 +83557,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: - - *325 - - *326 - - *555 - - &559 + - *332 + - *333 + - *562 + - &566 name: review_id description: The unique identifier of the review. in: path @@ -83207,9 +83572,9 @@ paths: description: Response content: application/json: - schema: *558 + schema: *565 examples: - default: &561 + default: &568 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -83268,10 +83633,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: - - *325 - - *326 - - *555 - - *559 + - *332 + - *333 + - *562 + - *566 requestBody: required: true content: @@ -83294,7 +83659,7 @@ paths: description: Response content: application/json: - schema: *558 + schema: *565 examples: default: value: @@ -83356,18 +83721,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: - - *325 - - *326 - - *555 - - *559 + - *332 + - *333 + - *562 + - *566 responses: '200': description: Response content: application/json: - schema: *558 + schema: *565 examples: - default: *560 + default: *567 '422': *8 '404': *7 x-github: @@ -83394,10 +83759,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: - - *325 - - *326 - - *555 - - *559 + - *332 + - *333 + - *562 + - *566 - *18 - *20 responses: @@ -83476,13 +83841,13 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *109 + author_association: *121 _links: type: object properties: - self: *447 - html: *447 - pull_request: *447 + self: *454 + html: *454 + pull_request: *454 required: - self - html @@ -83491,7 +83856,7 @@ paths: type: string body_html: type: string - reactions: *110 + reactions: *122 side: description: The side of the first line of the range for a multi-line comment. @@ -83625,10 +83990,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: - - *325 - - *326 - - *555 - - *559 + - *332 + - *333 + - *562 + - *566 requestBody: required: true content: @@ -83656,7 +84021,7 @@ paths: description: Response content: application/json: - schema: *558 + schema: *565 examples: default: value: @@ -83719,10 +84084,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: - - *325 - - *326 - - *555 - - *559 + - *332 + - *333 + - *562 + - *566 requestBody: required: true content: @@ -83757,9 +84122,9 @@ paths: description: Response content: application/json: - schema: *558 + schema: *565 examples: - default: *561 + default: *568 '404': *7 '422': *8 '403': *29 @@ -83781,9 +84146,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch parameters: - - *325 - - *326 - - *555 + - *332 + - *333 + - *562 requestBody: required: false content: @@ -83846,8 +84211,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme parameters: - - *325 - - *326 + - *332 + - *333 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -83860,9 +84225,9 @@ paths: description: Response content: application/json: - schema: *562 + schema: *569 examples: - default: &563 + default: &570 value: type: file encoding: base64 @@ -83904,8 +84269,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: - - *325 - - *326 + - *332 + - *333 - name: dir description: The alternate path to look for a README file in: path @@ -83925,9 +84290,9 @@ paths: description: Response content: application/json: - schema: *562 + schema: *569 examples: - default: *563 + default: *570 '404': *7 '422': *16 x-github: @@ -83949,8 +84314,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -83960,7 +84325,7 @@ paths: application/json: schema: type: array - items: &564 + items: &571 title: Release description: A release. type: object @@ -84023,7 +84388,7 @@ paths: author: *19 assets: type: array - items: &565 + items: &572 title: Release Asset description: Data related to a release. type: object @@ -84094,7 +84459,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *110 + reactions: *122 required: - assets_url - upload_url @@ -84204,8 +84569,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -84281,9 +84646,9 @@ paths: description: Response content: application/json: - schema: *564 + schema: *571 examples: - default: &568 + default: &575 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -84386,9 +84751,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset parameters: - - *325 - - *326 - - &566 + - *332 + - *333 + - &573 name: asset_id description: The unique identifier of the asset. in: path @@ -84400,9 +84765,9 @@ paths: description: Response content: application/json: - schema: *565 + schema: *572 examples: - default: &567 + default: &574 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 @@ -84436,7 +84801,7 @@ paths: type: User site_admin: false '404': *7 - '302': *458 + '302': *465 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84452,9 +84817,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset parameters: - - *325 - - *326 - - *566 + - *332 + - *333 + - *573 requestBody: required: false content: @@ -84482,9 +84847,9 @@ paths: description: Response content: application/json: - schema: *565 + schema: *572 examples: - default: *567 + default: *574 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84500,9 +84865,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset parameters: - - *325 - - *326 - - *566 + - *332 + - *333 + - *573 responses: '204': description: Response @@ -84526,8 +84891,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: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -84612,16 +84977,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *564 + schema: *571 examples: - default: *568 + default: *575 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84638,8 +85003,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name parameters: - - *325 - - *326 + - *332 + - *333 - name: tag description: tag parameter in: path @@ -84652,9 +85017,9 @@ paths: description: Response content: application/json: - schema: *564 + schema: *571 examples: - default: *568 + default: *575 '404': *7 x-github: githubCloudOnly: false @@ -84676,9 +85041,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release parameters: - - *325 - - *326 - - &569 + - *332 + - *333 + - &576 name: release_id description: The unique identifier of the release. in: path @@ -84692,9 +85057,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: *564 + schema: *571 examples: - default: *568 + default: *575 '401': description: Unauthorized x-github: @@ -84712,9 +85077,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release parameters: - - *325 - - *326 - - *569 + - *332 + - *333 + - *576 requestBody: required: false content: @@ -84778,9 +85143,9 @@ paths: description: Response content: application/json: - schema: *564 + schema: *571 examples: - default: *568 + default: *575 '404': description: Not Found if the discussion category name is invalid content: @@ -84801,9 +85166,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release parameters: - - *325 - - *326 - - *569 + - *332 + - *333 + - *576 responses: '204': description: Response @@ -84823,9 +85188,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets parameters: - - *325 - - *326 - - *569 + - *332 + - *333 + - *576 - *18 - *20 responses: @@ -84835,7 +85200,7 @@ paths: application/json: schema: type: array - items: *565 + items: *572 examples: default: value: @@ -84916,9 +85281,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: - - *325 - - *326 - - *569 + - *332 + - *333 + - *576 - name: name in: query required: true @@ -84944,7 +85309,7 @@ paths: description: Response for successful upload content: application/json: - schema: *565 + schema: *572 examples: response-for-successful-upload: value: @@ -84998,9 +85363,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release parameters: - - *325 - - *326 - - *569 + - *332 + - *333 + - *576 - 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. @@ -85024,9 +85389,9 @@ paths: application/json: schema: type: array - items: *314 + items: *321 examples: - default: *316 + default: *323 headers: Link: *39 '404': *7 @@ -85047,9 +85412,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release parameters: - - *325 - - *326 - - *569 + - *332 + - *333 + - *576 requestBody: required: true content: @@ -85079,16 +85444,16 @@ paths: description: Reaction exists content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 '201': description: Reaction created content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 '422': *16 x-github: githubCloudOnly: false @@ -85110,10 +85475,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction parameters: - - *325 - - *326 - - *569 - - *317 + - *332 + - *333 + - *576 + - *324 responses: '204': description: Response @@ -85137,9 +85502,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 - *18 - *20 responses: @@ -85155,8 +85520,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *570 - - &572 + - *577 + - &579 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -85175,54 +85540,54 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. - - allOf: - - *571 - - *572 - - allOf: - - *573 - - *572 - - allOf: - - *574 - - *572 - - allOf: - - *575 - - *572 - - allOf: - - *576 - - *572 - - allOf: - - *577 - - *572 - allOf: - *578 - - *572 - - allOf: - *579 - - *572 - allOf: - *580 - - *572 + - *579 - allOf: - *581 - - *572 + - *579 - allOf: - *582 - - *572 + - *579 - allOf: - *583 - - *572 + - *579 - allOf: - *584 - - *572 + - *579 - allOf: - *585 - - *572 + - *579 - allOf: - *586 - - *572 + - *579 - allOf: - *587 - - *572 + - *579 + - allOf: + - *588 + - *579 + - allOf: + - *589 + - *579 + - allOf: + - *590 + - *579 + - allOf: + - *591 + - *579 + - allOf: + - *592 + - *579 + - allOf: + - *593 + - *579 + - allOf: + - *594 + - *579 examples: default: value: @@ -85261,8 +85626,8 @@ paths: category: repos subcategory: rules parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 - name: includes_parents @@ -85273,7 +85638,7 @@ paths: schema: type: boolean default: true - - *588 + - *595 responses: '200': description: Response @@ -85281,7 +85646,7 @@ paths: application/json: schema: type: array - items: *285 + items: *109 examples: default: value: @@ -85328,8 +85693,8 @@ paths: category: repos subcategory: rules parameters: - - *325 - - *326 + - *332 + - *333 requestBody: description: Request body required: true @@ -85349,16 +85714,16 @@ paths: - tag - push default: branch - enforcement: *281 + enforcement: *106 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *282 - conditions: *279 + items: *107 + conditions: *102 rules: type: array description: An array of rules within the ruleset. - items: *284 + items: *108 required: - name - enforcement @@ -85389,9 +85754,9 @@ paths: description: Response content: application/json: - schema: *285 + schema: *109 examples: - default: &598 + default: &605 value: id: 42 name: super cool ruleset @@ -85438,12 +85803,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites parameters: - - *325 - - *326 - - *589 - - *590 - - *591 - - *592 + - *332 + - *333 + - *596 + - *597 + - *598 + - *599 - *18 - *20 responses: @@ -85451,9 +85816,9 @@ paths: description: Response content: application/json: - schema: *593 + schema: *600 examples: - default: *594 + default: *601 '404': *7 '500': *84 x-github: @@ -85474,17 +85839,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *325 - - *326 - - *595 + - *332 + - *333 + - *602 responses: '200': description: Response content: application/json: - schema: *596 + schema: *603 examples: - default: *597 + default: *604 '404': *7 '500': *84 x-github: @@ -85512,8 +85877,8 @@ paths: category: repos subcategory: rules parameters: - - *325 - - *326 + - *332 + - *333 - name: ruleset_id description: The ID of the ruleset. in: path @@ -85533,9 +85898,9 @@ paths: description: Response content: application/json: - schema: *285 + schema: *109 examples: - default: *598 + default: *605 '404': *7 '500': *84 put: @@ -85553,8 +85918,8 @@ paths: category: repos subcategory: rules parameters: - - *325 - - *326 + - *332 + - *333 - name: ruleset_id description: The ID of the ruleset. in: path @@ -85579,16 +85944,16 @@ paths: - branch - tag - push - enforcement: *281 + enforcement: *106 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *282 - conditions: *279 + items: *107 + conditions: *102 rules: description: An array of rules within the ruleset. type: array - items: *284 + items: *108 examples: default: value: @@ -85616,9 +85981,9 @@ paths: description: Response content: application/json: - schema: *285 + schema: *109 examples: - default: *598 + default: *605 '404': *7 '500': *84 delete: @@ -85636,8 +86001,8 @@ paths: category: repos subcategory: rules parameters: - - *325 - - *326 + - *332 + - *333 - name: ruleset_id description: The ID of the ruleset. in: path @@ -85665,20 +86030,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: - - *325 - - *326 - - *287 - - *288 - - *289 - - *290 + - *332 + - *333 + - *294 + - *295 + - *296 + - *297 - *78 - *20 - *18 - - *599 - - *600 - - *291 - - *292 - - *293 + - *606 + - *607 + - *298 + - *299 + - *300 responses: '200': description: Response @@ -85686,7 +86051,7 @@ paths: application/json: schema: type: array - items: &603 + items: &610 type: object properties: number: *85 @@ -85705,8 +86070,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *601 - resolution: *602 + state: *608 + resolution: *609 resolved_at: type: string format: date-time @@ -85760,6 +86125,11 @@ paths: properties: *4 required: *5 nullable: true + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection + bypass. + nullable: true push_protection_bypass_request_comment: type: string description: An optional comment when requesting a push protection @@ -85859,6 +86229,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 @@ -85881,6 +86252,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: @@ -85890,7 +86262,7 @@ paths: '404': description: Repository is public or secret scanning is disabled for the repository - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85912,15 +86284,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: - - *325 - - *326 - - *413 + - *332 + - *333 + - *420 responses: '200': description: Response content: application/json: - schema: *603 + schema: *610 examples: default: value: @@ -85940,6 +86312,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: @@ -85950,7 +86323,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85971,9 +86344,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: - - *325 - - *326 - - *413 + - *332 + - *333 + - *420 requestBody: required: true content: @@ -85981,8 +86354,8 @@ paths: schema: type: object properties: - state: *601 - resolution: *602 + state: *608 + resolution: *609 resolution_comment: description: An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. @@ -86000,7 +86373,7 @@ paths: description: Response content: application/json: - schema: *603 + schema: *610 examples: default: value: @@ -86038,6 +86411,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 @@ -86052,7 +86426,7 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment - '503': *100 + '503': *112 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -86074,9 +86448,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: - - *325 - - *326 - - *413 + - *332 + - *333 + - *420 - *20 - *18 responses: @@ -86087,7 +86461,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &763 + items: &770 type: object properties: type: @@ -86424,7 +86798,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86446,8 +86820,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: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -86455,14 +86829,14 @@ paths: schema: type: object properties: - reason: &605 + reason: &612 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *604 + placeholder_id: *611 required: - reason - placeholder_id @@ -86479,7 +86853,7 @@ paths: schema: type: object properties: - reason: *605 + reason: *612 expire_at: type: string format: date-time @@ -86502,7 +86876,7 @@ paths: this repository. '422': description: Bad request, input data missing or incorrect. - '503': *100 + '503': *112 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -86522,13 +86896,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: - - *325 - - *326 + - *332 + - *333 responses: '404': description: Repository does not have GitHub Advanced Security or secret scanning enabled - '503': *100 + '503': *112 '200': description: Response content: @@ -86538,7 +86912,7 @@ paths: properties: incremental_scans: type: array - items: &606 + items: &613 description: Information on a single scan performed by secret scanning on the repository type: object @@ -86564,15 +86938,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *606 + items: *613 backfill_scans: type: array - items: *606 + items: *613 custom_pattern_backfill_scans: type: array items: allOf: - - *606 + - *613 - type: object properties: pattern_name: @@ -86642,8 +87016,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *325 - - *326 + - *332 + - *333 - *78 - name: sort description: The property to sort the results by. @@ -86687,9 +87061,9 @@ paths: application/json: schema: type: array - items: *607 + items: *614 examples: - default: *608 + default: *615 '400': *15 '404': *7 x-github: @@ -86712,8 +87086,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: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -86786,7 +87160,7 @@ paths: login: type: string description: The username of the user credited. - type: *296 + type: *303 required: - login - type @@ -86873,9 +87247,9 @@ paths: description: Response content: application/json: - schema: *607 + schema: *614 examples: - default: &610 + default: &617 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -87108,8 +87482,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: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -87213,7 +87587,7 @@ paths: description: Response content: application/json: - schema: *607 + schema: *614 examples: default: value: @@ -87360,17 +87734,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: - - *325 - - *326 - - *609 + - *332 + - *333 + - *616 responses: '200': description: Response content: application/json: - schema: *607 + schema: *614 examples: - default: *610 + default: *617 '403': *29 '404': *7 x-github: @@ -87394,9 +87768,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: - - *325 - - *326 - - *609 + - *332 + - *333 + - *616 requestBody: required: true content: @@ -87469,7 +87843,7 @@ paths: login: type: string description: The username of the user credited. - type: *296 + type: *303 required: - login - type @@ -87555,17 +87929,17 @@ paths: description: Response content: application/json: - schema: *607 + schema: *614 examples: - default: *610 - add_credit: *610 + default: *617 + add_credit: *617 '403': *29 '404': *7 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *148 + schema: *160 examples: invalid_state_transition: value: @@ -87596,11 +87970,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: - - *325 - - *326 - - *609 + - *332 + - *333 + - *616 responses: - '202': *151 + '202': *163 '400': *15 '403': *29 '404': *7 @@ -87625,17 +87999,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: - - *325 - - *326 - - *609 + - *332 + - *333 + - *616 responses: '202': description: Response content: application/json: - schema: *338 + schema: *345 examples: - default: *340 + default: *347 '400': *15 '422': *16 '403': *29 @@ -87661,8 +88035,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -87761,8 +88135,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -87771,7 +88145,7 @@ paths: application/json: schema: type: array - items: &611 + items: &618 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -87783,8 +88157,8 @@ paths: - - 1302998400 - 1124 - -435 - '202': *151 - '204': *192 + '202': *163 + '204': *204 '422': description: Repository contains more than 10,000 commits x-github: @@ -87804,8 +88178,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -87853,8 +88227,8 @@ paths: - 0 total: 89 week: 1336280400 - '202': *151 - '204': *192 + '202': *163 + '204': *204 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87881,8 +88255,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -87955,8 +88329,8 @@ paths: a: 6898 d: 77 c: 10 - '202': *151 - '204': *192 + '202': *163 + '204': *204 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87978,8 +88352,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -88133,8 +88507,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -88144,7 +88518,7 @@ paths: application/json: schema: type: array - items: *611 + items: *618 examples: default: value: @@ -88157,7 +88531,7 @@ paths: - - 0 - 2 - 21 - '204': *192 + '204': *204 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88177,8 +88551,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status parameters: - - *325 - - *326 + - *332 + - *333 - name: sha in: path required: true @@ -88232,7 +88606,7 @@ paths: description: Response content: application/json: - schema: *612 + schema: *619 examples: default: value: @@ -88286,8 +88660,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -88299,7 +88673,7 @@ paths: type: array items: *19 examples: - default: *246 + default: *258 headers: Link: *39 x-github: @@ -88319,14 +88693,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &613 + schema: &620 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -88394,8 +88768,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: false content: @@ -88421,7 +88795,7 @@ paths: description: Response content: application/json: - schema: *613 + schema: *620 examples: default: value: @@ -88448,8 +88822,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription parameters: - - *325 - - *326 + - *332 + - *333 responses: '204': description: Response @@ -88469,8 +88843,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -88549,8 +88923,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -88558,7 +88932,7 @@ paths: application/json: schema: type: array - items: &614 + items: &621 title: Tag protection description: Tag protection type: object @@ -88610,8 +88984,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: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -88634,7 +89008,7 @@ paths: description: Response content: application/json: - schema: *614 + schema: *621 examples: default: value: @@ -88665,8 +89039,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: - - *325 - - *326 + - *332 + - *333 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -88703,8 +89077,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *325 - - *326 + - *332 + - *333 - name: ref in: path required: true @@ -88740,8 +89114,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -88751,9 +89125,9 @@ paths: application/json: schema: type: array - items: *243 + items: *255 examples: - default: *258 + default: *270 headers: Link: *39 '404': *7 @@ -88773,8 +89147,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics parameters: - - *325 - - *326 + - *332 + - *333 - *20 - *18 responses: @@ -88782,7 +89156,7 @@ paths: description: Response content: application/json: - schema: &615 + schema: &622 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -88794,7 +89168,7 @@ paths: required: - names examples: - default: &616 + default: &623 value: names: - octocat @@ -88817,8 +89191,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -88849,9 +89223,9 @@ paths: description: Response content: application/json: - schema: *615 + schema: *622 examples: - default: *616 + default: *623 '404': *7 '422': *8 x-github: @@ -88872,9 +89246,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones parameters: - - *325 - - *326 - - &617 + - *332 + - *333 + - &624 name: per description: The time frame to display results for. in: query @@ -88903,7 +89277,7 @@ paths: example: 128 clones: type: array - items: &618 + items: &625 title: Traffic type: object properties: @@ -88990,8 +89364,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -89081,8 +89455,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -89142,9 +89516,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views parameters: - - *325 - - *326 - - *617 + - *332 + - *333 + - *624 responses: '200': description: Response @@ -89163,7 +89537,7 @@ paths: example: 3782 views: type: array - items: *618 + items: *625 required: - uniques - count @@ -89240,8 +89614,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -89277,7 +89651,7 @@ paths: description: Response content: application/json: - schema: *163 + schema: *175 examples: default: value: @@ -89515,8 +89889,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: - - *325 - - *326 + - *332 + - *333 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -89539,8 +89913,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts parameters: - - *325 - - *326 + - *332 + - *333 responses: '204': description: Response @@ -89562,8 +89936,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts parameters: - - *325 - - *326 + - *332 + - *333 responses: '204': description: Response @@ -89589,8 +89963,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *325 - - *326 + - *332 + - *333 - name: ref in: path required: true @@ -89682,9 +90056,9 @@ paths: description: Response content: application/json: - schema: *338 + schema: *345 examples: - default: *340 + default: *347 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -89725,7 +90099,7 @@ paths: application/json: schema: type: array - items: *163 + items: *175 examples: default: value: @@ -89835,7 +90209,7 @@ paths: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - - &626 + - &633 name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. @@ -89844,7 +90218,7 @@ paths: schema: type: string example: members - - &631 + - &638 name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' @@ -89855,7 +90229,7 @@ paths: default: 1 format: int32 example: 1 - - &632 + - &639 name: count description: 'Used for pagination: the number of results to return per page.' in: query @@ -89897,7 +90271,7 @@ paths: Resources: type: array description: Information about each provisioned group. - items: &620 + items: &627 allOf: - type: object required: @@ -89972,7 +90346,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: &633 + meta: &640 type: object description: The metadata associated with the creation/updates to the user. @@ -90032,31 +90406,31 @@ paths: location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 startIndex: 1 itemsPerPage: 20 - '400': &621 + '400': &628 description: Bad request content: application/json: - schema: *619 + schema: *626 application/scim+json: - schema: *619 - '401': &622 + schema: *626 + '401': &629 description: Authorization failure - '403': &623 + '403': &630 description: Permission denied - '429': &624 + '429': &631 description: Too many requests content: application/json: - schema: *619 + schema: *626 application/scim+json: - schema: *619 - '500': &625 + schema: *626 + '500': &632 description: Internal server error content: application/json: - schema: *619 + schema: *626 application/scim+json: - schema: *619 + schema: *626 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -90080,7 +90454,7 @@ paths: required: true content: application/json: - schema: &629 + schema: &636 type: object required: - schemas @@ -90136,9 +90510,9 @@ paths: description: Group has been created content: application/scim+json: - schema: *620 + schema: *627 examples: - group: &627 + group: &634 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group @@ -90157,13 +90531,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': *621 - '401': *622 - '403': *623 - '409': &630 + '400': *628 + '401': *629 + '403': *630 + '409': &637 description: Duplicate record detected - '429': *624 - '500': *625 + '429': *631 + '500': *632 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -90180,7 +90554,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: - - &628 + - &635 name: scim_group_id description: A unique identifier of the SCIM group. in: path @@ -90188,22 +90562,22 @@ paths: schema: type: string example: 7fce0092-d52e-4f76-b727-3955bd72c939 - - *626 + - *633 - *40 responses: '200': description: Success, a group was found content: application/scim+json: - schema: *620 + schema: *627 examples: - default: *627 - '400': *621 - '401': *622 - '403': *623 + default: *634 + '400': *628 + '401': *629 + '403': *630 '404': *7 - '429': *624 - '500': *625 + '429': *631 + '500': *632 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -90222,13 +90596,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: - - *628 + - *635 - *40 requestBody: required: true content: application/json: - schema: *629 + schema: *636 examples: group: summary: Group @@ -90254,17 +90628,17 @@ paths: description: Group was updated content: application/scim+json: - schema: *620 + schema: *627 examples: - group: *627 - groupWithMembers: *627 - '400': *621 - '401': *622 - '403': *623 + group: *634 + groupWithMembers: *634 + '400': *628 + '401': *629 + '403': *630 '404': *7 - '409': *630 - '429': *624 - '500': *625 + '409': *637 + '429': *631 + '500': *632 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -90288,13 +90662,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: - - *628 + - *635 - *40 requestBody: required: true content: application/json: - schema: &640 + schema: &647 type: object required: - Operations @@ -90354,17 +90728,17 @@ paths: description: Success, group was updated content: application/scim+json: - schema: *620 + schema: *627 examples: - updateGroup: *627 - addMembers: *627 - '400': *621 - '401': *622 - '403': *623 + updateGroup: *634 + addMembers: *634 + '400': *628 + '401': *629 + '403': *630 '404': *7 - '409': *630 - '429': *624 - '500': *625 + '409': *637 + '429': *631 + '500': *632 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -90380,17 +90754,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: - - *628 + - *635 - *40 responses: '204': description: Group was deleted, no content - '400': *621 - '401': *622 - '403': *623 + '400': *628 + '401': *629 + '403': *630 '404': *7 - '429': *624 - '500': *625 + '429': *631 + '500': *632 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -90424,8 +90798,8 @@ paths: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - - *631 - - *632 + - *638 + - *639 - *40 responses: '200': @@ -90458,7 +90832,7 @@ paths: Resources: type: array description: Information about each provisioned account. - items: &635 + items: &642 allOf: - type: object required: @@ -90537,7 +90911,7 @@ paths: description: Whether this email address is the primary address. example: true - roles: &634 + roles: &641 type: array description: The roles assigned to the user. items: @@ -90593,7 +90967,7 @@ paths: type: string description: Provisioned SCIM groups that the user is a member of. - meta: *633 + meta: *640 startIndex: type: integer description: A starting index for the returned page @@ -90630,11 +91004,11 @@ paths: primary: false startIndex: 1 itemsPerPage: 20 - '400': *621 - '401': *622 - '403': *623 - '429': *624 - '500': *625 + '400': *628 + '401': *629 + '403': *630 + '429': *631 + '500': *632 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -90658,7 +91032,7 @@ paths: required: true content: application/json: - schema: &638 + schema: &645 type: object required: - schemas @@ -90740,9 +91114,9 @@ paths: type: boolean description: Whether this email address is the primary address. example: true - roles: *634 + roles: *641 examples: - user: &639 + user: &646 summary: User value: schemas: @@ -90789,9 +91163,9 @@ paths: description: User has been created content: application/scim+json: - schema: *635 + schema: *642 examples: - user: &636 + user: &643 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -90817,13 +91191,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: *636 - '400': *621 - '401': *622 - '403': *623 - '409': *630 - '429': *624 - '500': *625 + enterpriseOwner: *643 + '400': *628 + '401': *629 + '403': *630 + '409': *637 + '429': *631 + '500': *632 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -90840,7 +91214,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: - - &637 + - &644 name: scim_user_id description: The unique identifier of the SCIM user. in: path @@ -90853,15 +91227,15 @@ paths: description: Success, a user was found content: application/scim+json: - schema: *635 + schema: *642 examples: - default: *636 - '400': *621 - '401': *622 - '403': *623 + default: *643 + '400': *628 + '401': *629 + '403': *630 '404': *7 - '429': *624 - '500': *625 + '429': *631 + '500': *632 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -90883,30 +91257,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: - - *637 + - *644 - *40 requestBody: required: true content: application/json: - schema: *638 + schema: *645 examples: - user: *639 + user: *646 responses: '200': description: User was updated content: application/scim+json: - schema: *635 + schema: *642 examples: - user: *636 - '400': *621 - '401': *622 - '403': *623 + user: *643 + '400': *628 + '401': *629 + '403': *630 '404': *7 - '409': *630 - '429': *624 - '500': *625 + '409': *637 + '429': *631 + '500': *632 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -90941,13 +91315,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: - - *637 + - *644 - *40 requestBody: required: true content: application/json: - schema: *640 + schema: *647 examples: userMultiValuedProperties: summary: Multi Valued Property @@ -90987,18 +91361,18 @@ paths: description: Success, user was updated content: application/scim+json: - schema: *635 - examples: - userMultiValuedProperties: *636 - userSingleValuedProperties: *636 - disableUser: *636 - '400': *621 - '401': *622 - '403': *623 + schema: *642 + examples: + userMultiValuedProperties: *643 + userSingleValuedProperties: *643 + disableUser: *643 + '400': *628 + '401': *629 + '403': *630 '404': *7 - '409': *630 - '429': *624 - '500': *625 + '409': *637 + '429': *631 + '500': *632 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -91018,17 +91392,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: - - *637 + - *644 - *40 responses: '204': description: User was deleted, no content - '400': *621 - '401': *622 - '403': *623 + '400': *628 + '401': *629 + '403': *630 '404': *7 - '429': *624 - '500': *625 + '429': *631 + '500': *632 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -91061,7 +91435,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#list-scim-provisioned-identities parameters: - - *145 + - *157 - name: startIndex description: 'Used for pagination: the index of the first result to return.' in: query @@ -91115,7 +91489,7 @@ paths: example: 1 Resources: type: array - items: &641 + items: &648 title: SCIM /Users description: SCIM /Users provisioning endpoints type: object @@ -91346,22 +91720,22 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243 '304': *37 - '404': &642 + '404': &649 description: Resource not found content: application/json: - schema: *619 + schema: *626 application/scim+json: - schema: *619 - '403': &643 + schema: *626 + '403': &650 description: Forbidden content: application/json: - schema: *619 + schema: *626 application/scim+json: - schema: *619 - '400': *621 - '429': *624 + schema: *626 + '400': *628 + '429': *631 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -91381,15 +91755,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#provision-and-invite-a-scim-user parameters: - - *145 + - *157 responses: '201': description: Response content: application/scim+json: - schema: *641 + schema: *648 examples: - default: &644 + default: &651 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -91412,17 +91786,17 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32 '304': *37 - '404': *642 - '403': *643 - '500': *625 + '404': *649 + '403': *650 + '500': *632 '409': description: Conflict content: application/json: - schema: *619 + schema: *626 application/scim+json: - schema: *619 - '400': *621 + schema: *626 + '400': *628 requestBody: required: true content: @@ -91514,18 +91888,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: - - *145 - - *637 + - *157 + - *644 responses: '200': description: Response content: application/scim+json: - schema: *641 + schema: *648 examples: - default: *644 - '404': *642 - '403': *643 + default: *651 + '404': *649 + '403': *650 '304': *37 x-github: githubCloudOnly: true @@ -91548,19 +91922,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership parameters: - - *145 - - *637 + - *157 + - *644 responses: '200': description: Response content: application/scim+json: - schema: *641 + schema: *648 examples: - default: *644 + default: *651 '304': *37 - '404': *642 - '403': *643 + '404': *649 + '403': *650 requestBody: required: true content: @@ -91668,20 +92042,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: - - *145 - - *637 + - *157 + - *644 responses: '200': description: Response content: application/scim+json: - schema: *641 + schema: *648 examples: - default: *644 + default: *651 '304': *37 - '404': *642 - '403': *643 - '400': *621 + '404': *649 + '403': *650 + '400': *628 '429': description: Response content: @@ -91771,13 +92145,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: - - *145 - - *637 + - *157 + - *644 responses: '204': description: Response - '404': *642 - '403': *643 + '404': *649 + '403': *650 '304': *37 x-github: githubCloudOnly: true @@ -91892,7 +92266,7 @@ paths: html_url: type: string format: uri - repository: *163 + repository: *175 score: type: number file_size: @@ -91910,7 +92284,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &645 + text_matches: &652 title: Search Result Text Matches type: array items: @@ -92024,7 +92398,7 @@ paths: releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} score: 1 '304': *37 - '503': *100 + '503': *112 '422': *16 '403': *29 x-github: @@ -92073,7 +92447,7 @@ paths: enum: - author-date - committer-date - - &646 + - &653 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 @@ -92144,7 +92518,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *382 + properties: *389 nullable: true comment_count: type: integer @@ -92164,7 +92538,7 @@ paths: url: type: string format: uri - verification: *493 + verification: *500 required: - author - committer @@ -92183,7 +92557,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *382 + properties: *389 nullable: true parents: type: array @@ -92196,12 +92570,12 @@ paths: type: string sha: type: string - repository: *163 + repository: *175 score: type: number node_id: type: string - text_matches: *645 + text_matches: *652 required: - sha - node_id @@ -92394,7 +92768,7 @@ paths: - interactions - created - updated - - *646 + - *653 - *18 - *20 responses: @@ -92513,8 +92887,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *445 - required: *446 + properties: *452 + required: *453 nullable: true comments: type: integer @@ -92528,7 +92902,7 @@ paths: type: string format: date-time nullable: true - text_matches: *645 + text_matches: *652 pull_request: type: object properties: @@ -92561,7 +92935,7 @@ paths: type: string score: type: number - author_association: *109 + author_association: *121 draft: type: boolean repository: *57 @@ -92581,9 +92955,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 - reactions: *110 + properties: *119 + required: *120 + reactions: *122 required: - assignee - closed_at @@ -92699,7 +93073,7 @@ paths: locked: true author_association: COLLABORATOR state_reason: completed - '503': *100 + '503': *112 '422': *16 '304': *37 '403': *29 @@ -92752,7 +93126,7 @@ paths: enum: - created - updated - - *646 + - *653 - *18 - *20 responses: @@ -92796,7 +93170,7 @@ paths: nullable: true score: type: number - text_matches: *645 + text_matches: *652 required: - id - node_id @@ -92882,7 +93256,7 @@ paths: - forks - help-wanted-issues - updated - - *646 + - *653 - *18 - *20 responses: @@ -93101,8 +93475,8 @@ paths: title: License Simple description: License Simple type: object - properties: *123 - required: *124 + properties: *135 + required: *136 nullable: true permissions: type: object @@ -93121,7 +93495,7 @@ paths: - admin - pull - push - text_matches: *645 + text_matches: *652 temp_clone_token: type: string allow_merge_commit: @@ -93323,7 +93697,7 @@ paths: spdx_id: MIT node_id: MDc6TGljZW5zZW1pdA== html_url: https://api.github.com/licenses/mit - '503': *100 + '503': *112 '422': *16 '304': *37 x-github: @@ -93422,7 +93796,7 @@ paths: type: string format: uri nullable: true - text_matches: *645 + text_matches: *652 related: type: array nullable: true @@ -93615,7 +93989,7 @@ paths: - followers - repositories - joined - - *646 + - *653 - *18 - *20 responses: @@ -93719,7 +94093,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *645 + text_matches: *652 blog: type: string nullable: true @@ -93778,7 +94152,7 @@ paths: events_url: https://api.github.com/users/mojombo/events{/privacy} site_admin: true '304': *37 - '503': *100 + '503': *112 '422': *16 x-github: githubCloudOnly: false @@ -93798,7 +94172,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy parameters: - - &647 + - &654 name: team_id description: The unique identifier of the team. in: path @@ -93810,9 +94184,9 @@ paths: description: Response content: application/json: - schema: *306 + schema: *313 examples: - default: *307 + default: *314 '404': *7 x-github: githubCloudOnly: false @@ -93839,7 +94213,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy parameters: - - *647 + - *654 requestBody: required: true content: @@ -93902,16 +94276,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *306 + schema: *313 examples: - default: *307 + default: *314 '201': description: Response content: application/json: - schema: *306 + schema: *313 examples: - default: *307 + default: *314 '404': *7 '422': *16 '403': *29 @@ -93939,7 +94313,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy parameters: - - *647 + - *654 responses: '204': description: Response @@ -93970,7 +94344,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy parameters: - - *647 + - *654 - *78 - *18 - *20 @@ -93981,9 +94355,9 @@ paths: application/json: schema: type: array - items: *308 + items: *315 examples: - default: *648 + default: *655 headers: Link: *39 x-github: @@ -94012,7 +94386,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy parameters: - - *647 + - *654 requestBody: required: true content: @@ -94046,9 +94420,9 @@ paths: description: Response content: application/json: - schema: *308 + schema: *315 examples: - default: *309 + default: *316 x-github: triggersNotification: true githubCloudOnly: false @@ -94075,16 +94449,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy parameters: - - *647 - - *310 + - *654 + - *317 responses: '200': description: Response content: application/json: - schema: *308 + schema: *315 examples: - default: *309 + default: *316 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94109,8 +94483,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy parameters: - - *647 - - *310 + - *654 + - *317 requestBody: required: false content: @@ -94133,9 +94507,9 @@ paths: description: Response content: application/json: - schema: *308 + schema: *315 examples: - default: *649 + default: *656 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94160,8 +94534,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy parameters: - - *647 - - *310 + - *654 + - *317 responses: '204': description: Response @@ -94190,8 +94564,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *647 - - *310 + - *654 + - *317 - *78 - *18 - *20 @@ -94202,9 +94576,9 @@ paths: application/json: schema: type: array - items: *311 + items: *318 examples: - default: *650 + default: *657 headers: Link: *39 x-github: @@ -94233,8 +94607,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *647 - - *310 + - *654 + - *317 requestBody: required: true content: @@ -94256,9 +94630,9 @@ paths: description: Response content: application/json: - schema: *311 + schema: *318 examples: - default: *312 + default: *319 x-github: triggersNotification: true githubCloudOnly: false @@ -94285,17 +94659,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *647 - - *310 - - *313 + - *654 + - *317 + - *320 responses: '200': description: Response content: application/json: - schema: *311 + schema: *318 examples: - default: *312 + default: *319 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94320,9 +94694,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *647 - - *310 - - *313 + - *654 + - *317 + - *320 requestBody: required: true content: @@ -94344,9 +94718,9 @@ paths: description: Response content: application/json: - schema: *311 + schema: *318 examples: - default: *651 + default: *658 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94371,9 +94745,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *647 - - *310 - - *313 + - *654 + - *317 + - *320 responses: '204': description: Response @@ -94402,9 +94776,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: - - *647 - - *310 - - *313 + - *654 + - *317 + - *320 - 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. @@ -94430,9 +94804,9 @@ paths: application/json: schema: type: array - items: *314 + items: *321 examples: - default: *316 + default: *323 headers: Link: *39 x-github: @@ -94461,9 +94835,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: - - *647 - - *310 - - *313 + - *654 + - *317 + - *320 requestBody: required: true content: @@ -94495,9 +94869,9 @@ paths: description: Response content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94523,8 +94897,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: - - *647 - - *310 + - *654 + - *317 - 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. @@ -94550,9 +94924,9 @@ paths: application/json: schema: type: array - items: *314 + items: *321 examples: - default: *316 + default: *323 headers: Link: *39 x-github: @@ -94581,8 +94955,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: - - *647 - - *310 + - *654 + - *317 requestBody: required: true content: @@ -94614,9 +94988,9 @@ paths: description: Response content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -94640,7 +95014,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy parameters: - - *647 + - *654 - *18 - *20 responses: @@ -94650,9 +95024,9 @@ paths: application/json: schema: type: array - items: *240 + items: *252 examples: - default: *241 + default: *253 headers: Link: *39 x-github: @@ -94678,7 +95052,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy parameters: - - *647 + - *654 - name: role description: Filters members returned by their role in the team. in: query @@ -94701,7 +95075,7 @@ paths: type: array items: *19 examples: - default: *246 + default: *258 headers: Link: *39 '404': *7 @@ -94729,8 +95103,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy parameters: - - *647 - - *185 + - *654 + - *197 responses: '204': description: if user is a member @@ -94766,8 +95140,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy parameters: - - *647 - - *185 + - *654 + - *197 responses: '204': description: Response @@ -94806,8 +95180,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy parameters: - - *647 - - *185 + - *654 + - *197 responses: '204': description: Response @@ -94843,16 +95217,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: - - *647 - - *185 + - *654 + - *197 responses: '200': description: Response content: application/json: - schema: *322 + schema: *329 examples: - response-if-user-is-a-team-maintainer: *652 + response-if-user-is-a-team-maintainer: *659 '404': *7 x-github: githubCloudOnly: false @@ -94885,8 +95259,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: - - *647 - - *185 + - *654 + - *197 requestBody: required: false content: @@ -94911,9 +95285,9 @@ paths: description: Response content: application/json: - schema: *322 + schema: *329 examples: - response-if-users-membership-with-team-is-now-pending: *653 + response-if-users-membership-with-team-is-now-pending: *660 '403': description: Forbidden if team synchronization is set up '422': @@ -94947,8 +95321,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: - - *647 - - *185 + - *654 + - *197 responses: '204': description: Response @@ -94977,7 +95351,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects-legacy parameters: - - *647 + - *654 - *18 - *20 responses: @@ -94987,9 +95361,9 @@ paths: application/json: schema: type: array - items: *323 + items: *330 examples: - default: *654 + default: *661 headers: Link: *39 '404': *7 @@ -95016,16 +95390,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: - - *647 - - *324 + - *654 + - *331 responses: '200': description: Response content: application/json: - schema: *323 + schema: *330 examples: - default: *655 + default: *662 '404': description: Not Found if project is not managed by this team x-github: @@ -95050,8 +95424,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: - - *647 - - *324 + - *654 + - *331 requestBody: required: false content: @@ -95119,8 +95493,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: - - *647 - - *324 + - *654 + - *331 responses: '204': description: Response @@ -95147,7 +95521,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy parameters: - - *647 + - *654 - *18 - *20 responses: @@ -95157,9 +95531,9 @@ paths: application/json: schema: type: array - items: *163 + items: *175 examples: - default: *265 + default: *277 headers: Link: *39 '404': *7 @@ -95189,15 +95563,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: - - *647 - - *325 - - *326 + - *654 + - *332 + - *333 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *656 + schema: *663 examples: alternative-response-with-extra-repository-information: value: @@ -95348,9 +95722,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: - - *647 - - *325 - - *326 + - *654 + - *332 + - *333 requestBody: required: false content: @@ -95400,9 +95774,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: - - *647 - - *325 - - *326 + - *654 + - *332 + - *333 responses: '204': description: Response @@ -95431,15 +95805,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: - - *647 + - *654 responses: '200': description: Response content: application/json: - schema: *327 + schema: *334 examples: - default: *328 + default: *335 '403': *29 '404': *7 x-github: @@ -95466,7 +95840,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: - - *647 + - *654 requestBody: required: true content: @@ -95523,7 +95897,7 @@ paths: description: Response content: application/json: - schema: *327 + schema: *334 examples: default: value: @@ -95554,7 +95928,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy parameters: - - *647 + - *654 - *18 - *20 responses: @@ -95564,9 +95938,9 @@ paths: application/json: schema: type: array - items: *243 + items: *255 examples: - response-if-child-teams-exist: *657 + response-if-child-teams-exist: *664 headers: Link: *39 '404': *7 @@ -95599,7 +95973,7 @@ paths: application/json: schema: oneOf: - - &659 + - &666 title: Private User description: Private User type: object @@ -95802,7 +96176,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *658 + - *665 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -95955,7 +96329,7 @@ paths: description: Response content: application/json: - schema: *659 + schema: *666 examples: default: value: @@ -96034,7 +96408,7 @@ paths: type: array items: *19 examples: - default: *246 + default: *258 '304': *37 '404': *7 '403': *29 @@ -96057,7 +96431,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: - - *185 + - *197 responses: '204': description: If the user is blocked @@ -96085,7 +96459,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#block-a-user parameters: - - *185 + - *197 responses: '204': description: Response @@ -96109,7 +96483,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#unblock-a-user parameters: - - *185 + - *197 responses: '204': description: Response @@ -96158,9 +96532,9 @@ paths: type: integer codespaces: type: array - items: *247 + items: *259 examples: - default: *248 + default: *260 '304': *37 '500': *84 '401': *25 @@ -96299,21 +96673,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *247 + schema: *259 examples: - default: *430 + default: *437 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *247 + schema: *259 examples: - default: *430 + default: *437 '401': *25 '403': *29 '404': *7 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -96353,7 +96727,7 @@ paths: type: integer secrets: type: array - items: &660 + items: &667 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -96393,7 +96767,7 @@ paths: - visibility - selected_repositories_url examples: - default: *433 + default: *440 headers: Link: *39 x-github: @@ -96463,13 +96837,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: - - *173 + - *185 responses: '200': description: Response content: application/json: - schema: *660 + schema: *667 examples: default: value: @@ -96499,7 +96873,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: - - *173 + - *185 requestBody: required: true content: @@ -96544,7 +96918,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -96572,7 +96946,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: - - *173 + - *185 responses: '204': description: Response @@ -96597,7 +96971,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: - - *173 + - *185 responses: '200': description: Response @@ -96613,9 +96987,9 @@ paths: type: integer repositories: type: array - items: *163 + items: *175 examples: - default: *661 + default: *668 '401': *25 '403': *29 '404': *7 @@ -96640,7 +97014,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: - - *173 + - *185 requestBody: required: true content: @@ -96694,7 +97068,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: - - *173 + - *185 - name: repository_id in: path required: true @@ -96727,7 +97101,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: - - *173 + - *185 - name: repository_id in: path required: true @@ -96759,15 +97133,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: - - *249 + - *261 responses: '200': description: Response content: application/json: - schema: *247 + schema: *259 examples: - default: *430 + default: *437 '304': *37 '500': *84 '401': *25 @@ -96793,7 +97167,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: - - *249 + - *261 requestBody: required: false content: @@ -96823,9 +97197,9 @@ paths: description: Response content: application/json: - schema: *247 + schema: *259 examples: - default: *430 + default: *437 '401': *25 '403': *29 '404': *7 @@ -96847,9 +97221,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: - - *249 + - *261 responses: - '202': *151 + '202': *163 '304': *37 '500': *84 '401': *25 @@ -96876,13 +97250,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: - - *249 + - *261 responses: '202': description: Response content: application/json: - schema: &662 + schema: &669 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -96923,7 +97297,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &663 + default: &670 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -96955,7 +97329,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *249 + - *261 - name: export_id in: path required: true @@ -96968,9 +97342,9 @@ paths: description: Response content: application/json: - schema: *662 + schema: *669 examples: - default: *663 + default: *670 '404': *7 x-github: githubCloudOnly: false @@ -96991,7 +97365,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *249 + - *261 responses: '200': description: Response @@ -97007,9 +97381,9 @@ paths: type: integer machines: type: array - items: *664 + items: *671 examples: - default: *665 + default: *672 '304': *37 '500': *84 '401': *25 @@ -97038,7 +97412,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: - - *249 + - *261 requestBody: required: true content: @@ -97088,13 +97462,13 @@ paths: nullable: true owner: *19 billable_owner: *19 - repository: *338 + repository: *345 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *431 - required: *432 + properties: *438 + required: *439 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -97868,15 +98242,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: - - *249 + - *261 responses: '200': description: Response content: application/json: - schema: *247 + schema: *259 examples: - default: *430 + default: *437 '304': *37 '500': *84 '400': *15 @@ -97888,7 +98262,7 @@ paths: schema: *3 '403': *29 '404': *7 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -97908,15 +98282,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: - - *249 + - *261 responses: '200': description: Response content: application/json: - schema: *247 + schema: *259 examples: - default: *430 + default: *437 '500': *84 '401': *25 '403': *29 @@ -97946,9 +98320,9 @@ paths: application/json: schema: type: array - items: *259 + items: *271 examples: - default: &678 + default: &685 value: - id: 197 name: hello_docker @@ -98049,7 +98423,7 @@ paths: application/json: schema: type: array - items: &666 + items: &673 title: Email description: Email type: object @@ -98114,9 +98488,9 @@ paths: application/json: schema: type: array - items: *666 + items: *673 examples: - default: &680 + default: &687 value: - email: octocat@github.com verified: true @@ -98191,7 +98565,7 @@ paths: application/json: schema: type: array - items: *666 + items: *673 examples: default: value: @@ -98301,7 +98675,7 @@ paths: type: array items: *19 examples: - default: *246 + default: *258 headers: Link: *39 '304': *37 @@ -98334,7 +98708,7 @@ paths: type: array items: *19 examples: - default: *246 + default: *258 headers: Link: *39 '304': *37 @@ -98356,7 +98730,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: - - *185 + - *197 responses: '204': description: if the person is followed by the authenticated user @@ -98386,7 +98760,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#follow-a-user parameters: - - *185 + - *197 responses: '204': description: Response @@ -98411,7 +98785,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#unfollow-a-user parameters: - - *185 + - *197 responses: '204': description: Response @@ -98447,7 +98821,7 @@ paths: application/json: schema: type: array - items: &667 + items: &674 title: GPG Key description: A unique encryption key type: object @@ -98578,7 +98952,7 @@ paths: - subkeys - revoked examples: - default: &691 + default: &698 value: - id: 3 name: Octocat's GPG Key @@ -98663,9 +99037,9 @@ paths: description: Response content: application/json: - schema: *667 + schema: *674 examples: - default: &668 + default: &675 value: id: 3 name: Octocat's GPG Key @@ -98722,7 +99096,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: - - &669 + - &676 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -98734,9 +99108,9 @@ paths: description: Response content: application/json: - schema: *667 + schema: *674 examples: - default: *668 + default: *675 '404': *7 '304': *37 '403': *29 @@ -98759,7 +99133,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: - - *669 + - *676 responses: '204': description: Response @@ -98950,7 +99324,7 @@ paths: type: array items: *57 examples: - default: *670 + default: *677 headers: Link: *39 '404': *7 @@ -98975,7 +99349,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *23 - - *158 + - *170 responses: '204': description: Response @@ -99001,7 +99375,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *23 - - *158 + - *170 responses: '204': description: Response @@ -99035,12 +99409,12 @@ paths: application/json: schema: anyOf: - - *238 + - *250 - type: object properties: {} additionalProperties: false examples: - default: *239 + default: *251 '204': description: Response when there are no restrictions x-github: @@ -99064,7 +99438,7 @@ paths: required: true content: application/json: - schema: *504 + schema: *511 examples: default: value: @@ -99075,7 +99449,7 @@ paths: description: Response content: application/json: - schema: *238 + schema: *250 examples: default: value: @@ -99156,7 +99530,7 @@ paths: - closed - all default: open - - *244 + - *256 - name: sort description: What to sort results by. in: query @@ -99169,7 +99543,7 @@ paths: - comments default: created - *78 - - *112 + - *124 - *18 - *20 responses: @@ -99179,9 +99553,9 @@ paths: application/json: schema: type: array - items: *122 + items: *134 examples: - default: *245 + default: *257 headers: Link: *39 '404': *7 @@ -99214,7 +99588,7 @@ paths: application/json: schema: type: array - items: &671 + items: &678 title: Key description: Key type: object @@ -99311,9 +99685,9 @@ paths: description: Response content: application/json: - schema: *671 + schema: *678 examples: - default: &672 + default: &679 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -99346,15 +99720,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: - - *533 + - *540 responses: '200': description: Response content: application/json: - schema: *671 + schema: *678 examples: - default: *672 + default: *679 '404': *7 '304': *37 '403': *29 @@ -99377,7 +99751,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: - - *533 + - *540 responses: '204': description: Response @@ -99410,7 +99784,7 @@ paths: application/json: schema: type: array - items: &673 + items: &680 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -99467,7 +99841,7 @@ paths: - id - type - login - plan: *126 + plan: *138 required: - billing_cycle - next_billing_date @@ -99478,7 +99852,7 @@ paths: - account - plan examples: - default: &674 + default: &681 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -99540,9 +99914,9 @@ paths: application/json: schema: type: array - items: *673 + items: *680 examples: - default: *674 + default: *681 headers: Link: *39 '304': *37 @@ -99582,7 +99956,7 @@ paths: application/json: schema: type: array - items: *250 + items: *262 examples: default: value: @@ -99684,13 +100058,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: - - *145 + - *157 responses: '200': description: Response content: application/json: - schema: *250 + schema: *262 examples: default: value: @@ -99748,7 +100122,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: - - *145 + - *157 requestBody: required: true content: @@ -99773,7 +100147,7 @@ paths: description: Response content: application/json: - schema: *250 + schema: *262 examples: default: value: @@ -99841,7 +100215,7 @@ paths: application/json: schema: type: array - items: *252 + items: *264 examples: default: value: @@ -100094,7 +100468,7 @@ paths: description: Response content: application/json: - schema: *252 + schema: *264 examples: default: value: @@ -100274,7 +100648,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#get-a-user-migration-status parameters: - - *253 + - *265 - name: exclude in: query required: false @@ -100287,7 +100661,7 @@ paths: description: Response content: application/json: - schema: *252 + schema: *264 examples: default: value: @@ -100481,7 +100855,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive parameters: - - *253 + - *265 responses: '302': description: Response @@ -100507,7 +100881,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#delete-a-user-migration-archive parameters: - - *253 + - *265 responses: '204': description: Response @@ -100536,8 +100910,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository parameters: - - *253 - - *675 + - *265 + - *682 responses: '204': description: Response @@ -100561,7 +100935,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *253 + - *265 - *18 - *20 responses: @@ -100571,9 +100945,9 @@ paths: application/json: schema: type: array - items: *163 + items: *175 examples: - default: *265 + default: *277 headers: Link: *39 '404': *7 @@ -100610,7 +100984,7 @@ paths: type: array items: *52 examples: - default: *676 + default: *683 headers: Link: *39 '304': *37 @@ -100652,7 +101026,7 @@ paths: - docker - nuget - container - - *677 + - *684 - *20 - *18 responses: @@ -100662,10 +101036,10 @@ paths: application/json: schema: type: array - items: *259 + items: *271 examples: - default: *678 - '400': *679 + default: *685 + '400': *686 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100685,16 +101059,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: - - *261 - - *262 + - *273 + - *274 responses: '200': description: Response content: application/json: - schema: *259 + schema: *271 examples: - default: &692 + default: &699 value: id: 40201 name: octo-name @@ -100807,8 +101181,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: - - *261 - - *262 + - *273 + - *274 responses: '204': description: Response @@ -100838,8 +101212,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: - - *261 - - *262 + - *273 + - *274 - name: token description: package token schema: @@ -100871,8 +101245,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: - - *261 - - *262 + - *273 + - *274 - *20 - *18 - name: state @@ -100892,7 +101266,7 @@ paths: application/json: schema: type: array - items: *263 + items: *275 examples: default: value: @@ -100941,15 +101315,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: - - *261 - - *262 - - *264 + - *273 + - *274 + - *276 responses: '200': description: Response content: application/json: - schema: *263 + schema: *275 examples: default: value: @@ -100985,9 +101359,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: - - *261 - - *262 - - *264 + - *273 + - *274 + - *276 responses: '204': description: Response @@ -101017,9 +101391,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: - - *261 - - *262 - - *264 + - *273 + - *274 + - *276 responses: '204': description: Response @@ -101075,7 +101449,7 @@ paths: description: Response content: application/json: - schema: *272 + schema: *284 examples: default: value: @@ -101144,9 +101518,9 @@ paths: application/json: schema: type: array - items: *666 + items: *673 examples: - default: *680 + default: *687 headers: Link: *39 '304': *37 @@ -101259,7 +101633,7 @@ paths: type: array items: *57 examples: - default: &687 + default: &694 summary: Default response value: - id: 1296269 @@ -101561,9 +101935,9 @@ paths: description: Response content: application/json: - schema: *338 + schema: *345 examples: - default: *340 + default: *347 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -101601,9 +101975,9 @@ paths: application/json: schema: type: array - items: *506 + items: *513 examples: - default: *681 + default: *688 headers: Link: *39 '304': *37 @@ -101626,12 +102000,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *242 + - *254 responses: '204': description: Response '403': *29 - '409': *150 + '409': *162 '404': *7 '304': *37 x-github: @@ -101649,11 +102023,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *242 + - *254 responses: '204': description: Response - '409': *150 + '409': *162 '304': *37 '404': *7 '403': *29 @@ -101682,7 +102056,7 @@ paths: application/json: schema: type: array - items: &682 + items: &689 title: Social account description: Social media account type: object @@ -101697,7 +102071,7 @@ paths: - provider - url examples: - default: &683 + default: &690 value: - provider: twitter url: https://twitter.com/github @@ -101759,9 +102133,9 @@ paths: application/json: schema: type: array - items: *682 + items: *689 examples: - default: *683 + default: *690 '422': *16 '304': *37 '404': *7 @@ -101848,7 +102222,7 @@ paths: application/json: schema: type: array - items: &684 + items: &691 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -101868,7 +102242,7 @@ paths: - title - created_at examples: - default: &693 + default: &700 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -101934,9 +102308,9 @@ paths: description: Response content: application/json: - schema: *684 + schema: *691 examples: - default: &685 + default: &692 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -101967,7 +102341,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: - - &686 + - &693 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -101979,9 +102353,9 @@ paths: description: Response content: application/json: - schema: *684 + schema: *691 examples: - default: *685 + default: *692 '404': *7 '304': *37 '403': *29 @@ -102004,7 +102378,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: - - *686 + - *693 responses: '204': description: Response @@ -102033,7 +102407,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: - - &694 + - &701 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 @@ -102058,11 +102432,11 @@ paths: type: array items: *57 examples: - default-response: *687 + default-response: *694 application/vnd.github.v3.star+json: schema: type: array - items: &695 + items: &702 title: Starred Repository description: Starred Repository type: object @@ -102218,8 +102592,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: - - *325 - - *326 + - *332 + - *333 responses: '204': description: Response if this repository is starred by you @@ -102247,8 +102621,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: - - *325 - - *326 + - *332 + - *333 responses: '204': description: Response @@ -102272,8 +102646,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: - - *325 - - *326 + - *332 + - *333 responses: '204': description: Response @@ -102306,9 +102680,9 @@ paths: application/json: schema: type: array - items: *163 + items: *175 examples: - default: *265 + default: *277 headers: Link: *39 '304': *37 @@ -102345,7 +102719,7 @@ paths: application/json: schema: type: array - items: *306 + items: *313 examples: default: value: @@ -102421,7 +102795,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user-using-their-id parameters: - - *128 + - *140 responses: '200': description: Response @@ -102429,10 +102803,10 @@ paths: application/json: schema: oneOf: - - *659 - - *658 + - *666 + - *665 examples: - default-response: &689 + default-response: &696 summary: Default response value: login: octocat @@ -102467,7 +102841,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &690 + response-with-git-hub-plan-information: &697 summary: Response with GitHub plan information value: login: octocat @@ -102527,7 +102901,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users parameters: - - *688 + - *695 - *18 responses: '200': @@ -102538,7 +102912,7 @@ paths: type: array items: *19 examples: - default: *246 + default: *258 headers: Link: example: ; rel="next" @@ -102566,7 +102940,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user parameters: - - *185 + - *197 responses: '200': description: Response @@ -102574,11 +102948,11 @@ paths: application/json: schema: oneOf: - - *659 - - *658 + - *666 + - *665 examples: - default-response: *689 - response-with-git-hub-plan-information: *690 + default-response: *696 + response-with-git-hub-plan-information: *697 '404': *7 x-github: githubCloudOnly: false @@ -102604,7 +102978,7 @@ paths: - *18 - *76 - *77 - - *185 + - *197 - name: subject_digest description: Subject Digest in: path @@ -102697,6 +103071,8 @@ paths: type: string repository_id: type: integer + bundle_url: + type: string examples: default: value: @@ -102704,7 +103080,7 @@ paths: description: Response content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -102730,7 +103106,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: - - *185 + - *197 responses: '200': description: Response @@ -102738,9 +103114,9 @@ paths: application/json: schema: type: array - items: *259 + items: *271 examples: - default: *678 + default: *685 '403': *29 '401': *25 x-github: @@ -102763,7 +103139,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-for-the-authenticated-user parameters: - - *185 + - *197 - *18 - *20 responses: @@ -102773,7 +103149,7 @@ paths: application/json: schema: type: array - items: *134 + items: *146 examples: default: value: @@ -102844,8 +103220,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: - - *185 - - *145 + - *197 + - *157 - *18 - *20 responses: @@ -102855,7 +103231,7 @@ paths: application/json: schema: type: array - items: *134 + items: *146 examples: default: value: @@ -102934,7 +103310,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-user parameters: - - *185 + - *197 - *18 - *20 responses: @@ -102944,7 +103320,7 @@ paths: application/json: schema: type: array - items: *134 + items: *146 examples: default: value: @@ -103011,7 +103387,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-followers-of-a-user parameters: - - *185 + - *197 - *18 - *20 responses: @@ -103023,7 +103399,7 @@ paths: type: array items: *19 examples: - default: *246 + default: *258 headers: Link: *39 x-github: @@ -103042,7 +103418,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-the-people-a-user-follows parameters: - - *185 + - *197 - *18 - *20 responses: @@ -103054,7 +103430,7 @@ paths: type: array items: *19 examples: - default: *246 + default: *258 headers: Link: *39 x-github: @@ -103073,7 +103449,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: - - *185 + - *197 - name: target_user in: path required: true @@ -103100,8 +103476,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-a-user parameters: - - *185 - - *112 + - *197 + - *124 - *18 - *20 responses: @@ -103111,9 +103487,9 @@ paths: application/json: schema: type: array - items: *113 + items: *125 examples: - default: *114 + default: *126 headers: Link: *39 '422': *16 @@ -103134,7 +103510,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: - - *185 + - *197 - *18 - *20 responses: @@ -103144,9 +103520,9 @@ paths: application/json: schema: type: array - items: *667 + items: *674 examples: - default: *691 + default: *698 headers: Link: *39 x-github: @@ -103170,7 +103546,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-contextual-information-for-a-user parameters: - - *185 + - *197 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -103242,7 +103618,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: - - *185 + - *197 responses: '200': description: Response @@ -103250,7 +103626,7 @@ paths: application/json: schema: *22 examples: - default: *503 + default: *510 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -103268,7 +103644,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#list-public-keys-for-a-user parameters: - - *185 + - *197 - *18 - *20 responses: @@ -103316,7 +103692,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-a-user parameters: - - *185 + - *197 - *18 - *20 responses: @@ -103328,7 +103704,7 @@ paths: type: array items: *52 examples: - default: *676 + default: *683 headers: Link: *39 x-github: @@ -103367,8 +103743,8 @@ paths: - docker - nuget - container - - *677 - - *185 + - *684 + - *197 - *20 - *18 responses: @@ -103378,12 +103754,12 @@ paths: application/json: schema: type: array - items: *259 + items: *271 examples: - default: *678 + default: *685 '403': *29 '401': *25 - '400': *679 + '400': *686 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -103403,17 +103779,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-a-user parameters: - - *261 - - *262 - - *185 + - *273 + - *274 + - *197 responses: '200': description: Response content: application/json: - schema: *259 + schema: *271 examples: - default: *692 + default: *699 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -103434,9 +103810,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-a-user parameters: - - *261 - - *262 - - *185 + - *273 + - *274 + - *197 responses: '204': description: Response @@ -103468,9 +103844,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-a-user parameters: - - *261 - - *262 - - *185 + - *273 + - *274 + - *197 - name: token description: package token schema: @@ -103502,9 +103878,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: - - *261 - - *262 - - *185 + - *273 + - *274 + - *197 responses: '200': description: Response @@ -103512,7 +103888,7 @@ paths: application/json: schema: type: array - items: *263 + items: *275 examples: default: value: @@ -103570,16 +103946,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: - - *261 - - *262 - - *264 - - *185 + - *273 + - *274 + - *276 + - *197 responses: '200': description: Response content: application/json: - schema: *263 + schema: *275 examples: default: value: @@ -103614,10 +103990,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-a-user parameters: - - *261 - - *262 - - *185 - - *264 + - *273 + - *274 + - *197 + - *276 responses: '204': description: Response @@ -103649,10 +104025,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-a-user parameters: - - *261 - - *262 - - *185 - - *264 + - *273 + - *274 + - *197 + - *276 responses: '204': description: Response @@ -103675,7 +104051,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-user-projects parameters: - - *185 + - *197 - name: state description: Indicates the state of the projects to return. in: query @@ -103696,7 +104072,7 @@ paths: application/json: schema: type: array - items: *272 + items: *284 examples: default: value: @@ -103755,7 +104131,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: - - *185 + - *197 - *18 - *20 responses: @@ -103765,7 +104141,7 @@ paths: application/json: schema: type: array - items: *134 + items: *146 examples: default: value: @@ -103844,7 +104220,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: - - *185 + - *197 - *18 - *20 responses: @@ -103854,7 +104230,7 @@ paths: application/json: schema: type: array - items: *134 + items: *146 examples: default: value: @@ -103931,7 +104307,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repositories-for-a-user parameters: - - *185 + - *197 - name: type description: Limit results to repositories of the specified type. in: query @@ -103974,9 +104350,9 @@ paths: application/json: schema: type: array - items: *163 + items: *175 examples: - default: *265 + default: *277 headers: Link: *39 x-github: @@ -104000,15 +104376,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: - - *185 + - *197 responses: '200': description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: *299 + default: *306 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104030,15 +104406,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: - - *185 + - *197 responses: '200': description: Response content: application/json: - schema: *302 + schema: *309 examples: - default: *303 + default: *310 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104060,15 +104436,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: - - *185 + - *197 responses: '200': description: Response content: application/json: - schema: *304 + schema: *311 examples: - default: *305 + default: *312 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104086,7 +104462,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: - - *185 + - *197 - *18 - *20 responses: @@ -104096,9 +104472,9 @@ paths: application/json: schema: type: array - items: *682 + items: *689 examples: - default: *683 + default: *690 headers: Link: *39 x-github: @@ -104118,7 +104494,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: - - *185 + - *197 - *18 - *20 responses: @@ -104128,9 +104504,9 @@ paths: application/json: schema: type: array - items: *684 + items: *691 examples: - default: *693 + default: *700 headers: Link: *39 x-github: @@ -104154,8 +104530,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *185 - - *694 + - *197 + - *701 - *78 - *18 - *20 @@ -104167,11 +104543,11 @@ paths: schema: anyOf: - type: array - items: *695 + items: *702 - type: array items: *57 examples: - default-response: *687 + default-response: *694 headers: Link: *39 x-github: @@ -104190,7 +104566,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *185 + - *197 - *18 - *20 responses: @@ -104200,9 +104576,9 @@ paths: application/json: schema: type: array - items: *163 + items: *175 examples: - default: *265 + default: *277 headers: Link: *39 x-github: @@ -104330,7 +104706,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &696 + enterprise: &703 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -104388,7 +104764,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &697 + installation: &704 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -104407,7 +104783,7 @@ x-webhooks: required: - id - node_id - organization: &698 + organization: &705 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -104467,13 +104843,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &699 + repository: &706 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &736 + properties: &743 id: description: Unique identifier of the repository example: 42 @@ -104493,8 +104869,8 @@ x-webhooks: title: License Simple description: License Simple type: object - properties: *123 - required: *124 + properties: *135 + required: *136 nullable: true organization: title: Simple User @@ -105156,7 +105532,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &737 + required: &744 - archive_url - assignees_url - blobs_url @@ -105307,10 +105683,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -105386,11 +105762,11 @@ x-webhooks: type: string enum: - created - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 - rule: &700 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + rule: &707 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) @@ -105613,11 +105989,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 - rule: *700 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + rule: *707 sender: *19 required: - action @@ -105800,11 +106176,11 @@ x-webhooks: - everyone required: - from - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 - rule: *700 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + rule: *707 sender: *19 required: - action @@ -105877,7 +106253,7 @@ x-webhooks: required: true content: application/json: - schema: &703 + schema: &710 title: Exemption request cancellation event type: object properties: @@ -105885,11 +106261,11 @@ x-webhooks: type: string enum: - cancelled - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 - exemption_request: &701 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + exemption_request: &708 title: Exemption Request description: A request from a user to be exempted from a set of rules. @@ -106039,7 +106415,7 @@ x-webhooks: type: array description: The responses to the exemption request. nullable: true - items: &702 + items: &709 title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -106063,6 +106439,11 @@ x-webhooks: - approved - rejected - dismissed + reviewer_comment: + type: string + description: The comment the reviewer provided when responding + to the exemption request. + nullable: true created_at: type: string format: date-time @@ -106144,7 +106525,7 @@ x-webhooks: required: true content: application/json: - schema: &704 + schema: &711 title: Exemption request completed event type: object properties: @@ -106152,11 +106533,11 @@ x-webhooks: type: string enum: - completed - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 - exemption_request: *701 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + exemption_request: *708 sender: *19 required: - action @@ -106228,7 +106609,7 @@ x-webhooks: required: true content: application/json: - schema: &705 + schema: &712 title: Exemption request created event type: object properties: @@ -106236,11 +106617,11 @@ x-webhooks: type: string enum: - created - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 - exemption_request: *701 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + exemption_request: *708 sender: *19 required: - action @@ -106312,7 +106693,7 @@ x-webhooks: required: true content: application/json: - schema: &706 + schema: &713 title: Exemption response dismissed event type: object properties: @@ -106320,12 +106701,12 @@ x-webhooks: type: string enum: - response_dismissed - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 - exemption_request: *701 - exemption_response: *702 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + exemption_request: *708 + exemption_response: *709 sender: *19 required: - action @@ -106399,7 +106780,7 @@ x-webhooks: required: true content: application/json: - schema: &707 + schema: &714 title: Exemption response submitted event type: object properties: @@ -106407,12 +106788,12 @@ x-webhooks: type: string enum: - response_submitted - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 - exemption_request: *701 - exemption_response: *702 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + exemption_request: *708 + exemption_response: *709 sender: *19 required: - action @@ -106485,7 +106866,7 @@ x-webhooks: required: true content: application/json: - schema: *703 + schema: *710 responses: '200': description: Return a 200 status to indicate that the data was received @@ -106552,7 +106933,7 @@ x-webhooks: required: true content: application/json: - schema: *704 + schema: *711 responses: '200': description: Return a 200 status to indicate that the data was received @@ -106619,7 +107000,7 @@ x-webhooks: required: true content: application/json: - schema: *705 + schema: *712 responses: '200': description: Return a 200 status to indicate that the data was received @@ -106686,7 +107067,7 @@ x-webhooks: required: true content: application/json: - schema: *706 + schema: *713 responses: '200': description: Return a 200 status to indicate that the data was received @@ -106754,7 +107135,7 @@ x-webhooks: required: true content: application/json: - schema: *707 + schema: *714 responses: '200': description: Return a 200 status to indicate that the data was received @@ -106832,7 +107213,7 @@ x-webhooks: type: string enum: - completed - check_run: &709 + check_run: &716 title: CheckRun description: A check performed on the code of a given code change type: object @@ -106846,8 +107227,8 @@ x-webhooks: first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 check_suite: description: A suite of checks performed on the code of a given code change @@ -106895,8 +107276,8 @@ x-webhooks: type: string pull_requests: type: array - items: *395 - repository: *163 + items: *402 + repository: *175 status: example: completed type: string @@ -106933,7 +107314,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *708 + deployment: *715 details_url: example: https://example.com type: string @@ -106983,7 +107364,7 @@ x-webhooks: - annotations_url pull_requests: type: array - items: *395 + items: *402 started_at: example: '2018-05-04T01:14:52Z' type: string @@ -107018,9 +107399,9 @@ x-webhooks: - output - app - pull_requests - installation: *697 - organization: *698 - repository: *699 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - check_run @@ -107413,10 +107794,10 @@ x-webhooks: type: string enum: - created - check_run: *709 - installation: *697 - organization: *698 - repository: *699 + check_run: *716 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - check_run @@ -107812,10 +108193,10 @@ x-webhooks: type: string enum: - requested_action - check_run: *709 - installation: *697 - organization: *698 - repository: *699 + check_run: *716 + installation: *704 + organization: *705 + repository: *706 requested_action: description: The action requested by the user. type: object @@ -108220,10 +108601,10 @@ x-webhooks: type: string enum: - rerequested - check_run: *709 - installation: *697 - organization: *698 - repository: *699 + check_run: *716 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - check_run @@ -109200,10 +109581,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -109873,10 +110254,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -110540,10 +110921,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -110843,20 +111224,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &710 + commit_oid: &717 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: *696 - installation: *697 - organization: *698 - ref: &711 + enterprise: *703 + installation: *704 + organization: *705 + ref: &718 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: *699 + repository: *706 sender: *19 required: - action @@ -111174,12 +111555,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *710 - enterprise: *696 - installation: *697 - organization: *698 - ref: *711 - repository: *699 + commit_oid: *717 + enterprise: *703 + installation: *704 + organization: *705 + ref: *718 + repository: *706 sender: *19 required: - action @@ -111274,7 +111655,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *408 + dismissed_comment: *415 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -111436,12 +111817,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *710 - enterprise: *696 - installation: *697 - organization: *698 - ref: *711 - repository: *699 + commit_oid: *717 + enterprise: *703 + installation: *704 + organization: *705 + ref: *718 + repository: *706 sender: *19 required: - action @@ -111762,12 +112143,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *710 - enterprise: *696 - installation: *697 - organization: *698 - ref: *711 - repository: *699 + commit_oid: *717 + enterprise: *703 + installation: *704 + organization: *705 + ref: *718 + repository: *706 sender: *19 required: - action @@ -112024,16 +112405,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *699 + repository: *706 sender: *19 required: - action @@ -112259,12 +112640,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *710 - enterprise: *696 - installation: *697 - organization: *698 - ref: *711 - repository: *699 + commit_oid: *717 + enterprise: *703 + installation: *704 + organization: *705 + ref: *718 + repository: *706 sender: *19 required: - action @@ -112521,10 +112902,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -112604,18 +112985,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *698 - pusher_type: &712 + organization: *705 + pusher_type: &719 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &713 + ref: &720 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource. type: string @@ -112625,7 +113006,7 @@ x-webhooks: enum: - tag - branch - repository: *699 + repository: *706 sender: *19 required: - ref @@ -112708,9 +113089,9 @@ x-webhooks: enum: - created definition: *96 - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 sender: *19 required: - action @@ -112795,9 +113176,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 sender: *19 required: - action @@ -112875,9 +113256,9 @@ x-webhooks: enum: - updated definition: *96 - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 sender: *19 required: - action @@ -112954,19 +113335,19 @@ x-webhooks: type: string enum: - updated - enterprise: *696 - installation: *697 - repository: *699 - organization: *698 + enterprise: *703 + installation: *704 + repository: *706 + organization: *705 sender: *19 new_property_values: type: array description: The new custom property values for the repository. - items: *273 + items: *286 old_property_values: type: array description: The old custom property values for the repository. - items: *273 + items: *286 required: - action - repository @@ -113042,18 +113423,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *696 - installation: *697 - organization: *698 - pusher_type: *712 - ref: *713 + enterprise: *703 + installation: *704 + organization: *705 + pusher_type: *719 + ref: *720 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *699 + repository: *706 sender: *19 required: - ref @@ -113137,11 +113518,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *462 - installation: *697 - organization: *698 - enterprise: *696 - repository: *699 + alert: *469 + installation: *704 + organization: *705 + enterprise: *703 + repository: *706 sender: *19 required: - action @@ -113225,11 +113606,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *462 - installation: *697 - organization: *698 - enterprise: *696 - repository: *699 + alert: *469 + installation: *704 + organization: *705 + enterprise: *703 + repository: *706 sender: *19 required: - action @@ -113313,11 +113694,11 @@ x-webhooks: type: string enum: - created - alert: *462 - installation: *697 - organization: *698 - enterprise: *696 - repository: *699 + alert: *469 + installation: *704 + organization: *705 + enterprise: *703 + repository: *706 sender: *19 required: - action @@ -113399,11 +113780,11 @@ x-webhooks: type: string enum: - dismissed - alert: *462 - installation: *697 - organization: *698 - enterprise: *696 - repository: *699 + alert: *469 + installation: *704 + organization: *705 + enterprise: *703 + repository: *706 sender: *19 required: - action @@ -113485,11 +113866,11 @@ x-webhooks: type: string enum: - fixed - alert: *462 - installation: *697 - organization: *698 - enterprise: *696 - repository: *699 + alert: *469 + installation: *704 + organization: *705 + enterprise: *703 + repository: *706 sender: *19 required: - action @@ -113572,11 +113953,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *462 - installation: *697 - organization: *698 - enterprise: *696 - repository: *699 + alert: *469 + installation: *704 + organization: *705 + enterprise: *703 + repository: *706 sender: *19 required: - action @@ -113658,11 +114039,11 @@ x-webhooks: type: string enum: - reopened - alert: *462 - installation: *697 - organization: *698 - enterprise: *696 - repository: *699 + alert: *469 + installation: *704 + organization: *705 + enterprise: *703 + repository: *706 sender: *19 required: - action @@ -113739,9 +114120,9 @@ x-webhooks: type: string enum: - created - enterprise: *696 - installation: *697 - key: &714 + enterprise: *703 + installation: *704 + key: &721 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -113777,8 +114158,8 @@ x-webhooks: - verified - created_at - read_only - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 required: - action @@ -113855,11 +114236,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *696 - installation: *697 - key: *714 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + key: *721 + organization: *705 + repository: *706 sender: *19 required: - action @@ -114420,12 +114801,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 - workflow: &718 + workflow: &725 title: Workflow type: object nullable: true @@ -115151,13 +115532,13 @@ x-webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *468 + deployment: *475 pull_requests: type: array - items: *553 - repository: *699 - organization: *698 - installation: *697 + items: *560 + repository: *706 + organization: *705 + installation: *704 sender: *19 responses: '200': @@ -115228,7 +115609,7 @@ x-webhooks: type: string enum: - approved - approver: &715 + approver: &722 type: object properties: avatar_url: @@ -115271,11 +115652,11 @@ x-webhooks: type: string comment: type: string - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 - reviewers: &716 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + reviewers: &723 type: array items: type: object @@ -115354,7 +115735,7 @@ x-webhooks: sender: *19 since: type: string - workflow_job_run: &717 + workflow_job_run: &724 type: object properties: conclusion: @@ -116085,18 +116466,18 @@ x-webhooks: type: string enum: - rejected - approver: *715 + approver: *722 comment: type: string - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 - reviewers: *716 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + reviewers: *723 sender: *19 since: type: string - workflow_job_run: *717 + workflow_job_run: *724 workflow_job_runs: type: array items: @@ -116800,13 +117181,13 @@ x-webhooks: type: string enum: - requested - enterprise: *696 + enterprise: *703 environment: type: string - installation: *697 - organization: *698 - repository: *699 - requestor: &723 + installation: *704 + organization: *705 + repository: *706 + requestor: &730 title: User type: object nullable: true @@ -118705,12 +119086,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 - workflow: *718 + workflow: *725 workflow_run: title: Deployment Workflow Run type: object @@ -119390,7 +119771,7 @@ x-webhooks: type: string enum: - answered - answer: &721 + answer: &728 type: object properties: author_association: @@ -119547,7 +119928,7 @@ x-webhooks: - created_at - updated_at - body - discussion: &719 + discussion: &726 title: Discussion description: A Discussion in a repository. type: object @@ -119833,7 +120214,7 @@ x-webhooks: - id labels: type: array - items: *515 + items: *522 required: - repository_url - category @@ -119855,10 +120236,10 @@ x-webhooks: - author_association - active_lock_reason - body - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -119985,11 +120366,11 @@ x-webhooks: - from required: - category - discussion: *719 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + discussion: *726 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -120072,11 +120453,11 @@ x-webhooks: type: string enum: - closed - discussion: *719 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + discussion: *726 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -120158,7 +120539,7 @@ x-webhooks: type: string enum: - created - comment: &720 + comment: &727 type: object properties: author_association: @@ -120315,11 +120696,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *719 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + discussion: *726 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -120402,12 +120783,12 @@ x-webhooks: type: string enum: - deleted - comment: *720 - discussion: *719 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + comment: *727 + discussion: *726 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -120502,12 +120883,12 @@ x-webhooks: - from required: - body - comment: *720 - discussion: *719 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + comment: *727 + discussion: *726 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -120591,11 +120972,11 @@ x-webhooks: type: string enum: - created - discussion: *719 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + discussion: *726 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -120677,11 +121058,11 @@ x-webhooks: type: string enum: - deleted - discussion: *719 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + discussion: *726 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -120781,11 +121162,11 @@ x-webhooks: type: string required: - from - discussion: *719 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + discussion: *726 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -120867,10 +121248,10 @@ x-webhooks: type: string enum: - labeled - discussion: *719 - enterprise: *696 - installation: *697 - label: &722 + discussion: *726 + enterprise: *703 + installation: *704 + label: &729 title: Label type: object properties: @@ -120902,8 +121283,8 @@ x-webhooks: - color - default - description - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 required: - action @@ -120986,11 +121367,11 @@ x-webhooks: type: string enum: - locked - discussion: *719 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + discussion: *726 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -121072,11 +121453,11 @@ x-webhooks: type: string enum: - pinned - discussion: *719 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + discussion: *726 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -121158,11 +121539,11 @@ x-webhooks: type: string enum: - reopened - discussion: *719 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + discussion: *726 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -121247,16 +121628,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *719 - new_repository: *699 + new_discussion: *726 + new_repository: *706 required: - new_discussion - new_repository - discussion: *719 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + discussion: *726 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -121339,10 +121720,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *719 - old_answer: *721 - organization: *698 - repository: *699 + discussion: *726 + old_answer: *728 + organization: *705 + repository: *706 sender: *19 required: - action @@ -121424,12 +121805,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *719 - enterprise: *696 - installation: *697 - label: *722 - organization: *698 - repository: *699 + discussion: *726 + enterprise: *703 + installation: *704 + label: *729 + organization: *705 + repository: *706 sender: *19 required: - action @@ -121512,11 +121893,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *719 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + discussion: *726 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -121598,11 +121979,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *719 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + discussion: *726 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -121675,7 +122056,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *696 + enterprise: *703 forkee: description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) resource. @@ -122335,9 +122716,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *697 - organization: *698 - repository: *699 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - forkee @@ -122483,9 +122864,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 pages: description: The pages that were updated. type: array @@ -122522,7 +122903,7 @@ x-webhooks: - action - sha - html_url - repository: *699 + repository: *706 sender: *19 required: - pages @@ -122598,10 +122979,10 @@ x-webhooks: type: string enum: - created - enterprise: *696 + enterprise: *703 installation: *22 - organization: *698 - repositories: &724 + organization: *705 + repositories: &731 description: An array of repository objects that the installation can access. type: array @@ -122627,8 +123008,8 @@ x-webhooks: - name - full_name - private - repository: *699 - requester: *723 + repository: *706 + requester: *730 sender: *19 required: - action @@ -122703,11 +123084,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *696 + enterprise: *703 installation: *22 - organization: *698 - repositories: *724 - repository: *699 + organization: *705 + repositories: *731 + repository: *706 requester: nullable: true sender: *19 @@ -122783,11 +123164,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *696 + enterprise: *703 installation: *22 - organization: *698 - repositories: *724 - repository: *699 + organization: *705 + repositories: *731 + repository: *706 requester: nullable: true sender: *19 @@ -122863,10 +123244,10 @@ x-webhooks: type: string enum: - added - enterprise: *696 + enterprise: *703 installation: *22 - organization: *698 - repositories_added: &725 + organization: *705 + repositories_added: &732 description: An array of repository objects, which were added to the installation. type: array @@ -122912,15 +123293,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *699 - repository_selection: &726 + repository: *706 + repository_selection: &733 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *723 + requester: *730 sender: *19 required: - action @@ -122999,10 +123380,10 @@ x-webhooks: type: string enum: - removed - enterprise: *696 + enterprise: *703 installation: *22 - organization: *698 - repositories_added: *725 + organization: *705 + repositories_added: *732 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -123029,9 +123410,9 @@ x-webhooks: - name - full_name - private - repository: *699 - repository_selection: *726 - requester: *723 + repository: *706 + repository_selection: *733 + requester: *730 sender: *19 required: - action @@ -123110,11 +123491,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *696 + enterprise: *703 installation: *22 - organization: *698 - repositories: *724 - repository: *699 + organization: *705 + repositories: *731 + repository: *706 requester: nullable: true sender: *19 @@ -123293,10 +123674,10 @@ x-webhooks: type: string required: - from - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 target_type: type: string @@ -123375,11 +123756,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *696 + enterprise: *703 installation: *22 - organization: *698 - repositories: *724 - repository: *699 + organization: *705 + repositories: *731 + repository: *706 requester: nullable: true sender: *19 @@ -123503,8 +123884,8 @@ x-webhooks: first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 reactions: title: Reactions type: object @@ -123631,8 +124012,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -124787,8 +125168,8 @@ x-webhooks: - state - locked - assignee - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 required: - action @@ -124868,7 +125249,7 @@ x-webhooks: type: string enum: - deleted - comment: &727 + comment: &734 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself. @@ -125033,8 +125414,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -126187,8 +126568,8 @@ x-webhooks: - state - locked - assignee - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 required: - action @@ -126268,7 +126649,7 @@ x-webhooks: type: string enum: - edited - changes: &755 + changes: &762 description: The changes to the comment. type: object properties: @@ -126280,9 +126661,9 @@ x-webhooks: type: string required: - from - comment: *727 - enterprise: *696 - installation: *697 + comment: *734 + enterprise: *703 + installation: *704 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -127436,8 +127817,8 @@ x-webhooks: - state - locked - assignee - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 required: - action @@ -127519,10 +127900,10 @@ x-webhooks: type: string enum: - assigned - assignee: *723 - enterprise: *696 - installation: *697 - issue: &730 + assignee: *730 + enterprise: *703 + installation: *704 + issue: &737 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -128440,8 +128821,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 required: - action @@ -128521,8 +128902,8 @@ x-webhooks: type: string enum: - closed - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -129580,8 +129961,8 @@ x-webhooks: required: - state - closed_at - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 required: - action @@ -129660,8 +130041,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -130572,8 +130953,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 required: - action @@ -130652,8 +131033,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -131567,7 +131948,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &728 + milestone: &735 title: Milestone description: A collection of related issues and pull requests. type: object @@ -131705,8 +132086,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 required: - action @@ -131805,8 +132186,8 @@ x-webhooks: type: string required: - from - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -132724,9 +133105,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *722 - organization: *698 - repository: *699 + label: *729 + organization: *705 + repository: *706 sender: *19 required: - action @@ -132806,8 +133187,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -133724,9 +134105,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *722 - organization: *698 - repository: *699 + label: *729 + organization: *705 + repository: *706 sender: *19 required: - action @@ -133806,8 +134187,8 @@ x-webhooks: type: string enum: - locked - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -134725,8 +135106,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 required: - action @@ -134805,8 +135186,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -135718,9 +136099,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *728 - organization: *698 - repository: *699 + milestone: *735 + organization: *705 + repository: *706 sender: *19 required: - action @@ -137181,8 +137562,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -138099,8 +138480,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 required: - action @@ -138180,9 +138561,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *696 - installation: *697 - issue: &729 + enterprise: *703 + installation: *704 + issue: &736 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -139093,8 +139474,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 required: - action @@ -139173,8 +139554,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -140091,8 +140472,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 required: - action @@ -141554,11 +141935,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *696 - installation: *697 - issue: *729 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + issue: *736 + organization: *705 + repository: *706 sender: *19 required: - action @@ -141639,7 +142020,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &758 + assignee: &765 title: User type: object nullable: true @@ -141709,11 +142090,11 @@ x-webhooks: required: - login - id - enterprise: *696 - installation: *697 - issue: *730 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + issue: *737 + organization: *705 + repository: *706 sender: *19 required: - action @@ -141792,12 +142173,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *696 - installation: *697 - issue: *730 - label: *722 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + issue: *737 + label: *729 + organization: *705 + repository: *706 sender: *19 required: - action @@ -141877,8 +142258,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -142794,8 +143175,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 required: - action @@ -142875,11 +143256,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *696 - installation: *697 - issue: *729 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + issue: *736 + organization: *705 + repository: *706 sender: *19 required: - action @@ -142958,11 +143339,11 @@ x-webhooks: type: string enum: - created - enterprise: *696 - installation: *697 - label: *722 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + label: *729 + organization: *705 + repository: *706 sender: *19 required: - action @@ -143040,11 +143421,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *696 - installation: *697 - label: *722 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + label: *729 + organization: *705 + repository: *706 sender: *19 required: - action @@ -143154,11 +143535,11 @@ x-webhooks: type: string required: - from - enterprise: *696 - installation: *697 - label: *722 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + label: *729 + organization: *705 + repository: *706 sender: *19 required: - action @@ -143240,9 +143621,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *696 - installation: *697 - marketplace_purchase: &731 + enterprise: *703 + installation: *704 + marketplace_purchase: &738 title: Marketplace Purchase type: object required: @@ -143325,8 +143706,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *698 - previous_marketplace_purchase: &732 + organization: *705 + previous_marketplace_purchase: &739 title: Marketplace Purchase type: object properties: @@ -143406,7 +143787,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *699 + repository: *706 sender: *19 required: - action @@ -143486,10 +143867,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *696 - installation: *697 - marketplace_purchase: *731 - organization: *698 + enterprise: *703 + installation: *704 + marketplace_purchase: *738 + organization: *705 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -143572,7 +143953,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *699 + repository: *706 sender: *19 required: - action @@ -143654,10 +144035,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *696 - installation: *697 - marketplace_purchase: *731 - organization: *698 + enterprise: *703 + installation: *704 + marketplace_purchase: *738 + organization: *705 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -143739,7 +144120,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *699 + repository: *706 sender: *19 required: - action @@ -143820,8 +144201,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 marketplace_purchase: title: Marketplace Purchase type: object @@ -143903,9 +144284,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *698 - previous_marketplace_purchase: *732 - repository: *699 + organization: *705 + previous_marketplace_purchase: *739 + repository: *706 sender: *19 required: - action @@ -143985,12 +144366,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *696 - installation: *697 - marketplace_purchase: *731 - organization: *698 - previous_marketplace_purchase: *732 - repository: *699 + enterprise: *703 + installation: *704 + marketplace_purchase: *738 + organization: *705 + previous_marketplace_purchase: *739 + repository: *706 sender: *19 required: - action @@ -144092,11 +144473,11 @@ x-webhooks: type: string required: - to - enterprise: *696 - installation: *697 - member: *723 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + member: *730 + organization: *705 + repository: *706 sender: *19 required: - action @@ -144196,11 +144577,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *696 - installation: *697 - member: *723 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + member: *730 + organization: *705 + repository: *706 sender: *19 required: - action @@ -144279,11 +144660,11 @@ x-webhooks: type: string enum: - removed - enterprise: *696 - installation: *697 - member: *723 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + member: *730 + organization: *705 + repository: *706 sender: *19 required: - action @@ -144361,11 +144742,11 @@ x-webhooks: type: string enum: - added - enterprise: *696 - installation: *697 - member: *723 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + member: *730 + organization: *705 + repository: *706 scope: description: The scope of the membership. Currently, can only be `team`. @@ -144441,7 +144822,7 @@ x-webhooks: required: - login - id - team: &733 + team: &740 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -144631,11 +145012,11 @@ x-webhooks: type: string enum: - removed - enterprise: *696 - installation: *697 - member: *723 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + member: *730 + organization: *705 + repository: *706 scope: description: The scope of the membership. Currently, can only be `team`. @@ -144712,7 +145093,7 @@ x-webhooks: required: - login - id - team: *733 + team: *740 required: - action - scope @@ -144794,8 +145175,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *697 - merge_group: &735 + installation: *704 + merge_group: &742 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -144814,15 +145195,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *734 + head_commit: *741 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 required: - action @@ -144908,10 +145289,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *697 - merge_group: *735 - organization: *698 - repository: *699 + installation: *704 + merge_group: *742 + organization: *705 + repository: *706 sender: *19 required: - action @@ -144984,7 +145365,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *696 + enterprise: *703 hook: description: 'The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -145092,16 +145473,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *697 - organization: *698 + installation: *704 + organization: *705 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *736 - required: *737 + properties: *743 + required: *744 nullable: true sender: *19 required: @@ -145182,11 +145563,11 @@ x-webhooks: type: string enum: - closed - enterprise: *696 - installation: *697 - milestone: *728 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + milestone: *735 + organization: *705 + repository: *706 sender: *19 required: - action @@ -145265,9 +145646,9 @@ x-webhooks: type: string enum: - created - enterprise: *696 - installation: *697 - milestone: &738 + enterprise: *703 + installation: *704 + milestone: &745 title: Milestone description: A collection of related issues and pull requests. type: object @@ -145404,8 +145785,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 required: - action @@ -145484,11 +145865,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *696 - installation: *697 - milestone: *728 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + milestone: *735 + organization: *705 + repository: *706 sender: *19 required: - action @@ -145598,11 +145979,11 @@ x-webhooks: type: string required: - from - enterprise: *696 - installation: *697 - milestone: *728 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + milestone: *735 + organization: *705 + repository: *706 sender: *19 required: - action @@ -145682,11 +146063,11 @@ x-webhooks: type: string enum: - opened - enterprise: *696 - installation: *697 - milestone: *738 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + milestone: *745 + organization: *705 + repository: *706 sender: *19 required: - action @@ -145765,11 +146146,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *723 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + blocked_user: *730 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -145848,11 +146229,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *723 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + blocked_user: *730 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -145931,9 +146312,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *696 - installation: *697 - membership: &739 + enterprise: *703 + installation: *704 + membership: &746 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -146025,8 +146406,8 @@ x-webhooks: - role - organization_url - user - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 required: - action @@ -146104,11 +146485,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *696 - installation: *697 - membership: *739 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + membership: *746 + organization: *705 + repository: *706 sender: *19 required: - action @@ -146187,8 +146568,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -146304,10 +146685,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 - user: *723 + user: *730 required: - action - invitation @@ -146385,11 +146766,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *696 - installation: *697 - membership: *739 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + membership: *746 + organization: *705 + repository: *706 sender: *19 required: - action @@ -146476,11 +146857,11 @@ x-webhooks: properties: from: type: string - enterprise: *696 - installation: *697 - membership: *739 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + membership: *746 + organization: *705 + repository: *706 sender: *19 required: - action @@ -146556,9 +146937,9 @@ x-webhooks: type: string enum: - published - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 package: description: Information about the package. type: object @@ -147057,7 +147438,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &740 + items: &747 title: Ruby Gems metadata type: object properties: @@ -147152,7 +147533,7 @@ x-webhooks: - owner - package_version - registry - repository: *699 + repository: *706 sender: *19 required: - action @@ -147228,9 +147609,9 @@ x-webhooks: type: string enum: - updated - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 package: description: Information about the package. type: object @@ -147583,7 +147964,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *740 + items: *747 source_url: type: string format: uri @@ -147653,7 +148034,7 @@ x-webhooks: - owner - package_version - registry - repository: *699 + repository: *706 sender: *19 required: - action @@ -147830,12 +148211,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *696 + enterprise: *703 id: type: integer - installation: *697 - organization: *698 - repository: *699 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - id @@ -147915,7 +148296,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &741 + personal_access_token_request: &748 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -148061,10 +148442,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *696 - organization: *698 + enterprise: *703 + organization: *705 sender: *19 - installation: *697 + installation: *704 required: - action - personal_access_token_request @@ -148143,11 +148524,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *741 - enterprise: *696 - organization: *698 + personal_access_token_request: *748 + enterprise: *703 + organization: *705 sender: *19 - installation: *697 + installation: *704 required: - action - personal_access_token_request @@ -148225,11 +148606,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *741 - enterprise: *696 - organization: *698 + personal_access_token_request: *748 + enterprise: *703 + organization: *705 sender: *19 - installation: *697 + installation: *704 required: - action - personal_access_token_request @@ -148306,11 +148687,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *741 - organization: *698 - enterprise: *696 + personal_access_token_request: *748 + organization: *705 + enterprise: *703 sender: *19 - installation: *697 + installation: *704 required: - action - personal_access_token_request @@ -148414,7 +148795,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *742 + last_response: *749 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -148446,8 +148827,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 zen: description: Random string of GitHub zen. @@ -148692,10 +149073,10 @@ x-webhooks: - from required: - note - enterprise: *696 - installation: *697 - organization: *698 - project_card: &743 + enterprise: *703 + installation: *704 + organization: *705 + project_card: &750 title: Project Card type: object properties: @@ -148814,7 +149195,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *699 + repository: *706 sender: *19 required: - action @@ -148895,11 +149276,11 @@ x-webhooks: type: string enum: - created - enterprise: *696 - installation: *697 - organization: *698 - project_card: *743 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + project_card: *750 + repository: *706 sender: *19 required: - action @@ -148979,9 +149360,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 project_card: title: Project Card type: object @@ -149109,8 +149490,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *736 - required: *737 + properties: *743 + required: *744 nullable: true sender: *19 required: @@ -149204,11 +149585,11 @@ x-webhooks: - from required: - note - enterprise: *696 - installation: *697 - organization: *698 - project_card: *743 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + project_card: *750 + repository: *706 sender: *19 required: - action @@ -149302,9 +149683,9 @@ x-webhooks: - from required: - column_id - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 project_card: allOf: - title: Project Card @@ -149494,7 +149875,7 @@ x-webhooks: type: string required: - after_id - repository: *699 + repository: *706 sender: *19 required: - action @@ -149574,10 +149955,10 @@ x-webhooks: type: string enum: - closed - enterprise: *696 - installation: *697 - organization: *698 - project: &745 + enterprise: *703 + installation: *704 + organization: *705 + project: &752 title: Project type: object properties: @@ -149701,7 +150082,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *699 + repository: *706 sender: *19 required: - action @@ -149781,10 +150162,10 @@ x-webhooks: type: string enum: - created - enterprise: *696 - installation: *697 - organization: *698 - project_column: &744 + enterprise: *703 + installation: *704 + organization: *705 + project_column: &751 title: Project Column type: object properties: @@ -149823,7 +150204,7 @@ x-webhooks: - name - created_at - updated_at - repository: *699 + repository: *706 sender: *19 required: - action @@ -149902,18 +150283,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *696 - installation: *697 - organization: *698 - project_column: *744 + enterprise: *703 + installation: *704 + organization: *705 + project_column: *751 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *736 - required: *737 + properties: *743 + required: *744 nullable: true sender: *19 required: @@ -150003,11 +150384,11 @@ x-webhooks: type: string required: - from - enterprise: *696 - installation: *697 - organization: *698 - project_column: *744 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + project_column: *751 + repository: *706 sender: *19 required: - action @@ -150087,11 +150468,11 @@ x-webhooks: type: string enum: - moved - enterprise: *696 - installation: *697 - organization: *698 - project_column: *744 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + project_column: *751 + repository: *706 sender: *19 required: - action @@ -150171,11 +150552,11 @@ x-webhooks: type: string enum: - created - enterprise: *696 - installation: *697 - organization: *698 - project: *745 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + project: *752 + repository: *706 sender: *19 required: - action @@ -150255,18 +150636,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *696 - installation: *697 - organization: *698 - project: *745 + enterprise: *703 + installation: *704 + organization: *705 + project: *752 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *736 - required: *737 + properties: *743 + required: *744 nullable: true sender: *19 required: @@ -150368,11 +150749,11 @@ x-webhooks: type: string required: - from - enterprise: *696 - installation: *697 - organization: *698 - project: *745 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + project: *752 + repository: *706 sender: *19 required: - action @@ -150451,11 +150832,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *696 - installation: *697 - organization: *698 - project: *745 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + project: *752 + repository: *706 sender: *19 required: - action @@ -150536,9 +150917,9 @@ x-webhooks: type: string enum: - closed - installation: *697 - organization: *698 - projects_v2: &746 + installation: *704 + organization: *705 + projects_v2: &753 title: Projects v2 Project description: A projects v2 project type: object @@ -150681,9 +151062,9 @@ x-webhooks: type: string enum: - created - installation: *697 - organization: *698 - projects_v2: *746 + installation: *704 + organization: *705 + projects_v2: *753 sender: *19 required: - action @@ -150764,9 +151145,9 @@ x-webhooks: type: string enum: - deleted - installation: *697 - organization: *698 - projects_v2: *746 + installation: *704 + organization: *705 + projects_v2: *753 sender: *19 required: - action @@ -150883,9 +151264,9 @@ x-webhooks: type: string to: type: string - installation: *697 - organization: *698 - projects_v2: *746 + installation: *704 + organization: *705 + projects_v2: *753 sender: *19 required: - action @@ -150968,7 +151349,7 @@ x-webhooks: type: string enum: - archived - changes: &750 + changes: &757 type: object properties: archived_at: @@ -150982,9 +151363,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *697 - organization: *698 - projects_v2_item: &747 + installation: *704 + organization: *705 + projects_v2_item: &754 title: Projects v2 Item description: An item belonging to a project type: object @@ -151118,9 +151499,9 @@ x-webhooks: nullable: true to: type: string - installation: *697 - organization: *698 - projects_v2_item: *747 + installation: *704 + organization: *705 + projects_v2_item: *754 sender: *19 required: - action @@ -151202,9 +151583,9 @@ x-webhooks: type: string enum: - created - installation: *697 - organization: *698 - projects_v2_item: *747 + installation: *704 + organization: *705 + projects_v2_item: *754 sender: *19 required: - action @@ -151285,9 +151666,9 @@ x-webhooks: type: string enum: - deleted - installation: *697 - organization: *698 - projects_v2_item: *747 + installation: *704 + organization: *705 + projects_v2_item: *754 sender: *19 required: - action @@ -151393,7 +151774,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &748 + - &755 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -151411,7 +151792,7 @@ x-webhooks: required: - id - name - - &749 + - &756 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -151434,8 +151815,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *748 - - *749 + - *755 + - *756 required: - field_value - type: object @@ -151451,9 +151832,9 @@ x-webhooks: nullable: true required: - body - installation: *697 - organization: *698 - projects_v2_item: *747 + installation: *704 + organization: *705 + projects_v2_item: *754 sender: *19 required: - action @@ -151548,9 +151929,9 @@ x-webhooks: to: type: string nullable: true - installation: *697 - organization: *698 - projects_v2_item: *747 + installation: *704 + organization: *705 + projects_v2_item: *754 sender: *19 required: - action @@ -151633,10 +152014,10 @@ x-webhooks: type: string enum: - restored - changes: *750 - installation: *697 - organization: *698 - projects_v2_item: *747 + changes: *757 + installation: *704 + organization: *705 + projects_v2_item: *754 sender: *19 required: - action @@ -151718,9 +152099,9 @@ x-webhooks: type: string enum: - reopened - installation: *697 - organization: *698 - projects_v2: *746 + installation: *704 + organization: *705 + projects_v2: *753 sender: *19 required: - action @@ -151801,9 +152182,9 @@ x-webhooks: type: string enum: - created - installation: *697 - organization: *698 - projects_v2_status_update: &751 + installation: *704 + organization: *705 + projects_v2_status_update: &758 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -151930,9 +152311,9 @@ x-webhooks: type: string enum: - deleted - installation: *697 - organization: *698 - projects_v2_status_update: *751 + installation: *704 + organization: *705 + projects_v2_status_update: *758 sender: *19 required: - action @@ -152068,9 +152449,9 @@ x-webhooks: type: string format: date nullable: true - installation: *697 - organization: *698 - projects_v2_status_update: *751 + installation: *704 + organization: *705 + projects_v2_status_update: *758 sender: *19 required: - action @@ -152141,10 +152522,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - repository @@ -152221,13 +152602,13 @@ x-webhooks: type: string enum: - assigned - assignee: *723 - enterprise: *696 - installation: *697 - number: &752 + assignee: *730 + enterprise: *703 + installation: *704 + number: &759 description: The pull request number. type: integer - organization: *698 + organization: *705 pull_request: title: Pull Request type: object @@ -154510,7 +154891,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *699 + repository: *706 sender: *19 required: - action @@ -154592,11 +154973,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 number: type: integer - organization: *698 + organization: *705 pull_request: title: Pull Request type: object @@ -156874,7 +157255,7 @@ x-webhooks: - draft reason: type: string - repository: *699 + repository: *706 sender: *19 required: - action @@ -156956,11 +157337,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 number: type: integer - organization: *698 + organization: *705 pull_request: title: Pull Request type: object @@ -159238,7 +159619,7 @@ x-webhooks: - draft reason: type: string - repository: *699 + repository: *706 sender: *19 required: - action @@ -159320,13 +159701,13 @@ x-webhooks: type: string enum: - closed - enterprise: *696 - installation: *697 - number: *752 - organization: *698 - pull_request: &753 + enterprise: *703 + installation: *704 + number: *759 + organization: *705 + pull_request: &760 allOf: - - *553 + - *560 - type: object properties: allow_auto_merge: @@ -159388,7 +159769,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *699 + repository: *706 sender: *19 required: - action @@ -159469,12 +159850,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *696 - installation: *697 - number: *752 - organization: *698 - pull_request: *753 - repository: *699 + enterprise: *703 + installation: *704 + number: *759 + organization: *705 + pull_request: *760 + repository: *706 sender: *19 required: - action @@ -159554,11 +159935,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *696 - milestone: *536 - number: *752 - organization: *698 - pull_request: &754 + enterprise: *703 + milestone: *543 + number: *759 + organization: *705 + pull_request: &761 title: Pull Request type: object properties: @@ -161821,7 +162202,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *699 + repository: *706 sender: *19 required: - action @@ -161900,11 +162281,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 number: type: integer - organization: *698 + organization: *705 pull_request: title: Pull Request type: object @@ -164186,7 +164567,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *699 + repository: *706 sender: *19 required: - action @@ -164310,12 +164691,12 @@ x-webhooks: type: string required: - from - enterprise: *696 - installation: *697 - number: *752 - organization: *698 - pull_request: *753 - repository: *699 + enterprise: *703 + installation: *704 + number: *759 + organization: *705 + pull_request: *760 + repository: *706 sender: *19 required: - action @@ -164395,11 +164776,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 number: type: integer - organization: *698 + organization: *705 pull_request: title: Pull Request type: object @@ -166666,7 +167047,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *699 + repository: *706 sender: *19 required: - action @@ -166746,11 +167127,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *696 - installation: *697 - label: *722 - number: *752 - organization: *698 + enterprise: *703 + installation: *704 + label: *729 + number: *759 + organization: *705 pull_request: title: Pull Request type: object @@ -169032,7 +169413,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *699 + repository: *706 sender: *19 required: - action @@ -169113,10 +169494,10 @@ x-webhooks: type: string enum: - locked - enterprise: *696 - installation: *697 - number: *752 - organization: *698 + enterprise: *703 + installation: *704 + number: *759 + organization: *705 pull_request: title: Pull Request type: object @@ -171396,7 +171777,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *699 + repository: *706 sender: *19 required: - action @@ -171476,12 +171857,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *696 - milestone: *536 - number: *752 - organization: *698 - pull_request: *754 - repository: *699 + enterprise: *703 + milestone: *543 + number: *759 + organization: *705 + pull_request: *761 + repository: *706 sender: *19 required: - action @@ -171560,12 +171941,12 @@ x-webhooks: type: string enum: - opened - enterprise: *696 - installation: *697 - number: *752 - organization: *698 - pull_request: *753 - repository: *699 + enterprise: *703 + installation: *704 + number: *759 + organization: *705 + pull_request: *760 + repository: *706 sender: *19 required: - action @@ -171646,12 +172027,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *696 - installation: *697 - number: *752 - organization: *698 - pull_request: *753 - repository: *699 + enterprise: *703 + installation: *704 + number: *759 + organization: *705 + pull_request: *760 + repository: *706 sender: *19 required: - action @@ -171731,12 +172112,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *696 - installation: *697 - number: *752 - organization: *698 - pull_request: *753 - repository: *699 + enterprise: *703 + installation: *704 + number: *759 + organization: *705 + pull_request: *760 + repository: *706 sender: *19 required: - action @@ -172102,9 +172483,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 pull_request: type: object properties: @@ -174274,7 +174655,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *699 + repository: *706 sender: *19 required: - action @@ -174354,7 +174735,7 @@ x-webhooks: type: string enum: - deleted - comment: &756 + comment: &763 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. @@ -174639,9 +175020,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 pull_request: type: object properties: @@ -176799,7 +177180,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *699 + repository: *706 sender: *19 required: - action @@ -176879,11 +177260,11 @@ x-webhooks: type: string enum: - edited - changes: *755 - comment: *756 - enterprise: *696 - installation: *697 - organization: *698 + changes: *762 + comment: *763 + enterprise: *703 + installation: *704 + organization: *705 pull_request: type: object properties: @@ -179044,7 +179425,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *699 + repository: *706 sender: *19 required: - action @@ -179125,9 +179506,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 pull_request: title: Simple Pull Request type: object @@ -181300,7 +181681,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *699 + repository: *706 review: description: The review that was affected. type: object @@ -181543,9 +181924,9 @@ x-webhooks: type: string required: - from - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 pull_request: title: Simple Pull Request type: object @@ -183599,8 +183980,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *699 - review: &757 + repository: *706 + review: &764 description: The review that was affected. type: object properties: @@ -183829,12 +184210,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 number: description: The pull request number. type: integer - organization: *698 + organization: *705 pull_request: title: Pull Request type: object @@ -186117,7 +186498,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *699 + repository: *706 requested_reviewer: title: User type: object @@ -186201,12 +186582,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 number: description: The pull request number. type: integer - organization: *698 + organization: *705 pull_request: title: Pull Request type: object @@ -188496,7 +188877,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *699 + repository: *706 requested_team: title: Team description: Groups of organization members that gives permissions @@ -188688,12 +189069,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 number: description: The pull request number. type: integer - organization: *698 + organization: *705 pull_request: title: Pull Request type: object @@ -190978,7 +191359,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *699 + repository: *706 requested_reviewer: title: User type: object @@ -191063,12 +191444,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 number: description: The pull request number. type: integer - organization: *698 + organization: *705 pull_request: title: Pull Request type: object @@ -193344,7 +193725,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *699 + repository: *706 requested_team: title: Team description: Groups of organization members that gives permissions @@ -193525,9 +193906,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 pull_request: title: Simple Pull Request type: object @@ -195702,8 +196083,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *699 - review: *757 + repository: *706 + review: *764 sender: *19 required: - action @@ -195783,9 +196164,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 pull_request: title: Simple Pull Request type: object @@ -197855,7 +198236,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *699 + repository: *706 sender: *19 thread: type: object @@ -198238,9 +198619,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 pull_request: title: Simple Pull Request type: object @@ -200296,7 +200677,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *699 + repository: *706 sender: *19 thread: type: object @@ -200682,10 +201063,10 @@ x-webhooks: type: string before: type: string - enterprise: *696 - installation: *697 - number: *752 - organization: *698 + enterprise: *703 + installation: *704 + number: *759 + organization: *705 pull_request: title: Pull Request type: object @@ -202956,7 +203337,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *699 + repository: *706 sender: *19 required: - action @@ -203038,11 +203419,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *758 - enterprise: *696 - installation: *697 - number: *752 - organization: *698 + assignee: *765 + enterprise: *703 + installation: *704 + number: *759 + organization: *705 pull_request: title: Pull Request type: object @@ -205325,7 +205706,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *699 + repository: *706 sender: *19 required: - action @@ -205404,11 +205785,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *696 - installation: *697 - label: *722 - number: *752 - organization: *698 + enterprise: *703 + installation: *704 + label: *729 + number: *759 + organization: *705 pull_request: title: Pull Request type: object @@ -207681,7 +208062,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *699 + repository: *706 sender: *19 required: - action @@ -207762,10 +208143,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *696 - installation: *697 - number: *752 - organization: *698 + enterprise: *703 + installation: *704 + number: *759 + organization: *705 pull_request: title: Pull Request type: object @@ -210030,7 +210411,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *699 + repository: *706 sender: *19 required: - action @@ -210230,7 +210611,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *696 + enterprise: *703 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -210322,8 +210703,8 @@ x-webhooks: - url - author - committer - installation: *697 - organization: *698 + installation: *704 + organization: *705 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -210898,9 +211279,9 @@ x-webhooks: type: string enum: - published - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 registry_package: type: object properties: @@ -211346,7 +211727,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *740 + items: *747 summary: type: string tag_name: @@ -211400,7 +211781,7 @@ x-webhooks: - owner - package_version - registry - repository: *699 + repository: *706 sender: *19 required: - action @@ -211478,9 +211859,9 @@ x-webhooks: type: string enum: - updated - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 registry_package: type: object properties: @@ -211788,7 +212169,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *740 + items: *747 summary: type: string tag_name: @@ -211837,7 +212218,7 @@ x-webhooks: - owner - package_version - registry - repository: *699 + repository: *706 sender: *19 required: - action @@ -211914,10 +212295,10 @@ x-webhooks: type: string enum: - created - enterprise: *696 - installation: *697 - organization: *698 - release: &759 + enterprise: *703 + installation: *704 + organization: *705 + release: &766 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -212222,7 +212603,7 @@ x-webhooks: - tarball_url - zipball_url - body - repository: *699 + repository: *706 sender: *19 required: - action @@ -212299,11 +212680,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *696 - installation: *697 - organization: *698 - release: *759 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + release: *766 + repository: *706 sender: *19 required: - action @@ -212411,11 +212792,11 @@ x-webhooks: type: boolean required: - to - enterprise: *696 - installation: *697 - organization: *698 - release: *759 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + release: *766 + repository: *706 sender: *19 required: - action @@ -212493,9 +212874,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 release: title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) @@ -212804,7 +213185,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *699 + repository: *706 sender: *19 required: - action @@ -212880,10 +213261,10 @@ x-webhooks: type: string enum: - published - enterprise: *696 - installation: *697 - organization: *698 - release: &760 + enterprise: *703 + installation: *704 + organization: *705 + release: &767 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -213189,7 +213570,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *699 + repository: *706 sender: *19 required: - action @@ -213265,11 +213646,11 @@ x-webhooks: type: string enum: - released - enterprise: *696 - installation: *697 - organization: *698 - release: *759 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + release: *766 + repository: *706 sender: *19 required: - action @@ -213345,11 +213726,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *696 - installation: *697 - organization: *698 - release: *760 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + release: *767 + repository: *706 sender: *19 required: - action @@ -213425,11 +213806,11 @@ x-webhooks: type: string enum: - published - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 - repository_advisory: *607 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + repository_advisory: *614 sender: *19 required: - action @@ -213505,11 +213886,11 @@ x-webhooks: type: string enum: - reported - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 - repository_advisory: *607 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + repository_advisory: *614 sender: *19 required: - action @@ -213585,10 +213966,10 @@ x-webhooks: type: string enum: - archived - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -213665,10 +214046,10 @@ x-webhooks: type: string enum: - created - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -213746,10 +214127,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -213833,10 +214214,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -213948,10 +214329,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -214023,10 +214404,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 status: type: string @@ -214107,10 +214488,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -214187,10 +214568,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -214284,10 +214665,10 @@ x-webhooks: - name required: - repository - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -214367,11 +214748,11 @@ x-webhooks: type: string enum: - created - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 - repository_ruleset: *285 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + repository_ruleset: *109 sender: *19 required: - action @@ -214449,11 +214830,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 - repository_ruleset: *285 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + repository_ruleset: *109 sender: *19 required: - action @@ -214531,11 +214912,11 @@ x-webhooks: type: string enum: - edited - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 - repository_ruleset: *285 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + repository_ruleset: *109 changes: type: object properties: @@ -214554,16 +214935,16 @@ x-webhooks: properties: added: type: array - items: *279 + items: *102 deleted: type: array - items: *279 + items: *102 updated: type: array items: type: object properties: - condition: *279 + condition: *102 changes: type: object properties: @@ -214596,16 +214977,16 @@ x-webhooks: properties: added: type: array - items: *284 + items: *108 deleted: type: array - items: *284 + items: *108 updated: type: array items: type: object properties: - rule: *284 + rule: *108 changes: type: object properties: @@ -214839,10 +215220,10 @@ x-webhooks: - from required: - owner - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -214920,10 +215301,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -215001,7 +215382,7 @@ x-webhooks: type: string enum: - create - alert: &761 + alert: &768 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -215122,10 +215503,10 @@ x-webhooks: type: string enum: - open - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -215331,10 +215712,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -215412,11 +215793,11 @@ x-webhooks: type: string enum: - reopen - alert: *761 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + alert: *768 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -215615,10 +215996,10 @@ x-webhooks: enum: - fixed - open - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -215696,7 +216077,7 @@ x-webhooks: type: string enum: - created - alert: &762 + alert: &769 type: object properties: number: *85 @@ -215783,6 +216164,11 @@ x-webhooks: properties: *4 required: *5 nullable: true + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection + bypass. + nullable: true push_protection_bypass_request_comment: type: string description: An optional comment when requesting a push protection @@ -215802,10 +216188,10 @@ x-webhooks: description: Whether the detected secret was found in multiple repositories in the same organization or business. nullable: true - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -215886,11 +216272,11 @@ x-webhooks: type: string enum: - created - alert: *762 - installation: *697 - location: *763 - organization: *698 - repository: *699 + alert: *769 + installation: *704 + location: *770 + organization: *705 + repository: *706 sender: *19 required: - location @@ -216128,11 +216514,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *762 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + alert: *769 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -216210,11 +216596,11 @@ x-webhooks: type: string enum: - reopened - alert: *762 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + alert: *769 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -216292,11 +216678,11 @@ x-webhooks: type: string enum: - resolved - alert: *762 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + alert: *769 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -216374,11 +216760,11 @@ x-webhooks: type: string enum: - validated - alert: *762 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + alert: *769 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -216454,11 +216840,11 @@ x-webhooks: type: string enum: - published - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 - security_advisory: &764 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + security_advisory: &771 description: The details of the security advisory, including summary, description, and severity. type: object @@ -216641,11 +217027,11 @@ x-webhooks: type: string enum: - updated - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 - security_advisory: *764 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + security_advisory: *771 sender: *19 required: - action @@ -216718,10 +217104,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -216905,11 +217291,11 @@ x-webhooks: from: type: object properties: - security_and_analysis: *276 - enterprise: *696 - installation: *697 - organization: *698 - repository: *338 + security_and_analysis: *289 + enterprise: *703 + installation: *704 + organization: *705 + repository: *345 sender: *19 required: - changes @@ -216987,12 +217373,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 - sponsorship: &765 + sponsorship: &772 type: object properties: created_at: @@ -217293,12 +217679,12 @@ x-webhooks: type: string enum: - created - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 - sponsorship: *765 + sponsorship: *772 required: - action - sponsorship @@ -217386,12 +217772,12 @@ x-webhooks: type: string required: - from - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 - sponsorship: *765 + sponsorship: *772 required: - action - changes @@ -217468,17 +217854,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &766 + effective_date: &773 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: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 - sponsorship: *765 + sponsorship: *772 required: - action - sponsorship @@ -217552,7 +217938,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &767 + changes: &774 type: object properties: tier: @@ -217596,13 +217982,13 @@ x-webhooks: - from required: - tier - effective_date: *766 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + effective_date: *773 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 - sponsorship: *765 + sponsorship: *772 required: - action - changes @@ -217679,13 +218065,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *767 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + changes: *774 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 - sponsorship: *765 + sponsorship: *772 required: - action - changes @@ -217759,10 +218145,10 @@ x-webhooks: type: string enum: - created - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 starred_at: description: 'The time the star was created. This is a timestamp @@ -217845,10 +218231,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 starred_at: description: 'The time the star was created. This is a timestamp @@ -218267,15 +218653,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *696 + enterprise: *703 id: description: The unique identifier of the status. type: integer - installation: *697 + installation: *704 name: type: string - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 sha: description: The Commit SHA. @@ -218384,15 +218770,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *122 + parent_issue: *134 parent_issue_repo: *57 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *122 - installation: *697 - organization: *698 - repository: *699 + sub_issue: *134 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -218476,15 +218862,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *122 + parent_issue: *134 parent_issue_repo: *57 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *122 - installation: *697 - organization: *698 - repository: *699 + sub_issue: *134 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -218568,15 +218954,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *122 + sub_issue: *134 sub_issue_repo: *57 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *122 - installation: *697 - organization: *698 - repository: *699 + parent_issue: *134 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -218660,15 +219046,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *122 + sub_issue: *134 sub_issue_repo: *57 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *122 - installation: *697 - organization: *698 - repository: *699 + parent_issue: *134 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -218745,12 +219131,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 - team: &768 + team: &775 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -218940,9 +219326,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 repository: title: Repository description: A git repository @@ -219400,7 +219786,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *768 + team: *775 required: - action - team @@ -219476,9 +219862,9 @@ x-webhooks: type: string enum: - created - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 repository: title: Repository description: A git repository @@ -219936,7 +220322,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *768 + team: *775 required: - action - team @@ -220013,9 +220399,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 repository: title: Repository description: A git repository @@ -220473,7 +220859,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *768 + team: *775 required: - action - team @@ -220617,9 +221003,9 @@ x-webhooks: - from required: - permissions - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 repository: title: Repository description: A git repository @@ -221077,7 +221463,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *768 + team: *775 required: - action - changes @@ -221155,9 +221541,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 repository: title: Repository description: A git repository @@ -221615,7 +222001,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *768 + team: *775 required: - action - team @@ -221691,10 +222077,10 @@ x-webhooks: type: string enum: - started - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -221767,16 +222153,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *696 + enterprise: *703 inputs: type: object nullable: true additionalProperties: true - installation: *697 - organization: *698 + installation: *704 + organization: *705 ref: type: string - repository: *699 + repository: *706 sender: *19 workflow: type: string @@ -221858,10 +222244,10 @@ x-webhooks: type: string enum: - completed - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 workflow_job: allOf: @@ -222098,7 +222484,7 @@ x-webhooks: type: string required: - conclusion - deployment: *468 + deployment: *475 required: - action - repository @@ -222177,10 +222563,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 workflow_job: allOf: @@ -222440,7 +222826,7 @@ x-webhooks: required: - status - steps - deployment: *468 + deployment: *475 required: - action - repository @@ -222519,10 +222905,10 @@ x-webhooks: type: string enum: - queued - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 workflow_job: type: object @@ -222657,7 +223043,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *468 + deployment: *475 required: - action - repository @@ -222736,10 +223122,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 workflow_job: type: object @@ -222875,7 +223261,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *468 + deployment: *475 required: - action - repository @@ -222955,12 +223341,12 @@ x-webhooks: type: string enum: - completed - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 - workflow: *718 + workflow: *725 workflow_run: title: Workflow Run type: object @@ -223959,12 +224345,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 - workflow: *718 + workflow: *725 workflow_run: title: Workflow Run type: object @@ -224948,12 +225334,12 @@ x-webhooks: type: string enum: - requested - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 - workflow: *718 + workflow: *725 workflow_run: title: Workflow Run type: object diff --git a/descriptions/ghec/dereferenced/ghec.deref.json b/descriptions/ghec/dereferenced/ghec.deref.json index 650de0485..cfc1c3640 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.json +++ b/descriptions/ghec/dereferenced/ghec.deref.json @@ -26194,7 +26194,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-user-management" @@ -26834,7 +26834,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-metrics" @@ -27192,7 +27192,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-usage" @@ -29798,6 +29798,82 @@ } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Custom Property Set Payload", + "description": "Custom property set payload", + "type": "object", + "properties": { + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "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", @@ -30063,6 +30139,7011 @@ } } }, + "/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", + "nullable": true, + "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", + "nullable": true, + "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", + "nullable": true, + "properties": { + "href": { + "type": "string", + "description": "The html URL of the ruleset" + } + } + } + } + }, + "conditions": { + "nullable": true, + "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" + ] + } + ] + } + ] + } + ] + }, + "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", + "nullable": true, + "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", + "nullable": true, + "properties": { + "href": { + "type": "string", + "description": "The html URL of the ruleset" + } + } + } + } + }, + "conditions": { + "nullable": true, + "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" + ] + } + ] + } + ] + } + ] + }, + "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", + "nullable": true, + "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" + ] + } + } + }, + { + "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" + ] + } + } + } + ] + } + } + } + }, + "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": { + "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", + "nullable": true, + "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", + "nullable": true, + "properties": { + "href": { + "type": "string", + "description": "The html URL of the ruleset" + } + } + } + } + }, + "conditions": { + "nullable": true, + "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" + ] + } + ] + } + ] + } + ] + }, + "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" + } + }, + "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": [ + { + "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": { + "204": { + "description": "Response" + }, + "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}/secret-scanning/alerts": { "get": { "summary": "List secret scanning alerts for an enterprise", @@ -31088,6 +38169,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -31270,6 +38356,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", @@ -31361,6 +38448,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, @@ -33557,7 +40645,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-metrics" @@ -33924,7 +41012,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-usage" @@ -73093,6 +80181,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -128684,6 +135775,8 @@ "content": { "application/json": { "schema": { + "title": "Custom Property Set Payload", + "description": "Custom property set payload", "type": "object", "properties": { "value_type": { @@ -134854,7 +141947,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -134862,7 +141956,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -134871,7 +141966,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", @@ -134986,7 +142081,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", @@ -135453,6 +142548,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." @@ -136197,13 +143299,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", @@ -136253,7 +143356,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", @@ -136719,6 +143822,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." @@ -137392,7 +144502,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -137400,7 +144511,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -137409,7 +144521,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", @@ -137524,7 +144636,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", @@ -137991,6 +145103,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." @@ -139305,7 +146424,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -139313,7 +146433,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -139322,7 +146443,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", @@ -139437,7 +146558,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", @@ -139904,6 +147025,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." @@ -140674,12 +147802,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", @@ -140729,7 +147858,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", @@ -141195,6 +148324,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." @@ -141864,7 +149000,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -141872,7 +149009,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -141881,7 +149019,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", @@ -141996,7 +149134,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", @@ -142463,6 +149601,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." @@ -144308,6 +151453,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -144490,6 +151640,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", @@ -144581,6 +151732,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, @@ -166734,6 +173886,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": [ @@ -166834,6 +174010,12 @@ "used": 0, "remaining": 10, "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 } }, "rate": { @@ -197014,6 +204196,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -409489,6 +416674,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." @@ -410359,7 +417551,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -410367,7 +417560,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -410376,7 +417570,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", @@ -410491,7 +417685,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", @@ -410958,6 +418152,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." @@ -411717,7 +418918,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", @@ -412015,6 +419216,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." @@ -412678,7 +419886,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -412686,7 +419895,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -412695,7 +419905,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", @@ -412810,7 +420020,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", @@ -413277,6 +420487,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." @@ -414610,7 +421827,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -414618,7 +421836,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -414627,7 +421846,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", @@ -414742,7 +421961,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", @@ -415209,6 +422428,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." @@ -415983,7 +423209,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", @@ -416281,6 +423507,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." @@ -416940,7 +424173,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -416948,7 +424182,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -416957,7 +424192,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", @@ -417072,7 +424307,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", @@ -417539,6 +424774,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." @@ -418978,6 +426220,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -419088,6 +426335,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", @@ -419112,6 +426360,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, @@ -419672,6 +426921,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -419723,6 +426977,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, @@ -420330,6 +427585,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -420400,6 +427660,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", @@ -528555,6 +535816,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -564457,6 +571721,11 @@ "dismissed" ] }, + "reviewer_comment": { + "type": "string", + "description": "The comment the reviewer provided when responding to the exemption request.", + "nullable": true + }, "created_at": { "type": "string", "format": "date-time", @@ -566294,6 +573563,11 @@ "dismissed" ] }, + "reviewer_comment": { + "type": "string", + "description": "The comment the reviewer provided when responding to the exemption request.", + "nullable": true + }, "created_at": { "type": "string", "format": "date-time", @@ -568131,6 +575405,11 @@ "dismissed" ] }, + "reviewer_comment": { + "type": "string", + "description": "The comment the reviewer provided when responding to the exemption request.", + "nullable": true + }, "created_at": { "type": "string", "format": "date-time", @@ -569968,6 +577247,11 @@ "dismissed" ] }, + "reviewer_comment": { + "type": "string", + "description": "The comment the reviewer provided when responding to the exemption request.", + "nullable": true + }, "created_at": { "type": "string", "format": "date-time", @@ -570010,6 +577294,11 @@ "dismissed" ] }, + "reviewer_comment": { + "type": "string", + "description": "The comment the reviewer provided when responding to the exemption request.", + "nullable": true + }, "created_at": { "type": "string", "format": "date-time", @@ -571839,6 +579128,11 @@ "dismissed" ] }, + "reviewer_comment": { + "type": "string", + "description": "The comment the reviewer provided when responding to the exemption request.", + "nullable": true + }, "created_at": { "type": "string", "format": "date-time", @@ -571881,6 +579175,11 @@ "dismissed" ] }, + "reviewer_comment": { + "type": "string", + "description": "The comment the reviewer provided when responding to the exemption request.", + "nullable": true + }, "created_at": { "type": "string", "format": "date-time", @@ -573710,6 +581009,11 @@ "dismissed" ] }, + "reviewer_comment": { + "type": "string", + "description": "The comment the reviewer provided when responding to the exemption request.", + "nullable": true + }, "created_at": { "type": "string", "format": "date-time", @@ -575547,6 +582851,11 @@ "dismissed" ] }, + "reviewer_comment": { + "type": "string", + "description": "The comment the reviewer provided when responding to the exemption request.", + "nullable": true + }, "created_at": { "type": "string", "format": "date-time", @@ -577384,6 +584693,11 @@ "dismissed" ] }, + "reviewer_comment": { + "type": "string", + "description": "The comment the reviewer provided when responding to the exemption request.", + "nullable": true + }, "created_at": { "type": "string", "format": "date-time", @@ -579221,6 +586535,11 @@ "dismissed" ] }, + "reviewer_comment": { + "type": "string", + "description": "The comment the reviewer provided when responding to the exemption request.", + "nullable": true + }, "created_at": { "type": "string", "format": "date-time", @@ -579263,6 +586582,11 @@ "dismissed" ] }, + "reviewer_comment": { + "type": "string", + "description": "The comment the reviewer provided when responding to the exemption request.", + "nullable": true + }, "created_at": { "type": "string", "format": "date-time", @@ -581092,6 +588416,11 @@ "dismissed" ] }, + "reviewer_comment": { + "type": "string", + "description": "The comment the reviewer provided when responding to the exemption request.", + "nullable": true + }, "created_at": { "type": "string", "format": "date-time", @@ -581134,6 +588463,11 @@ "dismissed" ] }, + "reviewer_comment": { + "type": "string", + "description": "The comment the reviewer provided when responding to the exemption request.", + "nullable": true + }, "created_at": { "type": "string", "format": "date-time", @@ -1070639,7 +1077973,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -1070647,7 +1077982,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -1070656,7 +1077992,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", @@ -1070771,7 +1078107,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", @@ -1071238,6 +1078574,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." @@ -1073471,7 +1080814,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -1073479,7 +1080823,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -1073488,7 +1080833,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", @@ -1073603,7 +1080948,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", @@ -1074070,6 +1081415,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." @@ -1076303,7 +1083655,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -1076311,7 +1083664,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -1076320,7 +1083674,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", @@ -1076435,7 +1083789,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", @@ -1076902,6 +1084256,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." @@ -1077886,6 +1085247,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." @@ -1078698,6 +1086066,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." @@ -1079513,6 +1086888,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." @@ -1091356,6 +1098738,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -1093454,6 +1100841,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -1095968,6 +1103360,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -1098066,6 +1105463,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -1100164,6 +1107566,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -1102262,6 +1109669,11 @@ ], "nullable": true }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", diff --git a/descriptions/ghec/dereferenced/ghec.deref.yaml b/descriptions/ghec/dereferenced/ghec.deref.yaml index 817b69c9a..cb2dc4c22 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.deref.yaml @@ -846,7 +846,7 @@ paths: - subscriptions_url - type - url - type: &296 + type: &303 type: string description: The type of credit the user is receiving. enum: @@ -979,7 +979,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &149 + schema: &161 title: Validation Error Simple description: Validation Error Simple type: object @@ -1012,7 +1012,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &609 + - &616 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1130,7 +1130,7 @@ paths: GitHub. type: object nullable: true - properties: &107 + properties: &119 id: description: Unique identifier of the GitHub app example: 37 @@ -1219,7 +1219,7 @@ paths: type: string example: '"-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n"' - required: &108 + required: &120 - id - node_id - owner @@ -1524,7 +1524,7 @@ paths: schema: type: integer default: 30 - - &221 + - &233 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 @@ -1540,7 +1540,7 @@ paths: application/json: schema: type: array - items: &222 + items: &234 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1617,7 +1617,7 @@ paths: - installation_id - repository_id examples: - default: &223 + default: &235 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1649,7 +1649,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &619 + schema: &626 title: Scim Error description: Scim Error type: object @@ -1676,7 +1676,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &148 + schema: &160 title: Validation Error description: Validation Error type: object @@ -1745,7 +1745,7 @@ paths: description: Response content: application/json: - schema: &224 + schema: &236 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1859,7 +1859,7 @@ paths: - request - response examples: - default: &225 + default: &237 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1919,7 +1919,7 @@ paths: parameters: - *17 responses: - '202': &151 + '202': &163 description: Accepted content: application/json: @@ -2114,7 +2114,7 @@ paths: parameters: - *18 - *20 - - &112 + - &124 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) @@ -2840,7 +2840,7 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: &274 + properties: &287 id: description: Unique identifier of the repository example: 42 @@ -2860,7 +2860,7 @@ paths: title: License Simple description: License Simple type: object - properties: &123 + properties: &135 key: type: string example: mit @@ -2882,7 +2882,7 @@ paths: html_url: type: string format: uri - required: &124 + required: &136 - key - name - url @@ -3269,7 +3269,7 @@ paths: type: boolean description: Whether anonymous git access is enabled for this repository - required: &275 + required: &288 - archive_url - assignees_url - blobs_url @@ -7282,7 +7282,7 @@ paths: description: Response content: application/json: - schema: &152 + schema: &164 type: object properties: total_active_caches_count: @@ -7297,7 +7297,7 @@ paths: - total_active_caches_count - total_active_caches_size_in_bytes examples: - default: &153 + default: &165 value: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 @@ -7391,7 +7391,7 @@ paths: - all - local_only - selected - selected_actions_url: &156 + selected_actions_url: &168 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` @@ -7759,7 +7759,7 @@ paths: description: Success response content: application/json: - schema: &159 + schema: &171 type: object properties: default_workflow_permissions: &46 @@ -7807,7 +7807,7 @@ paths: required: true content: application/json: - schema: &160 + schema: &172 type: object properties: default_workflow_permissions: *46 @@ -8628,7 +8628,7 @@ paths: application/json: schema: type: array - items: &164 + items: &176 title: Runner Application description: Runner Application type: object @@ -8653,7 +8653,7 @@ paths: - download_url - filename examples: - default: &165 + default: &177 value: - os: osx architecture: x64 @@ -8737,7 +8737,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &166 + '201': &178 description: Response content: application/json: @@ -8847,7 +8847,7 @@ paths: - token - expires_at examples: - default: &167 + default: &179 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -8887,7 +8887,7 @@ paths: application/json: schema: *58 examples: - default: &168 + default: &180 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -8919,7 +8919,7 @@ paths: application/json: schema: *55 examples: - default: &169 + default: &181 value: id: 23 name: MBP @@ -9133,7 +9133,7 @@ paths: - *40 - *54 responses: - '200': &170 + '200': &182 description: Response content: application/json: @@ -9189,7 +9189,7 @@ paths: parameters: - *40 - *54 - - &171 + - &183 name: name description: The name of a self-hosted runner's custom label. in: path @@ -9280,7 +9280,7 @@ paths: required: true content: application/json: - schema: &178 + schema: &190 title: Enterprise Announcement description: Enterprise global announcement type: object @@ -9351,7 +9351,7 @@ paths: required: false schema: type: string - - &179 + - &191 name: include description: |- The event types to include: @@ -9369,7 +9369,7 @@ paths: - web - git - all - - &180 + - &192 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. @@ -9377,7 +9377,7 @@ paths: required: false schema: type: string - - &181 + - &193 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. @@ -9385,7 +9385,7 @@ paths: required: false schema: type: string - - &182 + - &194 name: order description: |- The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. @@ -9407,7 +9407,7 @@ paths: application/json: schema: type: array - items: &183 + items: &195 type: object properties: "@timestamp": @@ -9529,7 +9529,7 @@ paths: description: The repository visibility, for example `public` or `private`. examples: - default: &184 + default: &196 value: - "@timestamp": 1606929874512 action: team.add_member @@ -10091,7 +10091,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise parameters: - *40 - - &186 + - &198 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`, @@ -10101,7 +10101,7 @@ paths: schema: &79 type: string description: The name of the tool used to generate the code scanning analysis. - - &187 + - &199 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 @@ -10124,7 +10124,7 @@ paths: be returned. in: query required: false - schema: &188 + schema: &200 type: string description: State of a code scanning alert. enum: @@ -10149,7 +10149,7 @@ paths: application/json: schema: type: array - items: &189 + items: &201 type: object properties: number: &85 @@ -10178,7 +10178,7 @@ paths: description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &406 + instances_url: &413 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -10213,7 +10213,7 @@ paths: format: date-time readOnly: true nullable: true - dismissed_reason: &407 + dismissed_reason: &414 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -10222,13 +10222,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &408 + dismissed_comment: &415 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &409 + rule: &416 type: object properties: id: @@ -10281,7 +10281,7 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &410 + tool: &417 type: object properties: name: *79 @@ -10291,15 +10291,15 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *80 - most_recent_instance: &411 + most_recent_instance: &418 type: object properties: - ref: &404 + ref: &411 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &417 + analysis_key: &424 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -10310,7 +10310,7 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &418 + category: &425 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -10648,7 +10648,7 @@ paths: - most_recent_instance - repository examples: - default: &190 + default: &202 value: - number: 4 created_at: '2020-02-13T12:29:18Z' @@ -10879,7 +10879,7 @@ paths: headers: Link: *39 '404': *7 - '503': &100 + '503': &112 description: Service unavailable content: application/json: @@ -11288,7 +11288,7 @@ paths: or enterprise teams are only counted once. seats: type: array - items: &197 + items: &209 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -11306,7 +11306,7 @@ paths: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - &243 + - &255 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -11365,7 +11365,7 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: &256 + properties: &268 id: description: Unique identifier of the team type: integer @@ -11421,7 +11421,7 @@ paths: maps to within LDAP environment example: uid=example,ou=users,dc=github,dc=com type: string - required: &257 + required: &269 - id - node_id - url @@ -11536,7 +11536,7 @@ paths: - created_at additionalProperties: false examples: - default: &198 + default: &210 value: total_seats: 2 seats: @@ -11614,7 +11614,7 @@ paths: '403': *29 '404': *7 x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-user-management @@ -11671,7 +11671,7 @@ paths: application/json: schema: type: array - items: &102 + items: &114 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -11979,7 +11979,7 @@ paths: - date additionalProperties: true examples: - default: &103 + default: &115 value: - date: '2024-06-24' total_active_users: 24 @@ -12081,14 +12081,14 @@ paths: '500': *84 '403': *29 '404': *7 - '422': &104 + '422': &116 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 @@ -12151,7 +12151,7 @@ paths: application/json: schema: type: array - items: &105 + items: &117 title: Copilot Usage Metrics description: Summary of Copilot usage. type: object @@ -12307,7 +12307,7 @@ paths: '403': *29 '404': *7 x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-usage @@ -12330,7 +12330,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *40 - - &205 + - &217 name: state in: query description: |- @@ -12339,7 +12339,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &206 + - &218 name: severity in: query description: |- @@ -12348,7 +12348,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &207 + - &219 name: ecosystem in: query description: |- @@ -12357,14 +12357,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &208 + - &220 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 - - &209 + - &221 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -12374,7 +12374,7 @@ paths: enum: - development - runtime - - &210 + - &222 name: sort in: query description: |- @@ -12390,7 +12390,7 @@ paths: - *78 - *76 - *77 - - &211 + - &223 name: first description: |- **Deprecated**. The number of results per page (max 100), starting from the first matching result. @@ -12403,7 +12403,7 @@ paths: minimum: 1 maximum: 100 default: 30 - - &212 + - &224 name: last description: |- **Deprecated**. The number of results per page (max 100), starting from the last matching result. @@ -12423,7 +12423,7 @@ paths: application/json: schema: type: array - items: &213 + items: &225 type: object description: A Dependabot alert. properties: @@ -12473,7 +12473,7 @@ paths: enum: - development - runtime - security_advisory: &460 + security_advisory: &467 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -12704,7 +12704,7 @@ paths: nullable: true maxLength: 280 fixed_at: *94 - auto_dismissed_at: &461 + auto_dismissed_at: &468 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -12730,7 +12730,7 @@ paths: - repository additionalProperties: false examples: - default: &214 + default: &226 value: - number: 2 state: dismissed @@ -13376,6 +13376,61 @@ paths: parameters: - *40 - *98 + requestBody: + required: true + content: + application/json: + schema: &285 + title: Custom Property Set Payload + description: Custom property set payload + type: object + properties: + value_type: + type: string + example: single_select + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + nullable: true + description: Default value of the property + description: + type: string + nullable: true + description: Short description of the property + allowed_values: + type: array + items: + type: string + maxLength: 75 + maxItems: 200 + nullable: true + 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 @@ -13410,7 +13465,7 @@ paths: - *40 - *98 responses: - '204': &192 + '204': &204 description: A header with no content is returned. '403': *29 '404': *7 @@ -13419,6 +13474,1259 @@ 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: + - *40 + 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: &106 + 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: &107 + 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 + nullable: true + 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: &111 + 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: + - &100 + 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 + - &103 + 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 + - &102 + 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: + - *100 + - &105 + 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: &101 + 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: *101 + required: + - repository_property + - *102 + - type: object + title: organization_id_and_repository_name + description: Conditions to target organizations by id and all + repositories + allOf: + - &104 + 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 + - *103 + - *102 + - type: object + title: organization_id_and_repository_property + description: Conditions to target organization by id and repositories + by property + allOf: + - *104 + - *105 + - *102 + rules: + type: array + description: An array of rules within the ruleset. + items: &108 + title: Repository Rule + type: object + description: A repository rule. + oneOf: + - &577 + title: creation + description: Only allow users with bypass permission to create + matching refs. + type: object + required: + - type + properties: + type: + type: string + enum: + - creation + - &578 + 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 + - &580 + title: deletion + description: Only allow users with bypass permissions to delete + matching refs. + type: object + required: + - type + properties: + type: + type: string + enum: + - deletion + - &581 + 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 + - &582 + 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 + - &583 + 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 + - &584 + title: required_signatures + description: Commits pushed to matching refs must have verified + signatures. + type: object + required: + - type + properties: + type: + type: string + enum: + - required_signatures + - &585 + 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 + - &586 + 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 + - &587 + 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 + - &588 + 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 + - &589 + 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 + - &590 + 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 + - &591 + 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 + - &592 + 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 + - &593 + 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 + - &594 + 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: &109 + 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: *106 + bypass_actors: + type: array + description: The actors that can bypass the rules in this ruleset + items: *107 + 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 + nullable: true + properties: + href: + type: string + description: The html URL of the ruleset + conditions: + nullable: true + anyOf: + - *102 + - &292 + 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: + - *102 + - *103 + - type: object + title: repository_id_and_ref_name + description: Conditions to target repositories by id and refs + by name + allOf: + - *102 + - 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: + - *102 + - *105 + rules: + type: array + items: *108 + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + examples: + default: &110 + 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': *7 + '500': *84 + 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: + - *40 + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: *109 + examples: + default: *110 + '404': *7 + '500': *84 + 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: + - *40 + - 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: *106 + bypass_actors: + type: array + description: The actors that can bypass the rules in this ruleset + items: *107 + conditions: *111 + rules: + description: An array of rules within the ruleset. + type: array + items: *108 + 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: *109 + examples: + default: *110 + '404': *7 + '500': *84 + 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: + - *40 + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Response + '404': *7 + '500': *84 + 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 @@ -13433,7 +14741,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - *40 - - &287 + - &294 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -13444,7 +14752,7 @@ paths: enum: - open - resolved - - &288 + - &295 name: secret_type in: query description: |- @@ -13454,7 +14762,7 @@ paths: required: false schema: type: string - - &289 + - &296 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -13463,7 +14771,7 @@ paths: required: false schema: type: string - - &290 + - &297 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. @@ -13479,7 +14787,7 @@ paths: - *18 - *76 - *77 - - &291 + - &298 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -13488,7 +14796,7 @@ paths: required: false schema: type: string - - &292 + - &299 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -13497,7 +14805,7 @@ paths: schema: type: boolean default: false - - &293 + - &300 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -13513,7 +14821,7 @@ paths: application/json: schema: type: array - items: &294 + items: &301 type: object properties: number: *85 @@ -13532,14 +14840,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &601 + state: &608 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: &602 + resolution: &609 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -13599,6 +14907,11 @@ paths: properties: *4 required: *5 nullable: true + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection + bypass. + nullable: true push_protection_bypass_request_comment: type: string description: An optional comment when requesting a push protection @@ -13631,7 +14944,7 @@ paths: repositories in the same organization or enterprise. nullable: true examples: - default: &295 + default: &302 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -13768,6 +15081,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 @@ -13855,6 +15169,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: @@ -13864,7 +15179,7 @@ paths: headers: Link: *39 '404': *7 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -13892,7 +15207,7 @@ paths: description: Response content: application/json: - schema: &298 + schema: &305 type: object properties: total_minutes_used: @@ -13962,7 +15277,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &299 + default: &306 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -14000,7 +15315,7 @@ paths: description: Success content: application/json: - schema: &300 + schema: &307 type: object properties: total_advanced_security_committers: @@ -14055,7 +15370,7 @@ paths: required: - repositories examples: - default: &301 + default: &308 value: total_advanced_security_committers: 2 total_count: 2 @@ -14143,7 +15458,7 @@ paths: '400': *15 '403': *29 '500': *84 - '503': *100 + '503': *112 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -14164,7 +15479,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#add-users-to-a-cost-center parameters: - *40 - - &101 + - &113 name: cost_center_id description: The ID corresponding to the cost center. in: path @@ -14206,13 +15521,13 @@ paths: message: Resources successfully added to the cost center. '400': *15 '403': *29 - '409': &150 + '409': &162 description: Conflict content: application/json: schema: *3 '500': *84 - '503': *100 + '503': *112 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -14232,7 +15547,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#remove-users-from-a-cost-center parameters: - *40 - - *101 + - *113 requestBody: required: true content: @@ -14270,7 +15585,7 @@ paths: '400': *15 '403': *29 '500': *84 - '503': *100 + '503': *112 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -14298,7 +15613,7 @@ paths: description: Response content: application/json: - schema: &302 + schema: &309 type: object properties: total_gigabytes_bandwidth_used: @@ -14316,7 +15631,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &303 + default: &310 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -14348,7 +15663,7 @@ paths: description: Response content: application/json: - schema: &304 + schema: &311 type: object properties: days_left_in_billing_cycle: @@ -14366,7 +15681,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &305 + default: &312 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -14391,7 +15706,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-usage-report-for-an-enterprise parameters: - *40 - - &139 + - &151 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, @@ -14400,7 +15715,7 @@ paths: required: false schema: type: integer - - &140 + - &152 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. @@ -14408,7 +15723,7 @@ paths: required: false schema: type: integer - - &141 + - &153 name: day description: If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. @@ -14416,7 +15731,7 @@ paths: required: false schema: type: integer - - &142 + - &154 name: hour description: If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. @@ -14436,7 +15751,7 @@ paths: description: Response when getting a billing usage report content: application/json: - schema: &143 + schema: &155 type: object properties: usageItems: @@ -14489,7 +15804,7 @@ paths: - netAmount - organizationName examples: - default: &144 + default: &156 value: usageItems: - date: '2023-08-01' @@ -14506,7 +15821,7 @@ paths: '400': *15 '403': *29 '500': *84 - '503': *100 + '503': *112 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -14577,15 +15892,15 @@ paths: application/json: schema: type: array - items: *102 + items: *114 examples: - default: *103 + default: *115 '500': *84 '403': *29 '404': *7 - '422': *104 + '422': *116 x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-metrics @@ -14618,7 +15933,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-an-enterprise-team parameters: - *40 - - &255 + - &267 name: team_slug description: The slug of the team name. in: path @@ -14656,9 +15971,9 @@ paths: application/json: schema: type: array - items: *105 + items: *117 examples: - default: &199 + default: &211 value: - day: '2023-10-15' total_suggestions_count: 1000 @@ -14727,7 +16042,7 @@ paths: '403': *29 '404': *7 x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-usage @@ -14814,7 +16129,7 @@ paths: application/json: schema: type: array - items: &134 + items: &146 title: Event description: Event type: object @@ -14824,7 +16139,7 @@ paths: type: type: string nullable: true - actor: &106 + actor: &118 title: Actor description: Actor type: object @@ -14864,18 +16179,18 @@ paths: - id - name - url - org: *106 + org: *118 payload: type: object properties: action: type: string - issue: &122 + issue: &134 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &509 + properties: &516 id: type: integer format: int64 @@ -14986,7 +16301,7 @@ paths: description: A collection of related issues and pull requests. type: object - properties: &445 + properties: &452 url: type: string format: uri @@ -15056,7 +16371,7 @@ paths: format: date-time example: '2012-10-09T23:39:01Z' nullable: true - required: &446 + required: &453 - closed_issues - creator - description @@ -15145,9 +16460,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 - author_association: &109 + properties: *119 + required: *120 + author_association: &121 title: author_association type: string example: OWNER @@ -15161,7 +16476,7 @@ paths: - MEMBER - NONE - OWNER - reactions: &110 + reactions: &122 title: Reaction Rollup type: object properties: @@ -15211,7 +16526,7 @@ paths: - total - completed - percent_completed - required: &510 + required: &517 - assignee - closed_at - comments @@ -15233,7 +16548,7 @@ paths: - author_association - created_at - updated_at - comment: &507 + comment: &514 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -15281,7 +16596,7 @@ paths: issue_url: type: string format: uri - author_association: *109 + author_association: *121 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -15291,9 +16606,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 - reactions: *110 + properties: *119 + required: *120 + reactions: *122 required: - id - node_id @@ -15388,7 +16703,7 @@ paths: created_at: '2022-06-07T07:50:26Z' '304': *37 '403': *29 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15469,7 +16784,7 @@ paths: _links: type: object properties: - timeline: &111 + timeline: &123 title: Link With Type description: Hypermedia Link with Type type: object @@ -15481,17 +16796,17 @@ paths: required: - href - type - user: *111 - security_advisories: *111 - current_user: *111 - current_user_public: *111 - current_user_actor: *111 - current_user_organization: *111 + user: *123 + security_advisories: *123 + current_user: *123 + current_user_public: *123 + current_user_actor: *123 + current_user_organization: *123 current_user_organizations: type: array - items: *111 - repository_discussions: *111 - repository_discussions_category: *111 + items: *123 + repository_discussions: *123 + repository_discussions_category: *123 required: - timeline - user @@ -15553,7 +16868,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *112 + - *124 - *18 - *20 responses: @@ -15563,7 +16878,7 @@ paths: application/json: schema: type: array - items: &113 + items: &125 title: Base Gist description: Base Gist type: object @@ -15660,7 +16975,7 @@ paths: - created_at - updated_at examples: - default: &114 + default: &126 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -15781,7 +17096,7 @@ paths: description: Response content: application/json: - schema: &115 + schema: &127 title: Gist Simple description: Gist Simple type: object @@ -15798,7 +17113,7 @@ paths: url: type: string format: uri - user: &658 + user: &665 title: Public User description: Public User type: object @@ -16156,7 +17471,7 @@ paths: truncated: type: boolean examples: - default: &116 + default: &128 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -16259,7 +17574,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-public-gists parameters: - - *112 + - *124 - *18 - *20 responses: @@ -16269,9 +17584,9 @@ paths: application/json: schema: type: array - items: *113 + items: *125 examples: - default: *114 + default: *126 headers: Link: *39 '422': *16 @@ -16293,7 +17608,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-starred-gists parameters: - - *112 + - *124 - *18 - *20 responses: @@ -16303,9 +17618,9 @@ paths: application/json: schema: type: array - items: *113 + items: *125 examples: - default: *114 + default: *126 headers: Link: *39 '401': *25 @@ -16333,7 +17648,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist parameters: - - &117 + - &129 name: gist_id description: The unique identifier of the gist. in: path @@ -16345,10 +17660,10 @@ paths: description: Response content: application/json: - schema: *115 + schema: *127 examples: - default: *116 - '403': &120 + default: *128 + '403': &132 description: Forbidden Gist content: application/json: @@ -16396,7 +17711,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#update-a-gist parameters: - - *117 + - *129 requestBody: required: true content: @@ -16456,9 +17771,9 @@ paths: description: Response content: application/json: - schema: *115 + schema: *127 examples: - updateGist: *116 + updateGist: *128 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -16616,7 +17931,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#delete-a-gist parameters: - - *117 + - *129 responses: '204': description: Response @@ -16645,7 +17960,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#list-gist-comments parameters: - - *117 + - *129 - *18 - *20 responses: @@ -16655,7 +17970,7 @@ paths: application/json: schema: type: array - items: &118 + items: &130 title: Gist Comment description: A comment made to a gist. type: object @@ -16690,7 +18005,7 @@ paths: type: string format: date-time example: '2011-04-18T23:23:56Z' - author_association: *109 + author_association: *121 required: - url - id @@ -16755,7 +18070,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#create-a-gist-comment parameters: - - *117 + - *129 requestBody: required: true content: @@ -16780,9 +18095,9 @@ paths: description: Response content: application/json: - schema: *118 + schema: *130 examples: - default: &119 + default: &131 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -16840,8 +18155,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#get-a-gist-comment parameters: - - *117 - - &121 + - *129 + - &133 name: comment_id description: The unique identifier of the comment. in: path @@ -16854,12 +18169,12 @@ paths: description: Response content: application/json: - schema: *118 + schema: *130 examples: - default: *119 + default: *131 '304': *37 '404': *7 - '403': *120 + '403': *132 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -16881,8 +18196,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#update-a-gist-comment parameters: - - *117 - - *121 + - *129 + - *133 requestBody: required: true content: @@ -16907,9 +18222,9 @@ paths: description: Response content: application/json: - schema: *118 + schema: *130 examples: - default: *119 + default: *131 '404': *7 x-github: githubCloudOnly: false @@ -16926,8 +18241,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#delete-a-gist-comment parameters: - - *117 - - *121 + - *129 + - *133 responses: '204': description: Response @@ -16950,7 +18265,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-commits parameters: - - *117 + - *129 - *18 - *20 responses: @@ -17051,7 +18366,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-forks parameters: - - *117 + - *129 - *18 - *20 responses: @@ -17061,7 +18376,7 @@ paths: application/json: schema: type: array - items: *115 + items: *127 examples: default: value: @@ -17126,13 +18441,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#fork-a-gist parameters: - - *117 + - *129 responses: '201': description: Response content: application/json: - schema: *113 + schema: *125 examples: default: value: @@ -17203,7 +18518,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#check-if-a-gist-is-starred parameters: - - *117 + - *129 responses: '204': description: Response if gist is starred @@ -17233,7 +18548,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#star-a-gist parameters: - - *117 + - *129 responses: '204': description: Response @@ -17255,7 +18570,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#unstar-a-gist parameters: - - *117 + - *129 responses: '204': description: Response @@ -17284,7 +18599,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist-revision parameters: - - *117 + - *129 - name: sha in: path required: true @@ -17295,9 +18610,9 @@ paths: description: Response content: application/json: - schema: *115 + schema: *127 examples: - default: *116 + default: *128 '422': *16 '404': *7 '403': *29 @@ -17663,7 +18978,7 @@ paths: - closed - all default: open - - &244 + - &256 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -17682,7 +18997,7 @@ paths: - comments default: created - *78 - - *112 + - *124 - name: collab in: query required: false @@ -17712,9 +19027,9 @@ paths: application/json: schema: type: array - items: *122 + items: *134 examples: - default: &245 + default: &257 value: - id: 1 node_id: MDU6SXNzdWUx @@ -17998,8 +19313,8 @@ paths: title: License Simple description: License Simple type: object - properties: *123 - required: *124 + properties: *135 + required: *136 examples: default: value: @@ -18283,7 +19598,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &125 + X-CommonMarker-Version: &137 example: 0.17.4 schema: type: string @@ -18338,7 +19653,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *125 + X-CommonMarker-Version: *137 content: text/html: schema: @@ -18367,7 +19682,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: - - &128 + - &140 name: account_id description: account_id parameter in: path @@ -18379,7 +19694,7 @@ paths: description: Response content: application/json: - schema: &127 + schema: &139 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -18409,7 +19724,7 @@ paths: nullable: true id: type: integer - plan: &126 + plan: &138 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -18498,7 +19813,7 @@ paths: nullable: true updated_at: type: string - plan: *126 + plan: *138 required: - url - id @@ -18506,7 +19821,7 @@ paths: - login - marketplace_purchase examples: - default: &129 + default: &141 value: url: https://api.github.com/orgs/github type: Organization @@ -18591,9 +19906,9 @@ paths: application/json: schema: type: array - items: *126 + items: *138 examples: - default: &130 + default: &142 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -18633,14 +19948,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &131 + - &143 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &132 + - &144 name: sort description: The property to sort the results by. in: query @@ -18670,9 +19985,9 @@ paths: application/json: schema: type: array - items: *127 + items: *139 examples: - default: &133 + default: &145 value: - url: https://api.github.com/orgs/github type: Organization @@ -18746,15 +20061,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: - - *128 + - *140 responses: '200': description: Response content: application/json: - schema: *127 + schema: *139 examples: - default: *129 + default: *141 '404': description: Not Found when the account has not purchased the listing '401': *25 @@ -18786,9 +20101,9 @@ paths: application/json: schema: type: array - items: *126 + items: *138 examples: - default: *130 + default: *142 headers: Link: *39 '401': *25 @@ -18811,8 +20126,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *131 - - *132 + - *143 + - *144 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -18832,9 +20147,9 @@ paths: application/json: schema: type: array - items: *127 + items: *139 examples: - default: *133 + default: *145 headers: Link: *39 '401': *25 @@ -19083,14 +20398,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: - - &325 + - &332 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &326 + - &333 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -19107,7 +20422,7 @@ paths: application/json: schema: type: array - items: *134 + items: *146 examples: default: value: @@ -19161,7 +20476,7 @@ paths: '404': *7 '403': *29 '304': *37 - '301': &339 + '301': &346 description: Moved permanently content: application/json: @@ -19183,7 +20498,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &539 + - &546 name: all description: If `true`, show notifications marked as read. in: query @@ -19191,7 +20506,7 @@ paths: schema: type: boolean default: false - - &540 + - &547 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -19200,8 +20515,8 @@ paths: schema: type: boolean default: false - - *112 - - &541 + - *124 + - &548 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: @@ -19226,18 +20541,18 @@ paths: application/json: schema: type: array - items: &135 + items: &147 title: Thread description: Thread type: object properties: id: type: string - repository: &163 + repository: &175 title: Minimal Repository description: Minimal Repository type: object - properties: &216 + properties: &228 id: type: integer format: int64 @@ -19513,7 +20828,7 @@ paths: web_commit_signoff_required: type: boolean example: false - security_and_analysis: &276 + security_and_analysis: &289 nullable: true type: object properties: @@ -19577,7 +20892,7 @@ paths: enum: - enabled - disabled - required: &217 + required: &229 - archive_url - assignees_url - blobs_url @@ -19665,7 +20980,7 @@ paths: - url - subscription_url examples: - default: &542 + default: &549 value: - id: '1' repository: @@ -19831,7 +21146,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread parameters: - - &136 + - &148 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 @@ -19845,7 +21160,7 @@ paths: description: Response content: application/json: - schema: *135 + schema: *147 examples: default: value: @@ -19948,7 +21263,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-read parameters: - - *136 + - *148 responses: '205': description: Reset Content @@ -19971,7 +21286,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-done parameters: - - *136 + - *148 responses: '204': description: No content @@ -19994,13 +21309,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: - - *136 + - *148 responses: '200': description: Response content: application/json: - schema: &137 + schema: &149 title: Thread Subscription description: Thread Subscription type: object @@ -20037,7 +21352,7 @@ paths: - url - subscribed examples: - default: &138 + default: &150 value: subscribed: true ignored: false @@ -20068,7 +21383,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#set-a-thread-subscription parameters: - - *136 + - *148 requestBody: required: false content: @@ -20089,9 +21404,9 @@ paths: description: Response content: application/json: - schema: *137 + schema: *149 examples: - default: *138 + default: *150 '304': *37 '403': *29 '401': *25 @@ -20114,7 +21429,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#delete-a-thread-subscription parameters: - - *136 + - *148 responses: '204': description: Response @@ -20211,7 +21526,7 @@ paths: type: array items: *52 examples: - default: &676 + default: &683 value: - login: github id: 1 @@ -20275,7 +21590,7 @@ paths: type: integer custom_roles: type: array - items: &200 + items: &212 title: Organization Custom Repository Role description: Custom repository roles created by organization owners @@ -20323,7 +21638,7 @@ paths: - created_at - updated_at examples: - default: &201 + default: &213 value: id: 8030 name: Security Engineer @@ -20369,29 +21684,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: - - &145 + - &157 name: org description: The organization name. The name is not case sensitive. in: path required: true schema: type: string - - *139 - - *140 - - *141 - - *142 + - *151 + - *152 + - *153 + - *154 responses: '200': description: Billing usage report response for an organization content: application/json: - schema: *143 + schema: *155 examples: - default: *144 + default: *156 '400': *15 '403': *29 '500': *84 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20417,13 +21732,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-an-organization parameters: - - *145 + - *157 responses: '200': description: Response content: application/json: - schema: &146 + schema: &158 title: Organization Full description: |- Prevents users in the organization from using insecure methods of two-factor authentication to fulfill a two-factor requirement. @@ -20726,7 +22041,7 @@ paths: - updated_at - archived_at examples: - default-response: &147 + default-response: &159 value: login: github id: 1 @@ -20819,7 +22134,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#update-an-organization parameters: - - *145 + - *157 requestBody: required: false content: @@ -21042,18 +22357,18 @@ paths: description: Response content: application/json: - schema: *146 + schema: *158 examples: - default: *147 + default: *159 '422': description: Validation failed content: application/json: schema: oneOf: - - *148 - - *149 - '409': *150 + - *160 + - *161 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21076,9 +22391,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#delete-an-organization parameters: - - *145 + - *157 responses: - '202': *151 + '202': *163 '404': *7 '403': *29 x-github: @@ -21101,15 +22416,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: - - *145 + - *157 responses: '200': description: Response content: application/json: - schema: *152 + schema: *164 examples: - default: *153 + default: *165 headers: Link: *39 x-github: @@ -21132,7 +22447,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: - - *145 + - *157 - *18 - *20 responses: @@ -21150,7 +22465,7 @@ paths: type: integer repository_cache_usages: type: array - items: &344 + items: &351 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -21205,13 +22520,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: - - *145 + - *157 responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &154 + schema: &166 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -21225,7 +22540,7 @@ paths: required: - include_claim_keys examples: - default: &155 + default: &167 value: include_claim_keys: - repo @@ -21247,20 +22562,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: - - *145 + - *157 requestBody: required: true content: application/json: - schema: *154 + schema: *166 examples: - default: *155 + default: *167 responses: '201': description: Empty response content: application/json: - schema: &174 + schema: &186 title: Empty Object description: An object without any properties. type: object @@ -21290,7 +22605,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: - - *145 + - *157 responses: '200': description: Response @@ -21299,7 +22614,7 @@ paths: schema: type: object properties: - enabled_repositories: &157 + enabled_repositories: &169 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -21313,7 +22628,7 @@ paths: that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. allowed_actions: *42 - selected_actions_url: *156 + selected_actions_url: *168 required: - enabled_repositories examples: @@ -21342,7 +22657,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: - - *145 + - *157 responses: '204': description: Response @@ -21353,7 +22668,7 @@ paths: schema: type: object properties: - enabled_repositories: *157 + enabled_repositories: *169 allowed_actions: *42 required: - enabled_repositories @@ -21381,7 +22696,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: - - *145 + - *157 - *18 - *20 responses: @@ -21401,7 +22716,7 @@ paths: type: array items: *57 examples: - default: &670 + default: &677 value: total_count: 1 repositories: @@ -21541,7 +22856,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: - - *145 + - *157 responses: '204': description: Response @@ -21585,8 +22900,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: - - *145 - - &158 + - *157 + - &170 name: repository_id description: The unique identifier of the repository. in: path @@ -21614,8 +22929,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: - - *145 - - *158 + - *157 + - *170 responses: '204': description: Response @@ -21638,7 +22953,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: - - *145 + - *157 responses: '200': description: Response @@ -21669,7 +22984,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: - - *145 + - *157 responses: '204': description: Response @@ -21701,13 +23016,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: - - *145 + - *157 responses: '200': description: Response content: application/json: - schema: *159 + schema: *171 examples: default: *48 x-github: @@ -21730,7 +23045,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: - - *145 + - *157 responses: '204': description: Success response @@ -21741,7 +23056,7 @@ paths: required: false content: application/json: - schema: *160 + schema: *172 examples: default: *48 x-github: @@ -21763,7 +23078,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: - - *145 + - *157 - *18 - *20 - name: visible_to_repository @@ -21788,7 +23103,7 @@ paths: type: number runner_groups: type: array - items: &161 + items: &173 type: object properties: id: @@ -21900,7 +23215,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: - - *145 + - *157 requestBody: required: true content: @@ -21969,9 +23284,9 @@ paths: description: Response content: application/json: - schema: *161 + schema: *173 examples: - default: &162 + default: &174 value: id: 2 name: octo-runner-group @@ -22006,14 +23321,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: - - *145 + - *157 - *51 responses: '200': description: Response content: application/json: - schema: *161 + schema: *173 examples: default: value: @@ -22049,7 +23364,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: - - *145 + - *157 - *51 requestBody: required: true @@ -22100,9 +23415,9 @@ paths: description: Response content: application/json: - schema: *161 + schema: *173 examples: - default: *162 + default: *174 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -22121,7 +23436,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: - - *145 + - *157 - *51 responses: '204': @@ -22145,7 +23460,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: - - *145 + - *157 - *51 - *20 - *18 @@ -22164,9 +23479,9 @@ paths: type: number repositories: type: array - items: *163 + items: *175 examples: - default: &661 + default: &668 value: total_count: 1 repositories: @@ -22418,7 +23733,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: - - *145 + - *157 - *51 requestBody: required: true @@ -22463,9 +23778,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: - - *145 + - *157 - *51 - - *158 + - *170 responses: '204': description: Response @@ -22487,9 +23802,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: - - *145 + - *157 - *51 - - *158 + - *170 responses: '204': description: Response @@ -22512,7 +23827,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: - - *145 + - *157 - *51 - *18 - *20 @@ -22554,7 +23869,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: - - *145 + - *157 - *51 requestBody: required: true @@ -22599,7 +23914,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: - - *145 + - *157 - *51 - *54 responses: @@ -22623,7 +23938,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: - - *145 + - *157 - *51 - *54 responses: @@ -22655,7 +23970,7 @@ paths: in: query schema: type: string - - *145 + - *157 - *18 - *20 responses: @@ -22699,7 +24014,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: - - *145 + - *157 responses: '200': description: Response @@ -22707,9 +24022,9 @@ paths: application/json: schema: type: array - items: *164 + items: *176 examples: - default: *165 + default: *177 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22731,7 +24046,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: - - *145 + - *157 requestBody: required: true content: @@ -22774,7 +24089,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *166 + '201': *178 '404': *7 '422': *8 x-github: @@ -22804,7 +24119,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: - - *145 + - *157 responses: '201': description: Response @@ -22812,7 +24127,7 @@ paths: application/json: schema: *58 examples: - default: *167 + default: *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22840,7 +24155,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: - - *145 + - *157 responses: '201': description: Response @@ -22848,7 +24163,7 @@ paths: application/json: schema: *58 examples: - default: *168 + default: *180 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22870,7 +24185,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: - - *145 + - *157 - *54 responses: '200': @@ -22879,7 +24194,7 @@ paths: application/json: schema: *55 examples: - default: *169 + default: *181 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22900,7 +24215,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: - - *145 + - *157 - *54 responses: '204': @@ -22926,7 +24241,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: - - *145 + - *157 - *54 responses: '200': *60 @@ -22951,7 +24266,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: - - *145 + - *157 - *54 requestBody: required: true @@ -23000,7 +24315,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: - - *145 + - *157 - *54 requestBody: required: true @@ -23050,10 +24365,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: - - *145 + - *157 - *54 responses: - '200': *170 + '200': *182 '404': *7 x-github: githubCloudOnly: false @@ -23080,9 +24395,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: - - *145 + - *157 - *54 - - *171 + - *183 responses: '200': *60 '404': *7 @@ -23109,7 +24424,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-organization-secrets parameters: - - *145 + - *157 - *18 - *20 responses: @@ -23127,7 +24442,7 @@ paths: type: integer secrets: type: array - items: &172 + items: &184 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -23200,13 +24515,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key parameters: - - *145 + - *157 responses: '200': description: Response content: application/json: - schema: &364 + schema: &371 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -23235,7 +24550,7 @@ paths: - key_id - key examples: - default: &365 + default: &372 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -23260,8 +24575,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-secret parameters: - - *145 - - &173 + - *157 + - &185 name: secret_name description: The name of the secret. in: path @@ -23273,7 +24588,7 @@ paths: description: Response content: application/json: - schema: *172 + schema: *184 examples: default: value: @@ -23303,8 +24618,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *145 - - *173 + - *157 + - *185 requestBody: required: true content: @@ -23359,7 +24674,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -23385,8 +24700,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-organization-secret parameters: - - *145 - - *173 + - *157 + - *185 responses: '204': description: Response @@ -23412,8 +24727,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: - - *145 - - *173 + - *157 + - *185 - *20 - *18 responses: @@ -23431,9 +24746,9 @@ paths: type: integer repositories: type: array - items: *163 + items: *175 examples: - default: &177 + default: &189 value: total_count: 1 repositories: @@ -23525,8 +24840,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: - - *145 - - *173 + - *157 + - *185 requestBody: required: true content: @@ -23578,8 +24893,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: - - *145 - - *173 + - *157 + - *185 - name: repository_id in: path required: true @@ -23612,8 +24927,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: - - *145 - - *173 + - *157 + - *185 - name: repository_id in: path required: true @@ -23645,8 +24960,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables parameters: - - *145 - - &349 + - *157 + - &356 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)." @@ -23670,7 +24985,7 @@ paths: type: integer variables: type: array - items: &175 + items: &187 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -23755,7 +25070,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-organization-variable parameters: - - *145 + - *157 requestBody: required: true content: @@ -23803,7 +25118,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -23828,8 +25143,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-organization-variable parameters: - - *145 - - &176 + - *157 + - &188 name: name description: The name of the variable. in: path @@ -23841,7 +25156,7 @@ paths: description: Response content: application/json: - schema: *175 + schema: *187 examples: default: value: @@ -23871,8 +25186,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-organization-variable parameters: - - *145 - - *176 + - *157 + - *188 requestBody: required: true content: @@ -23934,8 +25249,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-organization-variable parameters: - - *145 - - *176 + - *157 + - *188 responses: '204': description: Response @@ -23961,8 +25276,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: - - *145 - - *176 + - *157 + - *188 - *20 - *18 responses: @@ -23980,9 +25295,9 @@ paths: type: integer repositories: type: array - items: *163 + items: *175 examples: - default: *177 + default: *189 '409': description: Response when the visibility of the variable is not set to `selected` @@ -24008,8 +25323,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: - - *145 - - *176 + - *157 + - *188 requestBody: required: true content: @@ -24058,8 +25373,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: - - *145 - - *176 + - *157 + - *188 - name: repository_id in: path required: true @@ -24093,8 +25408,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: - - *145 - - *176 + - *157 + - *188 - name: repository_id in: path required: true @@ -24125,7 +25440,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#get-announcement-banner-for-organization parameters: - - *145 + - *157 responses: '200': description: Response @@ -24152,11 +25467,11 @@ paths: required: true content: application/json: - schema: *178 + schema: *190 examples: default: *63 parameters: - - *145 + - *157 responses: '200': description: Response @@ -24180,7 +25495,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#remove-announcement-banner-from-organization parameters: - - *145 + - *157 responses: '204': description: Response @@ -24208,7 +25523,7 @@ paths: - *18 - *76 - *77 - - *145 + - *157 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -24248,8 +25563,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: &378 + default: &385 value: attestations: - bundle: @@ -24367,7 +25684,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: - - *145 + - *157 - 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). @@ -24375,10 +25692,10 @@ paths: required: false schema: type: string - - *179 - - *180 - - *181 - - *182 + - *191 + - *192 + - *193 + - *194 - *18 responses: '200': @@ -24387,9 +25704,9 @@ paths: application/json: schema: type: array - items: *183 + items: *195 examples: - default: *184 + default: *196 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -24406,7 +25723,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *145 + - *157 - *18 - *20 responses: @@ -24418,7 +25735,7 @@ paths: type: array items: *19 examples: - default: &246 + default: &258 value: - login: octocat id: 1 @@ -24456,8 +25773,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: - - *145 - - &185 + - *157 + - &197 name: username description: The handle for the GitHub user account. in: path @@ -24488,8 +25805,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#block-a-user-from-an-organization parameters: - - *145 - - *185 + - *157 + - *197 responses: '204': description: Response @@ -24509,8 +25826,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - - *145 - - *185 + - *157 + - *197 responses: '204': description: Response @@ -24535,9 +25852,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: - - *145 - - *186 - - *187 + - *157 + - *198 + - *199 - *76 - *77 - *20 @@ -24548,7 +25865,7 @@ paths: be returned. in: query required: false - schema: *188 + schema: *200 - name: sort description: The property by which to sort the results. in: query @@ -24564,7 +25881,7 @@ paths: be returned. in: query required: false - schema: &405 + schema: &412 type: string description: Severity of a code scanning alert. enum: @@ -24582,13 +25899,13 @@ paths: application/json: schema: type: array - items: *189 + items: *201 examples: - default: *190 + default: *202 headers: Link: *39 '404': *7 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24610,7 +25927,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: - - *145 + - *157 - name: target_type in: query description: The target type of the code security configuration @@ -24638,7 +25955,7 @@ paths: application/json: schema: type: array - items: &191 + items: &203 type: object description: A code security configuration properties: @@ -24896,7 +26213,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#create-a-code-security-configuration parameters: - - *145 + - *157 requestBody: required: true content: @@ -24969,7 +26286,7 @@ paths: - disabled - not_set default: disabled - code_scanning_default_setup_options: &195 + code_scanning_default_setup_options: &207 type: object description: Feature options for code scanning default setup nullable: true @@ -25086,9 +26403,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *191 + schema: *203 examples: - default: &193 + default: &205 value: id: 1325 target_type: organization @@ -25137,7 +26454,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-default-code-security-configurations parameters: - - *145 + - *157 responses: '200': description: Response @@ -25157,7 +26474,7 @@ paths: description: The visibility of newly created repositories for which the code security configuration will be applied to by default - configuration: *191 + configuration: *203 examples: default: value: @@ -25247,7 +26564,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *145 + - *157 requestBody: required: true content: @@ -25270,11 +26587,11 @@ paths: - 32 - 91 responses: - '204': *192 + '204': *204 '400': *15 '403': *29 '404': *7 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25296,8 +26613,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-a-code-security-configuration parameters: - - *145 - - &194 + - *157 + - &206 name: configuration_id description: The unique identifier of the code security configuration. in: path @@ -25309,9 +26626,9 @@ paths: description: Response content: application/json: - schema: *191 + schema: *203 examples: - default: *193 + default: *205 '304': *37 '403': *29 '404': *7 @@ -25335,8 +26652,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-code-security-configuration parameters: - - *145 - - *194 + - *157 + - *206 requestBody: required: true content: @@ -25402,7 +26719,7 @@ paths: - enabled - disabled - not_set - code_scanning_default_setup_options: *195 + code_scanning_default_setup_options: *207 secret_scanning: type: string description: The enablement status of secret scanning @@ -25489,7 +26806,7 @@ paths: description: Response when a configuration is updated content: application/json: - schema: *191 + schema: *203 examples: default: value: @@ -25543,14 +26860,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *145 - - *194 + - *157 + - *206 responses: - '204': *192 + '204': *204 '400': *15 '403': *29 '404': *7 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25574,8 +26891,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *145 - - *194 + - *157 + - *206 requestBody: required: true content: @@ -25614,7 +26931,7 @@ paths: - 32 - 91 responses: - '202': *151 + '202': *163 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25638,8 +26955,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: - - *145 - - *194 + - *157 + - *206 requestBody: required: true content: @@ -25679,12 +26996,12 @@ paths: - none - private_and_internal - public - configuration: *191 + configuration: *203 examples: default: value: default_for_new_repos: all - configuration: *193 + configuration: *205 '403': *29 '404': *7 x-github: @@ -25708,8 +27025,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: - - *145 - - *194 + - *157 + - *206 - 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)." @@ -25852,7 +27169,7 @@ paths: parameters: - *18 - *20 - - *145 + - *157 responses: '200': description: Response @@ -25868,7 +27185,7 @@ paths: type: integer codespaces: type: array - items: &247 + items: &259 type: object title: Codespace description: A codespace. @@ -25893,12 +27210,12 @@ paths: nullable: true owner: *19 billable_owner: *19 - repository: *163 + repository: *175 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &431 + properties: &438 name: type: string description: The name of the machine. @@ -25940,7 +27257,7 @@ paths: - ready - in_progress nullable: true - required: &432 + required: &439 - name - display_name - operating_system @@ -26145,7 +27462,7 @@ paths: - pulls_url - recent_folders examples: - default: &248 + default: &260 value: total_count: 3 codespaces: @@ -26577,7 +27894,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *145 + - *157 deprecated: true requestBody: required: true @@ -26644,7 +27961,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: - - *145 + - *157 deprecated: true requestBody: required: true @@ -26699,7 +28016,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *145 + - *157 requestBody: required: true content: @@ -26751,7 +28068,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *145 + - *157 - *18 - *20 responses: @@ -26769,7 +28086,7 @@ paths: type: integer secrets: type: array - items: &196 + items: &208 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -26808,7 +28125,7 @@ paths: - updated_at - visibility examples: - default: &433 + default: &440 value: total_count: 2 secrets: @@ -26840,13 +28157,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *145 + - *157 responses: '200': description: Response content: application/json: - schema: &434 + schema: &441 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -26875,7 +28192,7 @@ paths: - key_id - key examples: - default: &435 + default: &442 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -26898,16 +28215,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *145 - - *173 + - *157 + - *185 responses: '200': description: Response content: application/json: - schema: *196 + schema: *208 examples: - default: &437 + default: &444 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -26934,8 +28251,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: - - *145 - - *173 + - *157 + - *185 requestBody: required: true content: @@ -26990,7 +28307,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -27016,8 +28333,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *145 - - *173 + - *157 + - *185 responses: '204': description: Response @@ -27042,8 +28359,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: - - *145 - - *173 + - *157 + - *185 - *20 - *18 responses: @@ -27061,9 +28378,9 @@ paths: type: integer repositories: type: array - items: *163 + items: *175 examples: - default: *177 + default: *189 '404': *7 x-github: githubCloudOnly: false @@ -27085,8 +28402,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: - - *145 - - *173 + - *157 + - *185 requestBody: required: true content: @@ -27136,8 +28453,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: - - *145 - - *173 + - *157 + - *185 - name: repository_id in: path required: true @@ -27170,8 +28487,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: - - *145 - - *173 + - *157 + - *185 - name: repository_id in: path required: true @@ -27210,7 +28527,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: - - *145 + - *157 responses: '200': description: OK @@ -27353,7 +28670,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: - - *145 + - *157 - *20 - name: per_page description: The number of results per page (max 100). For more information, @@ -27376,9 +28693,9 @@ paths: currently being billed. seats: type: array - items: *197 + items: *209 examples: - default: *198 + default: *210 headers: Link: *39 '500': *84 @@ -27414,7 +28731,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: - - *145 + - *157 requestBody: content: application/json: @@ -27492,7 +28809,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: - - *145 + - *157 requestBody: content: application/json: @@ -27572,7 +28889,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: - - *145 + - *157 requestBody: content: application/json: @@ -27649,7 +28966,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: - - *145 + - *157 requestBody: content: application/json: @@ -27730,7 +29047,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: - - *145 + - *157 - 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`). @@ -27762,13 +29079,13 @@ paths: application/json: schema: type: array - items: *102 + items: *114 examples: - default: *103 + default: *115 '500': *84 '403': *29 '404': *7 - '422': *104 + '422': *116 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27799,7 +29116,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: - - *145 + - *157 - 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`). @@ -27831,9 +29148,9 @@ paths: application/json: schema: type: array - items: *105 + items: *117 examples: - default: *199 + default: *211 '500': *84 '401': *25 '403': *29 @@ -27859,7 +29176,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: - - *145 + - *157 - *18 - name: page description: Page token @@ -28003,7 +29320,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: - - *145 + - *157 - name: credential_id in: path required: true @@ -28034,7 +29351,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: - - *145 + - *157 responses: '200': description: Response - list of custom role names @@ -28049,7 +29366,7 @@ paths: type: integer custom_roles: type: array - items: *200 + items: *212 examples: default: value: @@ -28136,12 +29453,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role parameters: - - *145 + - *157 requestBody: required: true content: application/json: - schema: &203 + schema: &215 type: object properties: name: @@ -28182,9 +29499,9 @@ paths: description: Response content: application/json: - schema: *200 + schema: *212 examples: - default: *201 + default: *213 '422': *16 '404': *7 x-github: @@ -28208,8 +29525,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role parameters: - - *145 - - &202 + - *157 + - &214 name: role_id description: The unique identifier of the role. in: path @@ -28221,9 +29538,9 @@ paths: description: Response content: application/json: - schema: *200 + schema: *212 examples: - default: *201 + default: *213 '404': *7 x-github: githubCloudOnly: true @@ -28245,13 +29562,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role parameters: - - *145 - - *202 + - *157 + - *214 requestBody: required: true content: application/json: - schema: &204 + schema: &216 type: object properties: name: @@ -28289,9 +29606,9 @@ paths: description: Response content: application/json: - schema: *200 + schema: *212 examples: - default: *201 + default: *213 '422': *16 '404': *7 x-github: @@ -28315,8 +29632,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role parameters: - - *145 - - *202 + - *157 + - *214 responses: '204': description: Response @@ -28344,12 +29661,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: - - *145 + - *157 requestBody: required: true content: application/json: - schema: *203 + schema: *215 examples: default: value: @@ -28363,9 +29680,9 @@ paths: description: Response content: application/json: - schema: *200 + schema: *212 examples: - default: *201 + default: *213 '422': *16 '404': *7 x-github: @@ -28395,16 +29712,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: - - *145 - - *202 + - *157 + - *214 responses: '200': description: Response content: application/json: - schema: *200 + schema: *212 examples: - default: *201 + default: *213 '404': *7 x-github: githubCloudOnly: true @@ -28432,13 +29749,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: - - *145 - - *202 + - *157 + - *214 requestBody: required: true content: application/json: - schema: *204 + schema: *216 examples: default: value: @@ -28453,9 +29770,9 @@ paths: description: Response content: application/json: - schema: *200 + schema: *212 examples: - default: *201 + default: *213 '422': *16 '404': *7 x-github: @@ -28485,8 +29802,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: - - *145 - - *202 + - *157 + - *214 responses: '204': description: Response @@ -28514,18 +29831,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *145 - - *205 - - *206 - - *207 - - *208 - - *209 - - *210 + - *157 + - *217 + - *218 + - *219 + - *220 + - *221 + - *222 - *78 - *76 - *77 - - *211 - - *212 + - *223 + - *224 - *18 responses: '200': @@ -28534,9 +29851,9 @@ paths: application/json: schema: type: array - items: *213 + items: *225 examples: - default: *214 + default: *226 '304': *37 '400': *15 '403': *29 @@ -28562,7 +29879,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-organization-secrets parameters: - - *145 + - *157 - *18 - *20 responses: @@ -28580,7 +29897,7 @@ paths: type: integer secrets: type: array - items: &215 + items: &227 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -28651,13 +29968,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-public-key parameters: - - *145 + - *157 responses: '200': description: Response content: application/json: - schema: &464 + schema: &471 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -28674,7 +29991,7 @@ paths: - key_id - key examples: - default: &465 + default: &472 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -28697,14 +30014,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-secret parameters: - - *145 - - *173 + - *157 + - *185 responses: '200': description: Response content: application/json: - schema: *215 + schema: *227 examples: default: value: @@ -28732,8 +30049,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *145 - - *173 + - *157 + - *185 requestBody: required: true content: @@ -28788,7 +30105,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -28812,8 +30129,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-an-organization-secret parameters: - - *145 - - *173 + - *157 + - *185 responses: '204': description: Response @@ -28837,8 +30154,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: - - *145 - - *173 + - *157 + - *185 - *20 - *18 responses: @@ -28856,9 +30173,9 @@ paths: type: integer repositories: type: array - items: *163 + items: *175 examples: - default: *177 + default: *189 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28879,8 +30196,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: - - *145 - - *173 + - *157 + - *185 requestBody: required: true content: @@ -28930,8 +30247,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: - - *145 - - *173 + - *157 + - *185 - name: repository_id in: path required: true @@ -28962,8 +30279,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: - - *145 - - *173 + - *157 + - *185 - name: repository_id in: path required: true @@ -28993,7 +30310,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: - - *145 + - *157 responses: '200': description: Response @@ -29001,7 +30318,7 @@ paths: application/json: schema: type: array - items: &259 + items: &271 title: Package description: A software package type: object @@ -29051,8 +30368,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *216 - required: *217 + properties: *228 + required: *229 nullable: true created_at: type: string @@ -29071,7 +30388,7 @@ paths: - created_at - updated_at examples: - default: &260 + default: &272 value: - id: 197 name: hello_docker @@ -29149,7 +30466,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-organization-events parameters: - - *145 + - *157 - *18 - *20 responses: @@ -29159,7 +30476,7 @@ paths: application/json: schema: type: array - items: *134 + items: *146 examples: 200-response: value: @@ -29229,7 +30546,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#get-an-external-group parameters: - - *145 + - *157 - name: group_id description: The unique identifier of the group. in: path @@ -29255,7 +30572,7 @@ paths: description: Response content: application/json: - schema: &320 + schema: &327 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -29336,7 +30653,7 @@ paths: example: mona_lisa@github.com type: string examples: - default: &321 + default: &328 value: group_id: '123' group_name: Octocat admins @@ -29374,7 +30691,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: - - *145 + - *157 - *18 - name: page description: Page token @@ -29391,7 +30708,7 @@ paths: description: Response content: application/json: - schema: &318 + schema: &325 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -29428,7 +30745,7 @@ paths: example: 2019-06-03 22:27:15:000 -700 type: string examples: - default: &319 + default: &326 value: groups: - group_id: '123' @@ -29462,7 +30779,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-failed-organization-invitations parameters: - - *145 + - *157 - *18 - *20 responses: @@ -29472,7 +30789,7 @@ paths: application/json: schema: type: array - items: &240 + items: &252 title: Organization Invitation description: Organization Invitation type: object @@ -29519,7 +30836,7 @@ paths: - invitation_teams_url - node_id examples: - default: &241 + default: &253 value: - id: 1 login: monalisa @@ -29578,7 +30895,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: - - *145 + - *157 responses: '200': description: Response @@ -29586,7 +30903,7 @@ paths: application/json: schema: type: array - items: &277 + items: &290 title: Repository Fine-Grained Permission description: A fine-grained permission that protects repository resources. @@ -29600,7 +30917,7 @@ paths: - name - description examples: - default: &278 + default: &291 value: - name: add_assignee description: Assign or remove a user @@ -29631,7 +30948,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-organization-webhooks parameters: - - *145 + - *157 - *18 - *20 responses: @@ -29641,7 +30958,7 @@ paths: application/json: schema: type: array - items: &218 + items: &230 title: Org Hook description: Org Hook type: object @@ -29750,7 +31067,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#create-an-organization-webhook parameters: - - *145 + - *157 requestBody: required: true content: @@ -29810,9 +31127,9 @@ paths: description: Response content: application/json: - schema: *218 + schema: *230 examples: - default: &219 + default: &231 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -29856,8 +31173,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-an-organization-webhook parameters: - - *145 - - &220 + - *157 + - &232 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. @@ -29870,9 +31187,9 @@ paths: description: Response content: application/json: - schema: *218 + schema: *230 examples: - default: *219 + default: *231 '404': *7 x-github: githubCloudOnly: false @@ -29893,8 +31210,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-an-organization-webhook parameters: - - *145 - - *220 + - *157 + - *232 requestBody: required: false content: @@ -29939,7 +31256,7 @@ paths: description: Response content: application/json: - schema: *218 + schema: *230 examples: default: value: @@ -29978,8 +31295,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *145 - - *220 + - *157 + - *232 responses: '204': description: Response @@ -30004,8 +31321,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: - - *145 - - *220 + - *157 + - *232 responses: '200': description: Response @@ -30033,8 +31350,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: - - *145 - - *220 + - *157 + - *232 requestBody: required: false content: @@ -30082,10 +31399,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *145 - - *220 + - *157 + - *232 - *18 - - *221 + - *233 responses: '200': description: Response @@ -30093,9 +31410,9 @@ paths: application/json: schema: type: array - items: *222 + items: *234 examples: - default: *223 + default: *235 '400': *15 '422': *16 x-github: @@ -30118,17 +31435,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: - - *145 - - *220 + - *157 + - *232 - *17 responses: '200': description: Response content: application/json: - schema: *224 + schema: *236 examples: - default: *225 + default: *237 '400': *15 '422': *16 x-github: @@ -30151,11 +31468,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: - - *145 - - *220 + - *157 + - *232 - *17 responses: - '202': *151 + '202': *163 '400': *15 '422': *16 x-github: @@ -30178,8 +31495,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *145 - - *220 + - *157 + - *232 responses: '204': description: Response @@ -30201,8 +31518,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-route-stats-by-actor parameters: - - *145 - - &230 + - *157 + - &242 name: actor_type in: path description: The type of the actor @@ -30215,14 +31532,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &231 + - &243 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &226 + - &238 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`.' @@ -30230,7 +31547,7 @@ paths: required: true schema: type: string - - &227 + - &239 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) @@ -30323,13 +31640,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-subject-stats parameters: - - *145 - - *226 - - *227 + - *157 + - *238 + - *239 - *20 - *18 - *78 - - &236 + - &248 name: sort description: The property to sort the results by. in: query @@ -30407,15 +31724,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats parameters: - - *145 - - *226 - - *227 + - *157 + - *238 + - *239 responses: '200': description: Response content: application/json: - schema: &228 + schema: &240 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -30431,7 +31748,7 @@ paths: type: integer format: int64 examples: - default: &229 + default: &241 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -30451,24 +31768,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-user parameters: - - *145 - - &232 + - *157 + - &244 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *226 - - *227 + - *238 + - *239 responses: '200': description: Response content: application/json: - schema: *228 + schema: *240 examples: - default: *229 + default: *241 x-github: enabledForGitHubApps: true category: orgs @@ -30486,19 +31803,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-actor parameters: - - *145 - - *226 - - *227 - - *230 - - *231 + - *157 + - *238 + - *239 + - *242 + - *243 responses: '200': description: Response content: application/json: - schema: *228 + schema: *240 examples: - default: *229 + default: *241 x-github: enabledForGitHubApps: true category: orgs @@ -30515,10 +31832,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats parameters: - - *145 - - *226 - - *227 - - &233 + - *157 + - *238 + - *239 + - &245 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -30531,7 +31848,7 @@ paths: description: Response content: application/json: - schema: &234 + schema: &246 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -30547,7 +31864,7 @@ paths: type: integer format: int64 examples: - default: &235 + default: &247 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -30583,19 +31900,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-user parameters: - - *145 - - *232 - - *226 - - *227 - - *233 + - *157 + - *244 + - *238 + - *239 + - *245 responses: '200': description: Response content: application/json: - schema: *234 + schema: *246 examples: - default: *235 + default: *247 x-github: enabledForGitHubApps: true category: orgs @@ -30612,20 +31929,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-actor parameters: - - *145 - - *230 - - *231 - - *226 - - *227 - - *233 + - *157 + - *242 + - *243 + - *238 + - *239 + - *245 responses: '200': description: Response content: application/json: - schema: *234 + schema: *246 examples: - default: *235 + default: *247 x-github: enabledForGitHubApps: true category: orgs @@ -30642,14 +31959,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-user-stats parameters: - - *145 - - *232 - - *226 - - *227 + - *157 + - *244 + - *238 + - *239 - *20 - *18 - *78 - - *236 + - *248 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -30722,7 +32039,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: - - *145 + - *157 responses: '200': description: Response @@ -30730,7 +32047,7 @@ paths: application/json: schema: *22 examples: - default: &503 + default: &510 value: id: 1 account: @@ -30799,7 +32116,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *145 + - *157 - *18 - *20 responses: @@ -30888,7 +32205,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *145 + - *157 responses: '200': description: Response @@ -30896,12 +32213,12 @@ paths: application/json: schema: anyOf: - - &238 + - &250 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &237 + limit: &249 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -30926,7 +32243,7 @@ paths: properties: {} additionalProperties: false examples: - default: &239 + default: &251 value: limit: collaborators_only origin: organization @@ -30950,18 +32267,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *145 + - *157 requestBody: required: true content: application/json: - schema: &504 + schema: &511 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *237 + limit: *249 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -30985,9 +32302,9 @@ paths: description: Response content: application/json: - schema: *238 + schema: *250 examples: - default: *239 + default: *251 '422': *16 x-github: githubCloudOnly: false @@ -31005,7 +32322,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *145 + - *157 responses: '204': description: Response @@ -31031,7 +32348,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-pending-organization-invitations parameters: - - *145 + - *157 - *18 - *20 - name: role @@ -31065,9 +32382,9 @@ paths: application/json: schema: type: array - items: *240 + items: *252 examples: - default: *241 + default: *253 headers: Link: *39 '404': *7 @@ -31091,7 +32408,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#create-an-organization-invitation parameters: - - *145 + - *157 requestBody: required: false content: @@ -31145,7 +32462,7 @@ paths: description: Response content: application/json: - schema: *240 + schema: *252 examples: default: value: @@ -31201,8 +32518,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#cancel-an-organization-invitation parameters: - - *145 - - &242 + - *157 + - &254 name: invitation_id description: The unique identifier of the invitation. in: path @@ -31235,8 +32552,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-invitation-teams parameters: - - *145 - - *242 + - *157 + - *254 - *18 - *20 responses: @@ -31246,9 +32563,9 @@ paths: application/json: schema: type: array - items: *243 + items: *255 examples: - default: &258 + default: &270 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -31293,7 +32610,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: - - *145 + - *157 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -31323,7 +32640,7 @@ paths: - closed - all default: open - - *244 + - *256 - name: sort description: What to sort results by. in: query @@ -31336,7 +32653,7 @@ paths: - comments default: created - *78 - - *112 + - *124 - *18 - *20 responses: @@ -31346,9 +32663,9 @@ paths: application/json: schema: type: array - items: *122 + items: *134 examples: - default: *245 + default: *257 headers: Link: *39 '404': *7 @@ -31370,7 +32687,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-members parameters: - - *145 + - *157 - 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) @@ -31406,7 +32723,7 @@ paths: type: array items: *19 examples: - default: *246 + default: *258 headers: Link: *39 '422': *16 @@ -31426,8 +32743,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-organization-membership-for-a-user parameters: - - *145 - - *185 + - *157 + - *197 responses: '204': description: Response if requester is an organization member and user is @@ -31458,8 +32775,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-an-organization-member parameters: - - *145 - - *185 + - *157 + - *197 responses: '204': description: Response @@ -31485,8 +32802,8 @@ paths: parameters: - *18 - *20 - - *145 - - *185 + - *157 + - *197 responses: '200': description: Response @@ -31502,9 +32819,9 @@ paths: type: integer codespaces: type: array - items: *247 + items: *259 examples: - default: *248 + default: *260 '304': *37 '500': *84 '401': *25 @@ -31529,9 +32846,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - - *145 - - *185 - - &249 + - *157 + - *197 + - &261 name: codespace_name in: path required: true @@ -31539,7 +32856,7 @@ paths: schema: type: string responses: - '202': *151 + '202': *163 '304': *37 '500': *84 '401': *25 @@ -31564,17 +32881,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: - - *145 - - *185 - - *249 + - *157 + - *197 + - *261 responses: '200': description: Response content: application/json: - schema: *247 + schema: *259 examples: - default: &430 + default: &437 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -31747,14 +33064,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: - - *145 - - *185 + - *157 + - *197 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *197 + schema: *209 examples: default: value: @@ -31822,14 +33139,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user parameters: - - *145 - - *185 + - *157 + - *197 responses: '200': description: Response content: application/json: - schema: &250 + schema: &262 title: Org Membership description: Org Membership type: object @@ -31881,7 +33198,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &251 + response-if-user-has-an-active-admin-membership-with-organization: &263 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -31949,8 +33266,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-organization-membership-for-a-user parameters: - - *145 - - *185 + - *157 + - *197 requestBody: required: false content: @@ -31978,9 +33295,9 @@ paths: description: Response content: application/json: - schema: *250 + schema: *262 examples: - response-if-user-already-had-membership-with-organization: *251 + response-if-user-already-had-membership-with-organization: *263 '422': *16 '403': *29 x-github: @@ -32001,8 +33318,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-organization-membership-for-a-user parameters: - - *145 - - *185 + - *157 + - *197 responses: '204': description: Response @@ -32027,7 +33344,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-organization-migrations parameters: - - *145 + - *157 - *18 - *20 - name: exclude @@ -32048,7 +33365,7 @@ paths: application/json: schema: type: array - items: &252 + items: &264 title: Migration description: A migration. type: object @@ -32301,7 +33618,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#start-an-organization-migration parameters: - - *145 + - *157 requestBody: required: true content: @@ -32377,7 +33694,7 @@ paths: description: Response content: application/json: - schema: *252 + schema: *264 examples: default: value: @@ -32555,8 +33872,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#get-an-organization-migration-status parameters: - - *145 - - &253 + - *157 + - &265 name: migration_id description: The unique identifier of the migration. in: path @@ -32583,7 +33900,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *252 + schema: *264 examples: default: value: @@ -32752,8 +34069,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *145 - - *253 + - *157 + - *265 responses: '302': description: Response @@ -32774,8 +34091,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *145 - - *253 + - *157 + - *265 responses: '204': description: Response @@ -32798,9 +34115,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#unlock-an-organization-repository parameters: - - *145 - - *253 - - &675 + - *157 + - *265 + - &682 name: repo_name description: repo_name parameter in: path @@ -32827,8 +34144,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *145 - - *253 + - *157 + - *265 - *18 - *20 responses: @@ -32838,9 +34155,9 @@ paths: application/json: schema: type: array - items: *163 + items: *175 examples: - default: &265 + default: &277 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -32979,7 +34296,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: - - *145 + - *157 responses: '200': description: Response @@ -33033,7 +34350,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: - - *145 + - *157 responses: '200': description: Response - list of organization roles @@ -33049,7 +34366,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &254 + items: &266 title: Organization Role description: Organization roles type: object @@ -33209,7 +34526,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#create-a-custom-organization-role parameters: - - *145 + - *157 requestBody: required: true content: @@ -33256,7 +34573,7 @@ paths: description: Response content: application/json: - schema: *254 + schema: *266 examples: default: value: @@ -33285,7 +34602,7 @@ paths: updated_at: '2022-07-04T22:19:11Z' '422': *16 '404': *7 - '409': *150 + '409': *162 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -33307,8 +34624,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: - - *145 - - *255 + - *157 + - *267 responses: '204': description: Response @@ -33333,9 +34650,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: - - *145 - - *255 - - *202 + - *157 + - *267 + - *214 responses: '204': description: Response @@ -33364,9 +34681,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: - - *145 - - *255 - - *202 + - *157 + - *267 + - *214 responses: '204': description: Response @@ -33391,8 +34708,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: - - *145 - - *185 + - *157 + - *197 responses: '204': description: Response @@ -33417,9 +34734,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: - - *145 - - *185 - - *202 + - *157 + - *197 + - *214 responses: '204': description: Response @@ -33449,9 +34766,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: - - *145 - - *185 - - *202 + - *157 + - *197 + - *214 responses: '204': description: Response @@ -33479,14 +34796,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-an-organization-role parameters: - - *145 - - *202 + - *157 + - *214 responses: '200': description: Response content: application/json: - schema: *254 + schema: *266 examples: default: value: @@ -33543,8 +34860,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#update-a-custom-organization-role parameters: - - *145 - - *202 + - *157 + - *214 requestBody: required: true content: @@ -33583,7 +34900,7 @@ paths: description: Response content: application/json: - schema: *254 + schema: *266 examples: default: value: @@ -33611,7 +34928,7 @@ paths: created_at: '2022-07-04T22:19:11Z' updated_at: '2022-07-04T22:19:11Z' '422': *16 - '409': *150 + '409': *162 '404': *7 x-github: githubCloudOnly: true @@ -33636,8 +34953,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#delete-a-custom-organization-role parameters: - - *145 - - *202 + - *157 + - *214 responses: '204': description: Response @@ -33662,8 +34979,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: - - *145 - - *202 + - *157 + - *214 - *18 - *20 responses: @@ -33741,8 +35058,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *256 - required: *257 + properties: *268 + required: *269 nullable: true required: - id @@ -33757,7 +35074,7 @@ paths: - slug - parent examples: - default: *258 + default: *270 headers: Link: *39 '404': @@ -33786,8 +35103,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: - - *145 - - *202 + - *157 + - *214 - *18 - *20 responses: @@ -33815,13 +35132,13 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: &297 + items: &304 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *256 - required: *257 + properties: *268 + required: *269 name: nullable: true type: string @@ -33916,7 +35233,7 @@ paths: - type - url examples: - default: *246 + default: *258 headers: Link: *39 '404': @@ -33940,7 +35257,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: - - *145 + - *157 - 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) @@ -33964,7 +35281,7 @@ paths: type: array items: *19 examples: - default: *246 + default: *258 headers: Link: *39 x-github: @@ -33989,8 +35306,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: - - *145 - - *185 + - *157 + - *197 requestBody: required: false content: @@ -34047,8 +35364,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: - - *145 - - *185 + - *157 + - *197 responses: '204': description: Response @@ -34105,8 +35422,8 @@ paths: - docker - nuget - container - - *145 - - &677 + - *157 + - &684 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -34142,12 +35459,12 @@ paths: application/json: schema: type: array - items: *259 + items: *271 examples: - default: *260 + default: *272 '403': *29 '401': *25 - '400': &679 + '400': &686 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -34169,7 +35486,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-an-organization parameters: - - &261 + - &273 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 @@ -34187,20 +35504,20 @@ paths: - docker - nuget - container - - &262 + - &274 name: package_name description: The name of the package. in: path required: true schema: type: string - - *145 + - *157 responses: '200': description: Response content: application/json: - schema: *259 + schema: *271 examples: default: value: @@ -34252,9 +35569,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-an-organization parameters: - - *261 - - *262 - - *145 + - *273 + - *274 + - *157 responses: '204': description: Response @@ -34286,9 +35603,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-an-organization parameters: - - *261 - - *262 - - *145 + - *273 + - *274 + - *157 - name: token description: package token schema: @@ -34320,9 +35637,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: - - *261 - - *262 - - *145 + - *273 + - *274 + - *157 - *20 - *18 - name: state @@ -34342,7 +35659,7 @@ paths: application/json: schema: type: array - items: &263 + items: &275 title: Package Version description: A version of a software package type: object @@ -34467,10 +35784,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: - - *261 - - *262 - - *145 - - &264 + - *273 + - *274 + - *157 + - &276 name: package_version_id description: Unique identifier of the package version. in: path @@ -34482,7 +35799,7 @@ paths: description: Response content: application/json: - schema: *263 + schema: *275 examples: default: value: @@ -34518,10 +35835,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-an-organization parameters: - - *261 - - *262 - - *145 - - *264 + - *273 + - *274 + - *157 + - *276 responses: '204': description: Response @@ -34553,10 +35870,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-an-organization parameters: - - *261 - - *262 - - *145 - - *264 + - *273 + - *274 + - *157 + - *276 responses: '204': description: Response @@ -34583,10 +35900,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: - - *145 + - *157 - *18 - *20 - - &266 + - &278 name: sort description: The property by which to sort the results. in: query @@ -34597,7 +35914,7 @@ paths: - created_at default: created_at - *78 - - &267 + - &279 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -34608,7 +35925,7 @@ paths: items: type: string example: owner[]=octocat1,owner[]=octocat2 - - &268 + - &280 name: repository description: The name of the repository to use to filter the results. in: query @@ -34616,7 +35933,7 @@ paths: schema: type: string example: Hello-World - - &269 + - &281 name: permission description: The permission to use to filter the results. in: query @@ -34624,7 +35941,7 @@ paths: schema: type: string example: issues_read - - &270 + - &282 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) @@ -34634,7 +35951,7 @@ paths: schema: type: string format: date-time - - &271 + - &283 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) @@ -34797,7 +36114,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: - - *145 + - *157 requestBody: required: true content: @@ -34842,7 +36159,7 @@ paths: '422': *16 '404': *7 '403': *29 - '202': *151 + '202': *163 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34863,7 +36180,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: - - *145 + - *157 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -34903,7 +36220,7 @@ paths: '422': *16 '404': *7 '403': *29 - '204': *192 + '204': *204 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34924,7 +36241,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: - - *145 + - *157 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -34944,9 +36261,9 @@ paths: application/json: schema: type: array - items: *163 + items: *175 examples: - default: *265 + default: *277 headers: Link: *39 x-github: @@ -34969,16 +36286,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: - - *145 + - *157 - *18 - *20 - - *266 + - *278 - *78 - - *267 - - *268 - - *269 - - *270 - - *271 + - *279 + - *280 + - *281 + - *282 + - *283 responses: '500': *84 '422': *16 @@ -35127,7 +36444,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: - - *145 + - *157 requestBody: required: true content: @@ -35164,7 +36481,7 @@ paths: responses: '500': *84 '404': *7 - '202': *151 + '202': *163 '403': *29 '422': *16 x-github: @@ -35187,7 +36504,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: - - *145 + - *157 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -35217,7 +36534,7 @@ paths: responses: '500': *84 '404': *7 - '204': *192 + '204': *204 '403': *29 '422': *16 x-github: @@ -35239,7 +36556,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: - - *145 + - *157 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -35258,9 +36575,9 @@ paths: application/json: schema: type: array - items: *163 + items: *175 examples: - default: *265 + default: *277 headers: Link: *39 x-github: @@ -35282,7 +36599,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-organization-projects parameters: - - *145 + - *157 - name: state description: Indicates the state of the projects to return. in: query @@ -35303,7 +36620,7 @@ paths: application/json: schema: type: array - items: &272 + items: &284 title: Project description: Projects are a way to organize columns and cards of work. @@ -35447,7 +36764,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#create-an-organization-project parameters: - - *145 + - *157 requestBody: required: true content: @@ -35473,7 +36790,7 @@ paths: description: Response content: application/json: - schema: *272 + schema: *284 examples: default: value: @@ -35511,7 +36828,7 @@ paths: '401': *25 '403': *29 '404': *7 - '410': &336 + '410': &343 description: Gone content: application/json: @@ -35535,7 +36852,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: - - *145 + - *157 responses: '200': description: Response @@ -35568,7 +36885,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: - - *145 + - *157 requestBody: required: true content: @@ -35632,7 +36949,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: - - *145 + - *157 - *98 responses: '200': @@ -35664,51 +36981,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: - - *145 + - *157 - *98 requestBody: required: true content: application/json: - schema: - type: object - properties: - value_type: - type: string - example: single_select - enum: - - string - - single_select - - multi_select - - true_false - description: The type of the value for the property - required: - type: boolean - description: Whether the property is required. - default_value: - oneOf: - - type: string - - type: array - items: - type: string - nullable: true - description: Default value of the property - description: - type: string - nullable: true - description: Short description of the property - allowed_values: - type: array - items: - type: string - maxLength: 75 - maxItems: 200 - nullable: true - description: |- - An ordered list of the allowed values of the property. - The property can have up to 200 allowed values. - required: - - value_type + schema: *285 examples: default: value: @@ -35749,10 +37028,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: - - *145 + - *157 - *98 responses: - '204': *192 + '204': *204 '403': *29 '404': *7 x-github: @@ -35773,7 +37052,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: - - *145 + - *157 - *18 - *20 - name: repository_query @@ -35811,7 +37090,7 @@ paths: example: octocat/Hello-World properties: type: array - items: &273 + items: &286 title: Custom Property Value description: Custom property name and associated value type: object @@ -35878,7 +37157,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: - - *145 + - *157 requestBody: required: true content: @@ -35898,7 +37177,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *273 + items: *286 required: - repository_names - properties @@ -35939,7 +37218,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-public-organization-members parameters: - - *145 + - *157 - *18 - *20 responses: @@ -35951,7 +37230,7 @@ paths: type: array items: *19 examples: - default: *246 + default: *258 headers: Link: *39 x-github: @@ -35970,8 +37249,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: - - *145 - - *185 + - *157 + - *197 responses: '204': description: Response if user is a public member @@ -35995,8 +37274,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: - - *145 - - *185 + - *157 + - *197 responses: '204': description: Response @@ -36017,8 +37296,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: - - *145 - - *185 + - *157 + - *197 responses: '204': description: Response @@ -36042,7 +37321,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-organization-repositories parameters: - - *145 + - *157 - 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 @@ -36089,9 +37368,9 @@ paths: application/json: schema: type: array - items: *163 + items: *175 examples: - default: *265 + default: *277 headers: Link: *39 x-github: @@ -36112,7 +37391,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-organization-repository parameters: - - *145 + - *157 requestBody: required: true content: @@ -36294,7 +37573,7 @@ paths: description: Response content: application/json: - schema: &338 + schema: &345 title: Full Repository description: Full Repository type: object @@ -36571,8 +37850,8 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: *274 - required: *275 + properties: *287 + required: *288 nullable: true temp_clone_token: type: string @@ -36659,8 +37938,8 @@ paths: title: License Simple description: License Simple type: object - properties: *123 - required: *124 + properties: *135 + required: *136 nullable: true organization: title: Simple User @@ -36687,7 +37966,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &452 + properties: &459 url: type: string format: uri @@ -36703,12 +37982,12 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &453 + required: &460 - url - key - name - html_url - security_and_analysis: *276 + security_and_analysis: *289 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -36792,7 +38071,7 @@ paths: - network_count - subscribers_count examples: - default: &340 + default: &347 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -37310,7 +38589,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: - - *145 + - *157 responses: '200': description: Response @@ -37318,9 +38597,9 @@ paths: application/json: schema: type: array - items: *277 + items: *290 examples: - default: *278 + default: *291 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -37342,10 +38621,10 @@ paths: category: orgs subcategory: rules parameters: - - *145 + - *157 - *18 - *20 - - &588 + - &595 name: targets description: | A comma-separated list of rule targets to filter by. @@ -37363,931 +38642,7 @@ paths: application/json: schema: type: array - items: &285 - 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: &281 - 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: &282 - 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 - nullable: true - 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 - nullable: true - properties: - href: - type: string - description: The html URL of the ruleset - conditions: - nullable: true - anyOf: - - &279 - 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 - - &283 - 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: - - *279 - - 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: - - *279 - - 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: - - *279 - - 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: &280 - 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: *280 - required: - - repository_property - rules: - type: array - items: &284 - title: Repository Rule - type: object - description: A repository rule. - oneOf: - - &570 - title: creation - description: Only allow users with bypass permission to - create matching refs. - type: object - required: - - type - properties: - type: - type: string - enum: - - creation - - &571 - 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 - - &573 - title: deletion - description: Only allow users with bypass permissions to - delete matching refs. - type: object - required: - - type - properties: - type: - type: string - enum: - - deletion - - &574 - 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 - - &575 - 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 - - &576 - 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 - - &577 - title: required_signatures - description: Commits pushed to matching refs must have verified - signatures. - type: object - required: - - type - properties: - type: - type: string - enum: - - required_signatures - - &578 - 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 - - &579 - 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 - - &580 - 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 - - &581 - 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 - - &582 - 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 - - &583 - 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 - - &584 - 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 - - &585 - 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 - - &586 - 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 - - &587 - 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: *109 examples: default: value: @@ -38334,7 +38689,7 @@ paths: category: orgs subcategory: rules parameters: - - *145 + - *157 requestBody: description: Request body required: true @@ -38353,17 +38708,18 @@ paths: - branch - tag - push + - repository default: branch - enforcement: *281 + enforcement: *106 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *282 - conditions: *283 + items: *107 + conditions: *292 rules: type: array description: An array of rules within the ruleset. - items: *284 + items: *108 required: - name - enforcement @@ -38401,9 +38757,9 @@ paths: description: Response content: application/json: - schema: *285 + schema: *109 examples: - default: &286 + default: &293 value: id: 21 name: super cool ruleset @@ -38457,8 +38813,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *145 - - &589 + - *157 + - &596 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 @@ -38473,7 +38829,7 @@ paths: in: query schema: type: string - - &590 + - &597 name: time_period description: |- The time period to filter by. @@ -38489,14 +38845,14 @@ paths: - week - month default: day - - &591 + - &598 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 - - &592 + - &599 name: rule_suite_result description: The rule results to filter on. When specified, only suites with this result will be returned. @@ -38516,7 +38872,7 @@ paths: description: Response content: application/json: - schema: &593 + schema: &600 title: Rule Suites description: Response type: array @@ -38571,7 +38927,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &594 + default: &601 value: - id: 21 actor_id: 12 @@ -38614,8 +38970,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *145 - - &595 + - *157 + - &602 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -38631,7 +38987,7 @@ paths: description: Response content: application/json: - schema: &596 + schema: &603 title: Rule Suite description: Response type: object @@ -38730,7 +39086,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &597 + default: &604 value: id: 21 actor_id: 12 @@ -38791,7 +39147,7 @@ paths: category: orgs subcategory: rules parameters: - - *145 + - *157 - name: ruleset_id description: The ID of the ruleset. in: path @@ -38803,9 +39159,9 @@ paths: description: Response content: application/json: - schema: *285 + schema: *109 examples: - default: *286 + default: *293 '404': *7 '500': *84 put: @@ -38823,7 +39179,7 @@ paths: category: orgs subcategory: rules parameters: - - *145 + - *157 - name: ruleset_id description: The ID of the ruleset. in: path @@ -38848,16 +39204,17 @@ paths: - branch - tag - push - enforcement: *281 + - repository + enforcement: *106 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *282 - conditions: *283 + items: *107 + conditions: *292 rules: description: An array of rules within the ruleset. type: array - items: *284 + items: *108 examples: default: value: @@ -38892,9 +39249,9 @@ paths: description: Response content: application/json: - schema: *285 + schema: *109 examples: - default: *286 + default: *293 '404': *7 '500': *84 delete: @@ -38912,7 +39269,7 @@ paths: category: orgs subcategory: rules parameters: - - *145 + - *157 - name: ruleset_id description: The ID of the ruleset. in: path @@ -38940,15 +39297,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: - - *145 - - *287 - - *288 - - *289 - - *290 + - *157 + - *294 + - *295 + - *296 + - *297 - *78 - *20 - *18 - - &599 + - &606 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 @@ -38958,7 +39315,7 @@ paths: required: false schema: type: string - - &600 + - &607 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 @@ -38968,9 +39325,9 @@ paths: required: false schema: type: string - - *291 - - *292 - - *293 + - *298 + - *299 + - *300 responses: '200': description: Response @@ -38978,13 +39335,13 @@ paths: application/json: schema: type: array - items: *294 + items: *301 examples: - default: *295 + default: *302 headers: Link: *39 '404': *7 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39006,7 +39363,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: - - *145 + - *157 - *78 - name: sort description: The property to sort the results by. @@ -39050,7 +39407,7 @@ paths: application/json: schema: type: array - items: &607 + items: &614 description: A repository security advisory. type: object properties: @@ -39270,7 +39627,7 @@ paths: login: type: string description: The username of the user credited. - type: *296 + type: *303 credits_detailed: type: array nullable: true @@ -39280,7 +39637,7 @@ paths: type: object properties: user: *19 - type: *296 + type: *303 state: type: string description: The state of the user's acceptance of the @@ -39304,7 +39661,7 @@ paths: type: array description: A list of teams that collaborate on the advisory. nullable: true - items: *243 + items: *255 private_fork: readOnly: true nullable: true @@ -39341,7 +39698,7 @@ paths: - private_fork additionalProperties: false examples: - default: &608 + default: &615 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -39723,7 +40080,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#list-security-manager-teams parameters: - - *145 + - *157 responses: '200': description: Response @@ -39731,9 +40088,9 @@ paths: application/json: schema: type: array - items: *297 + items: *304 examples: - default: *258 + default: *270 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39756,8 +40113,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#add-a-security-manager-team parameters: - - *145 - - *255 + - *157 + - *267 responses: '204': description: Response @@ -39782,8 +40139,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *145 - - *255 + - *157 + - *267 responses: '204': description: Response @@ -39809,15 +40166,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: - - *145 + - *157 responses: '200': description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: *299 + default: *306 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -39841,7 +40198,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: - - *145 + - *157 - *18 - *20 responses: @@ -39849,9 +40206,9 @@ paths: description: Success content: application/json: - schema: *300 + schema: *307 examples: - default: *301 + default: *308 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -39873,15 +40230,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: - - *145 + - *157 responses: '200': description: Response content: application/json: - schema: *302 + schema: *309 examples: - default: *303 + default: *310 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -39903,15 +40260,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: - - *145 + - *157 responses: '200': description: Response content: application/json: - schema: *304 + schema: *311 examples: - default: *305 + default: *312 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -39928,7 +40285,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: - - *145 + - *157 - *18 - name: page description: Page token @@ -39947,7 +40304,7 @@ paths: description: Response content: application/json: - schema: &327 + schema: &334 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -39993,7 +40350,7 @@ paths: type: string nullable: true examples: - default: &328 + default: &335 value: groups: - group_id: '123' @@ -40038,8 +40395,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: - - *145 - - *255 + - *157 + - *267 - 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`). @@ -40071,13 +40428,13 @@ paths: application/json: schema: type: array - items: *102 + items: *114 examples: - default: *103 + default: *115 '500': *84 '403': *29 '404': *7 - '422': *104 + '422': *116 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40111,8 +40468,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: - - *145 - - *255 + - *157 + - *267 - 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`). @@ -40144,9 +40501,9 @@ paths: application/json: schema: type: array - items: *105 + items: *117 examples: - default: *199 + default: *211 '500': *84 '401': *25 '403': *29 @@ -40168,7 +40525,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-teams parameters: - - *145 + - *157 - *18 - *20 responses: @@ -40178,9 +40535,9 @@ paths: application/json: schema: type: array - items: *243 + items: *255 examples: - default: *258 + default: *270 headers: Link: *39 '403': *29 @@ -40202,7 +40559,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team parameters: - - *145 + - *157 requestBody: required: true content: @@ -40274,7 +40631,7 @@ paths: description: Response content: application/json: - schema: &306 + schema: &313 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -40337,8 +40694,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *256 - required: *257 + properties: *268 + required: *269 nullable: true members_count: type: integer @@ -40584,7 +40941,7 @@ paths: - repos_count - organization examples: - default: &307 + default: &314 value: id: 1 node_id: MDQ6VGVhbTE= @@ -40654,16 +41011,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name parameters: - - *145 - - *255 + - *157 + - *267 responses: '200': description: Response content: application/json: - schema: *306 + schema: *313 examples: - default: *307 + default: *314 '404': *7 x-github: githubCloudOnly: false @@ -40684,8 +41041,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team parameters: - - *145 - - *255 + - *157 + - *267 requestBody: required: false content: @@ -40747,16 +41104,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *306 + schema: *313 examples: - default: *307 + default: *314 '201': description: Response content: application/json: - schema: *306 + schema: *313 examples: - default: *307 + default: *314 '404': *7 '422': *16 '403': *29 @@ -40781,8 +41138,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team parameters: - - *145 - - *255 + - *157 + - *267 responses: '204': description: Response @@ -40808,8 +41165,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions parameters: - - *145 - - *255 + - *157 + - *267 - *78 - *18 - *20 @@ -40826,7 +41183,7 @@ paths: application/json: schema: type: array - items: &308 + items: &315 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -40905,7 +41262,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *110 + reactions: *122 required: - author - body @@ -40925,7 +41282,7 @@ paths: - updated_at - url examples: - default: &648 + default: &655 value: - author: login: octocat @@ -40999,8 +41356,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion parameters: - - *145 - - *255 + - *157 + - *267 requestBody: required: true content: @@ -41034,9 +41391,9 @@ paths: description: Response content: application/json: - schema: *308 + schema: *315 examples: - default: &309 + default: &316 value: author: login: octocat @@ -41108,9 +41465,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion parameters: - - *145 - - *255 - - &310 + - *157 + - *267 + - &317 name: discussion_number description: The number that identifies the discussion. in: path @@ -41122,9 +41479,9 @@ paths: description: Response content: application/json: - schema: *308 + schema: *315 examples: - default: *309 + default: *316 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41146,9 +41503,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion parameters: - - *145 - - *255 - - *310 + - *157 + - *267 + - *317 requestBody: required: false content: @@ -41171,9 +41528,9 @@ paths: description: Response content: application/json: - schema: *308 + schema: *315 examples: - default: &649 + default: &656 value: author: login: octocat @@ -41243,9 +41600,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion parameters: - - *145 - - *255 - - *310 + - *157 + - *267 + - *317 responses: '204': description: Response @@ -41271,9 +41628,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments parameters: - - *145 - - *255 - - *310 + - *157 + - *267 + - *317 - *78 - *18 - *20 @@ -41284,7 +41641,7 @@ paths: application/json: schema: type: array - items: &311 + items: &318 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -41341,7 +41698,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *110 + reactions: *122 required: - author - body @@ -41356,7 +41713,7 @@ paths: - updated_at - url examples: - default: &650 + default: &657 value: - author: login: octocat @@ -41424,9 +41781,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment parameters: - - *145 - - *255 - - *310 + - *157 + - *267 + - *317 requestBody: required: true content: @@ -41448,9 +41805,9 @@ paths: description: Response content: application/json: - schema: *311 + schema: *318 examples: - default: &312 + default: &319 value: author: login: octocat @@ -41516,10 +41873,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment parameters: - - *145 - - *255 - - *310 - - &313 + - *157 + - *267 + - *317 + - &320 name: comment_number description: The number that identifies the comment. in: path @@ -41531,9 +41888,9 @@ paths: description: Response content: application/json: - schema: *311 + schema: *318 examples: - default: *312 + default: *319 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41555,10 +41912,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment parameters: - - *145 - - *255 - - *310 - - *313 + - *157 + - *267 + - *317 + - *320 requestBody: required: true content: @@ -41580,9 +41937,9 @@ paths: description: Response content: application/json: - schema: *311 + schema: *318 examples: - default: &651 + default: &658 value: author: login: octocat @@ -41646,10 +42003,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment parameters: - - *145 - - *255 - - *310 - - *313 + - *157 + - *267 + - *317 + - *320 responses: '204': description: Response @@ -41675,10 +42032,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: - - *145 - - *255 - - *310 - - *313 + - *157 + - *267 + - *317 + - *320 - 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. @@ -41704,7 +42061,7 @@ paths: application/json: schema: type: array - items: &314 + items: &321 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -41747,7 +42104,7 @@ paths: - content - created_at examples: - default: &316 + default: &323 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -41797,10 +42154,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: - - *145 - - *255 - - *310 - - *313 + - *157 + - *267 + - *317 + - *320 requestBody: required: true content: @@ -41833,9 +42190,9 @@ paths: team discussion comment content: application/json: - schema: *314 + schema: *321 examples: - default: &315 + default: &322 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -41864,9 +42221,9 @@ paths: description: Response content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41889,11 +42246,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - - *145 - - *255 - - *310 - - *313 - - &317 + - *157 + - *267 + - *317 + - *320 + - &324 name: reaction_id description: The unique identifier of the reaction. in: path @@ -41925,9 +42282,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - - *145 - - *255 - - *310 + - *157 + - *267 + - *317 - 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. @@ -41953,9 +42310,9 @@ paths: application/json: schema: type: array - items: *314 + items: *321 examples: - default: *316 + default: *323 headers: Link: *39 x-github: @@ -41981,9 +42338,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - - *145 - - *255 - - *310 + - *157 + - *267 + - *317 requestBody: required: true content: @@ -42015,16 +42372,16 @@ paths: description: Response content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 '201': description: Response content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -42047,10 +42404,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-reaction parameters: - - *145 - - *255 - - *310 + - *157 + - *267 - *317 + - *324 responses: '204': description: Response @@ -42073,16 +42430,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: - - *145 - - *255 + - *157 + - *267 responses: '200': description: Response content: application/json: - schema: *318 + schema: *325 examples: - default: *319 + default: *326 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -42101,8 +42458,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: - - *145 - - *255 + - *157 + - *267 requestBody: required: true content: @@ -42125,9 +42482,9 @@ paths: description: Response content: application/json: - schema: *320 + schema: *327 examples: - default: *321 + default: *328 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -42146,8 +42503,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: - - *145 - - *255 + - *157 + - *267 responses: '204': description: Response @@ -42171,8 +42528,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations parameters: - - *145 - - *255 + - *157 + - *267 - *18 - *20 responses: @@ -42182,9 +42539,9 @@ paths: application/json: schema: type: array - items: *240 + items: *252 examples: - default: *241 + default: *253 headers: Link: *39 x-github: @@ -42206,8 +42563,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members parameters: - - *145 - - *255 + - *157 + - *267 - name: role description: Filters members returned by their role in the team. in: query @@ -42230,7 +42587,7 @@ paths: type: array items: *19 examples: - default: *246 + default: *258 headers: Link: *39 x-github: @@ -42260,15 +42617,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user parameters: - - *145 - - *255 - - *185 + - *157 + - *267 + - *197 responses: '200': description: Response content: application/json: - schema: &322 + schema: &329 title: Team Membership description: Team Membership type: object @@ -42295,7 +42652,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &652 + response-if-user-is-a-team-maintainer: &659 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -42331,9 +42688,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: - - *145 - - *255 - - *185 + - *157 + - *267 + - *197 requestBody: required: false content: @@ -42358,9 +42715,9 @@ paths: description: Response content: application/json: - schema: *322 + schema: *329 examples: - response-if-users-membership-with-team-is-now-pending: &653 + response-if-users-membership-with-team-is-now-pending: &660 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -42395,9 +42752,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user parameters: - - *145 - - *255 - - *185 + - *157 + - *267 + - *197 responses: '204': description: Response @@ -42423,8 +42780,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects parameters: - - *145 - - *255 + - *157 + - *267 - *18 - *20 responses: @@ -42434,7 +42791,7 @@ paths: application/json: schema: type: array - items: &323 + items: &330 title: Team Project description: A team's access to a project. type: object @@ -42502,7 +42859,7 @@ paths: - updated_at - permissions examples: - default: &654 + default: &661 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -42563,9 +42920,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project parameters: - - *145 - - *255 - - &324 + - *157 + - *267 + - &331 name: project_id description: The unique identifier of the project. in: path @@ -42577,9 +42934,9 @@ paths: description: Response content: application/json: - schema: *323 + schema: *330 examples: - default: &655 + default: &662 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -42639,9 +42996,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions parameters: - - *145 - - *255 - - *324 + - *157 + - *267 + - *331 requestBody: required: false content: @@ -42705,9 +43062,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team parameters: - - *145 - - *255 - - *324 + - *157 + - *267 + - *331 responses: '204': description: Response @@ -42731,8 +43088,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories parameters: - - *145 - - *255 + - *157 + - *267 - *18 - *20 responses: @@ -42742,9 +43099,9 @@ paths: application/json: schema: type: array - items: *163 + items: *175 examples: - default: *265 + default: *277 headers: Link: *39 x-github: @@ -42773,16 +43130,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *145 - - *255 - - *325 - - *326 + - *157 + - *267 + - *332 + - *333 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &656 + schema: &663 title: Team Repository description: A team's access to a repository. type: object @@ -42805,8 +43162,8 @@ paths: title: License Simple description: License Simple type: object - properties: *123 - required: *124 + properties: *135 + required: *136 nullable: true forks: type: integer @@ -43351,10 +43708,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *145 - - *255 - - *325 - - *326 + - *157 + - *267 + - *332 + - *333 requestBody: required: false content: @@ -43399,10 +43756,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team parameters: - - *145 - - *255 - - *325 - - *326 + - *157 + - *267 + - *332 + - *333 responses: '204': description: Response @@ -43428,16 +43785,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: - - *145 - - *255 + - *157 + - *267 responses: '200': description: Response content: application/json: - schema: *327 + schema: *334 examples: - default: *328 + default: *335 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -43459,8 +43816,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: - - *145 - - *255 + - *157 + - *267 requestBody: required: true content: @@ -43503,7 +43860,7 @@ paths: description: Response content: application/json: - schema: *327 + schema: *334 examples: default: value: @@ -43535,8 +43892,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams parameters: - - *145 - - *255 + - *157 + - *267 - *18 - *20 responses: @@ -43546,9 +43903,9 @@ paths: application/json: schema: type: array - items: *243 + items: *255 examples: - response-if-child-teams-exist: &657 + response-if-child-teams-exist: &664 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -43601,7 +43958,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: - - *145 + - *157 - name: security_product in: path description: The security feature to enable or disable. @@ -43672,7 +44029,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#get-a-project-card parameters: - - &329 + - &336 name: card_id description: The unique identifier of the card. in: path @@ -43684,7 +44041,7 @@ paths: description: Response content: application/json: - schema: &330 + schema: &337 title: Project Card description: Project cards represent a scope of work. type: object @@ -43751,7 +44108,7 @@ paths: - created_at - updated_at examples: - default: &331 + default: &338 value: url: https://api.github.com/projects/columns/cards/1478 id: 1478 @@ -43801,7 +44158,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#update-an-existing-project-card parameters: - - *329 + - *336 requestBody: required: false content: @@ -43828,9 +44185,9 @@ paths: description: Response content: application/json: - schema: *330 + schema: *337 examples: - default: *331 + default: *338 '304': *37 '403': *29 '401': *25 @@ -43851,7 +44208,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#delete-a-project-card parameters: - - *329 + - *336 responses: '204': description: Response @@ -43889,7 +44246,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#move-a-project-card parameters: - - *329 + - *336 requestBody: required: true content: @@ -43994,7 +44351,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#get-a-project-column parameters: - - &332 + - &339 name: column_id description: The unique identifier of the column. in: path @@ -44006,7 +44363,7 @@ paths: description: Response content: application/json: - schema: &333 + schema: &340 title: Project Column description: Project columns contain cards of work. type: object @@ -44052,7 +44409,7 @@ paths: - created_at - updated_at examples: - default: &334 + default: &341 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -44081,7 +44438,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#update-an-existing-project-column parameters: - - *332 + - *339 requestBody: required: true content: @@ -44105,9 +44462,9 @@ paths: description: Response content: application/json: - schema: *333 + schema: *340 examples: - default: *334 + default: *341 '304': *37 '403': *29 '401': *25 @@ -44126,7 +44483,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#delete-a-project-column parameters: - - *332 + - *339 responses: '204': description: Response @@ -44149,7 +44506,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#list-project-cards parameters: - - *332 + - *339 - name: archived_state description: Filters the project cards that are returned by the card's state. in: query @@ -44170,7 +44527,7 @@ paths: application/json: schema: type: array - items: *330 + items: *337 examples: default: value: @@ -44223,7 +44580,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#create-a-project-card parameters: - - *332 + - *339 requestBody: required: true content: @@ -44263,9 +44620,9 @@ paths: description: Response content: application/json: - schema: *330 + schema: *337 examples: - default: *331 + default: *338 '304': *37 '403': *29 '401': *25 @@ -44275,8 +44632,8 @@ paths: application/json: schema: oneOf: - - *148 - - *149 + - *160 + - *161 '503': description: Response content: @@ -44315,7 +44672,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#move-a-project-column parameters: - - *332 + - *339 requestBody: required: true content: @@ -44371,15 +44728,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-a-project parameters: - - *324 + - *331 responses: '200': description: Response content: application/json: - schema: *272 + schema: *284 examples: - default: &335 + default: &342 value: owner_url: https://api.github.com/repos/api-playground/projects-test url: https://api.github.com/projects/1002604 @@ -44432,7 +44789,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#update-a-project parameters: - - *324 + - *331 requestBody: required: false content: @@ -44478,9 +44835,9 @@ paths: description: Response content: application/json: - schema: *272 + schema: *284 examples: - default: *335 + default: *342 '404': description: Not Found if the authenticated user does not have access to the project @@ -44501,7 +44858,7 @@ paths: items: type: string '401': *25 - '410': *336 + '410': *343 '422': *8 x-github: githubCloudOnly: false @@ -44519,7 +44876,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#delete-a-project parameters: - - *324 + - *331 responses: '204': description: Delete Success @@ -44540,7 +44897,7 @@ paths: items: type: string '401': *25 - '410': *336 + '410': *343 '404': *7 x-github: githubCloudOnly: false @@ -44563,7 +44920,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#list-project-collaborators parameters: - - *324 + - *331 - 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 @@ -44590,7 +44947,7 @@ paths: type: array items: *19 examples: - default: *246 + default: *258 headers: Link: *39 '404': *7 @@ -44615,8 +44972,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#add-project-collaborator parameters: - - *324 - - *185 + - *331 + - *197 requestBody: required: false content: @@ -44663,8 +45020,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#remove-user-as-a-collaborator parameters: - - *324 - - *185 + - *331 + - *197 responses: '204': description: Response @@ -44692,8 +45049,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#get-project-permission-for-a-user parameters: - - *324 - - *185 + - *331 + - *197 responses: '200': description: Response @@ -44760,7 +45117,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#list-project-columns parameters: - - *324 + - *331 - *18 - *20 responses: @@ -44770,7 +45127,7 @@ paths: application/json: schema: type: array - items: *333 + items: *340 examples: default: value: @@ -44802,7 +45159,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#create-a-project-column parameters: - - *324 + - *331 requestBody: required: true content: @@ -44825,7 +45182,7 @@ paths: description: Response content: application/json: - schema: *333 + schema: *340 examples: default: value: @@ -44886,7 +45243,7 @@ paths: resources: type: object properties: - core: &337 + core: &344 title: Rate Limit type: object properties: @@ -44903,19 +45260,20 @@ paths: - remaining - reset - used - graphql: *337 - search: *337 - code_search: *337 - source_import: *337 - integration_manifest: *337 - code_scanning_upload: *337 - actions_runner_registration: *337 - scim: *337 - dependency_snapshots: *337 + graphql: *344 + search: *344 + code_search: *344 + source_import: *344 + integration_manifest: *344 + code_scanning_upload: *344 + actions_runner_registration: *344 + scim: *344 + dependency_snapshots: *344 + code_scanning_autofix: *344 required: - core - search - rate: *337 + rate: *344 required: - rate - resources @@ -44973,6 +45331,11 @@ paths: used: 0 remaining: 10 reset: 1691591091 + code_scanning_autofix: + limit: 10 + used: 0 + remaining: 10 + reset: 1691591091 rate: limit: 5000 used: 1 @@ -45014,14 +45377,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *338 + schema: *345 examples: default-response: summary: Default response @@ -45526,7 +45889,7 @@ paths: status: disabled '403': *29 '404': *7 - '301': *339 + '301': *346 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45544,8 +45907,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: false content: @@ -45791,10 +46154,10 @@ paths: description: Response content: application/json: - schema: *338 + schema: *345 examples: - default: *340 - '307': &341 + default: *347 + '307': &348 description: Temporary Redirect content: application/json: @@ -45823,8 +46186,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository parameters: - - *325 - - *326 + - *332 + - *333 responses: '204': description: Response @@ -45846,7 +46209,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': *341 + '307': *348 '404': *7 x-github: githubCloudOnly: false @@ -45869,11 +46232,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 - - &356 + - &363 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -45896,7 +46259,7 @@ paths: type: integer artifacts: type: array - items: &342 + items: &349 title: Artifact description: An artifact type: object @@ -45967,7 +46330,7 @@ paths: - expires_at - updated_at examples: - default: &357 + default: &364 value: total_count: 2 artifacts: @@ -46026,9 +46389,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact parameters: - - *325 - - *326 - - &343 + - *332 + - *333 + - &350 name: artifact_id description: The unique identifier of the artifact. in: path @@ -46040,7 +46403,7 @@ paths: description: Response content: application/json: - schema: *342 + schema: *349 examples: default: value: @@ -46077,9 +46440,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact parameters: - - *325 - - *326 - - *343 + - *332 + - *333 + - *350 responses: '204': description: Response @@ -46103,9 +46466,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact parameters: - - *325 - - *326 - - *343 + - *332 + - *333 + - *350 - name: archive_format in: path required: true @@ -46119,7 +46482,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': *336 + '410': *343 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46142,14 +46505,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *344 + schema: *351 examples: default: value: @@ -46175,11 +46538,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: - - *325 - - *326 + - *332 + - *333 - *18 - *20 - - &345 + - &352 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 @@ -46213,7 +46576,7 @@ paths: description: Response content: application/json: - schema: &346 + schema: &353 title: Repository actions caches description: Repository actions caches type: object @@ -46255,7 +46618,7 @@ paths: - total_count - actions_caches examples: - default: &347 + default: &354 value: total_count: 1 actions_caches: @@ -46287,23 +46650,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: - - *325 - - *326 + - *332 + - *333 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *345 + - *352 responses: '200': description: Response content: application/json: - schema: *346 + schema: *353 examples: - default: *347 + default: *354 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46323,8 +46686,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: - - *325 - - *326 + - *332 + - *333 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -46355,9 +46718,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: - - *325 - - *326 - - &348 + - *332 + - *333 + - &355 name: job_id description: The unique identifier of the job. in: path @@ -46369,7 +46732,7 @@ paths: description: Response content: application/json: - schema: &360 + schema: &367 title: Job description: Information of a job execution in a workflow run type: object @@ -46676,9 +47039,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: - - *325 - - *326 - - *348 + - *332 + - *333 + - *355 responses: '302': description: Response @@ -46706,9 +47069,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: - - *325 - - *326 - - *348 + - *332 + - *333 + - *355 requestBody: required: false content: @@ -46729,7 +47092,7 @@ paths: description: Response content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -46753,8 +47116,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Status response @@ -46804,8 +47167,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: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -46839,7 +47202,7 @@ paths: description: Empty response content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -46868,8 +47231,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -46887,7 +47250,7 @@ paths: type: integer secrets: type: array - items: &362 + items: &369 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -46907,7 +47270,7 @@ paths: - created_at - updated_at examples: - default: &363 + default: &370 value: total_count: 2 secrets: @@ -46940,9 +47303,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables parameters: - - *325 - - *326 - - *349 + - *332 + - *333 + - *356 - *20 responses: '200': @@ -46959,7 +47322,7 @@ paths: type: integer variables: type: array - items: &366 + items: &373 title: Actions Variable type: object properties: @@ -46989,7 +47352,7 @@ paths: - created_at - updated_at examples: - default: &367 + default: &374 value: total_count: 2 variables: @@ -47022,8 +47385,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -47032,11 +47395,11 @@ paths: schema: type: object properties: - enabled: &350 + enabled: &357 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *42 - selected_actions_url: *156 + selected_actions_url: *168 required: - enabled examples: @@ -47065,8 +47428,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: - - *325 - - *326 + - *332 + - *333 responses: '204': description: Response @@ -47077,7 +47440,7 @@ paths: schema: type: object properties: - enabled: *350 + enabled: *357 allowed_actions: *42 required: - enabled @@ -47108,14 +47471,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: &351 + schema: &358 type: object properties: access_level: @@ -47133,7 +47496,7 @@ paths: required: - access_level examples: - default: &352 + default: &359 value: access_level: organization x-github: @@ -47158,15 +47521,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: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: application/json: - schema: *351 + schema: *358 examples: - default: *352 + default: *359 responses: '204': description: Response @@ -47190,8 +47553,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -47222,8 +47585,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: - - *325 - - *326 + - *332 + - *333 responses: '204': description: Response @@ -47255,14 +47618,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *159 + schema: *171 examples: default: *48 x-github: @@ -47285,8 +47648,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: - - *325 - - *326 + - *332 + - *333 responses: '204': description: Success response @@ -47297,7 +47660,7 @@ paths: required: true content: application/json: - schema: *160 + schema: *172 examples: default: *48 x-github: @@ -47326,8 +47689,8 @@ paths: in: query schema: type: string - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -47371,8 +47734,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -47380,9 +47743,9 @@ paths: application/json: schema: type: array - items: *164 + items: *176 examples: - default: *165 + default: *177 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47404,8 +47767,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: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -47448,7 +47811,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *166 + '201': *178 '404': *7 '422': *8 x-github: @@ -47478,8 +47841,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: - - *325 - - *326 + - *332 + - *333 responses: '201': description: Response @@ -47487,7 +47850,7 @@ paths: application/json: schema: *58 examples: - default: *167 + default: *179 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47515,8 +47878,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: - - *325 - - *326 + - *332 + - *333 responses: '201': description: Response @@ -47524,7 +47887,7 @@ paths: application/json: schema: *58 examples: - default: *168 + default: *180 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47546,8 +47909,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: - - *325 - - *326 + - *332 + - *333 - *54 responses: '200': @@ -47556,7 +47919,7 @@ paths: application/json: schema: *55 examples: - default: *169 + default: *181 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47577,8 +47940,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: - - *325 - - *326 + - *332 + - *333 - *54 responses: '204': @@ -47604,8 +47967,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: - - *325 - - *326 + - *332 + - *333 - *54 responses: '200': *60 @@ -47630,8 +47993,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: - - *325 - - *326 + - *332 + - *333 - *54 requestBody: required: true @@ -47680,8 +48043,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: - - *325 - - *326 + - *332 + - *333 - *54 requestBody: required: true @@ -47731,11 +48094,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: - - *325 - - *326 + - *332 + - *333 - *54 responses: - '200': *170 + '200': *182 '404': *7 x-github: githubCloudOnly: false @@ -47762,10 +48125,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: - - *325 - - *326 + - *332 + - *333 - *54 - - *171 + - *183 responses: '200': *60 '404': *7 @@ -47793,9 +48156,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: - - *325 - - *326 - - &370 + - *332 + - *333 + - &377 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. @@ -47803,7 +48166,7 @@ paths: required: false schema: type: string - - &371 + - &378 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -47811,7 +48174,7 @@ paths: required: false schema: type: string - - &372 + - &379 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -47820,7 +48183,7 @@ paths: required: false schema: type: string - - &373 + - &380 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 @@ -47847,7 +48210,7 @@ paths: - pending - *18 - *20 - - &374 + - &381 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)." @@ -47856,7 +48219,7 @@ paths: schema: type: string format: date-time - - &353 + - &360 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -47865,13 +48228,13 @@ paths: schema: type: boolean default: false - - &375 + - &382 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &376 + - &383 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -47894,7 +48257,7 @@ paths: type: integer workflow_runs: type: array - items: &354 + items: &361 title: Workflow Run description: An invocation of a workflow type: object @@ -47989,7 +48352,7 @@ paths: that triggered the run. type: array nullable: true - items: &395 + items: &402 title: Pull Request Minimal type: object properties: @@ -48108,7 +48471,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &399 + properties: &406 id: type: string description: SHA for the commit @@ -48159,7 +48522,7 @@ paths: - name - email nullable: true - required: &400 + required: &407 - id - tree_id - message @@ -48167,8 +48530,8 @@ paths: - author - committer nullable: true - repository: *163 - head_repository: *163 + repository: *175 + head_repository: *175 head_repository_id: type: integer example: 5 @@ -48206,7 +48569,7 @@ paths: - workflow_url - pull_requests examples: - default: &377 + default: &384 value: total_count: 1 workflow_runs: @@ -48442,24 +48805,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run parameters: - - *325 - - *326 - - &355 + - *332 + - *333 + - &362 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *353 + - *360 responses: '200': description: Response content: application/json: - schema: *354 + schema: *361 examples: - default: &358 + default: &365 value: id: 30433642 name: Build @@ -48700,9 +49063,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *325 - - *326 - - *355 + - *332 + - *333 + - *362 responses: '204': description: Response @@ -48725,9 +49088,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: - - *325 - - *326 - - *355 + - *332 + - *333 + - *362 responses: '200': description: Response @@ -48846,15 +49209,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: - - *325 - - *326 - - *355 + - *332 + - *333 + - *362 responses: '201': description: Response content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -48881,12 +49244,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *325 - - *326 - - *355 + - *332 + - *333 + - *362 - *18 - *20 - - *356 + - *363 responses: '200': description: Response @@ -48902,9 +49265,9 @@ paths: type: integer artifacts: type: array - items: *342 + items: *349 examples: - default: *357 + default: *364 headers: Link: *39 x-github: @@ -48928,25 +49291,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *325 - - *326 - - *355 - - &359 + - *332 + - *333 + - *362 + - &366 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *353 + - *360 responses: '200': description: Response content: application/json: - schema: *354 + schema: *361 examples: - default: *358 + default: *365 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48969,10 +49332,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: - - *325 - - *326 - - *355 - - *359 + - *332 + - *333 + - *362 + - *366 - *18 - *20 responses: @@ -48990,9 +49353,9 @@ paths: type: integer jobs: type: array - items: *360 + items: *367 examples: - default: &361 + default: &368 value: total_count: 1 jobs: @@ -49105,10 +49468,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *325 - - *326 - - *355 - - *359 + - *332 + - *333 + - *362 + - *366 responses: '302': description: Response @@ -49136,19 +49499,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *325 - - *326 - - *355 + - *332 + - *333 + - *362 responses: '202': description: Response content: application/json: - schema: *174 + schema: *186 examples: default: value: - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49171,9 +49534,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: - - *325 - - *326 - - *355 + - *332 + - *333 + - *362 requestBody: required: true content: @@ -49240,19 +49603,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *325 - - *326 - - *355 + - *332 + - *333 + - *362 responses: '202': description: Response content: application/json: - schema: *174 + schema: *186 examples: default: value: - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49275,9 +49638,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: - - *325 - - *326 - - *355 + - *332 + - *333 + - *362 - 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 @@ -49307,9 +49670,9 @@ paths: type: integer jobs: type: array - items: *360 + items: *367 examples: - default: *361 + default: *368 headers: Link: *39 x-github: @@ -49334,9 +49697,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *325 - - *326 - - *355 + - *332 + - *333 + - *362 responses: '302': description: Response @@ -49363,9 +49726,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *325 - - *326 - - *355 + - *332 + - *333 + - *362 responses: '204': description: Response @@ -49392,9 +49755,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: - - *325 - - *326 - - *355 + - *332 + - *333 + - *362 responses: '200': description: Response @@ -49454,7 +49817,7 @@ paths: items: type: object properties: - type: &473 + type: &480 type: string description: The type of reviewer. enum: @@ -49464,7 +49827,7 @@ paths: reviewer: anyOf: - *19 - - *243 + - *255 required: - environment - wait_timer @@ -49539,9 +49902,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: - - *325 - - *326 - - *355 + - *332 + - *333 + - *362 requestBody: required: true content: @@ -49588,7 +49951,7 @@ paths: application/json: schema: type: array - items: &468 + items: &475 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -49676,8 +50039,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 required: - id - node_id @@ -49694,7 +50057,7 @@ paths: - created_at - updated_at examples: - default: &469 + default: &476 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -49750,9 +50113,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow parameters: - - *325 - - *326 - - *355 + - *332 + - *333 + - *362 requestBody: required: false content: @@ -49773,7 +50136,7 @@ paths: description: Response content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -49796,9 +50159,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: - - *325 - - *326 - - *355 + - *332 + - *333 + - *362 requestBody: required: false content: @@ -49819,7 +50182,7 @@ paths: description: Response content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -49844,9 +50207,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *325 - - *326 - - *355 + - *332 + - *333 + - *362 responses: '200': description: Response @@ -49983,8 +50346,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -50002,9 +50365,9 @@ paths: type: integer secrets: type: array - items: *362 + items: *369 examples: - default: *363 + default: *370 headers: Link: *39 x-github: @@ -50029,16 +50392,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *364 + schema: *371 examples: - default: *365 + default: *372 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50060,17 +50423,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret parameters: - - *325 - - *326 - - *173 + - *332 + - *333 + - *185 responses: '200': description: Response content: application/json: - schema: *362 + schema: *369 examples: - default: &486 + default: &493 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -50096,9 +50459,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *325 - - *326 - - *173 + - *332 + - *333 + - *185 requestBody: required: true content: @@ -50126,7 +50489,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -50152,9 +50515,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret parameters: - - *325 - - *326 - - *173 + - *332 + - *333 + - *185 responses: '204': description: Response @@ -50179,9 +50542,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables parameters: - - *325 - - *326 - - *349 + - *332 + - *333 + - *356 - *20 responses: '200': @@ -50198,9 +50561,9 @@ paths: type: integer variables: type: array - items: *366 + items: *373 examples: - default: *367 + default: *374 headers: Link: *39 x-github: @@ -50223,8 +50586,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -50251,7 +50614,7 @@ paths: description: Response content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -50276,17 +50639,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable parameters: - - *325 - - *326 - - *176 + - *332 + - *333 + - *188 responses: '200': description: Response content: application/json: - schema: *366 + schema: *373 examples: - default: &487 + default: &494 value: name: USERNAME value: octocat @@ -50312,9 +50675,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable parameters: - - *325 - - *326 - - *176 + - *332 + - *333 + - *188 requestBody: required: true content: @@ -50356,9 +50719,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable parameters: - - *325 - - *326 - - *176 + - *332 + - *333 + - *188 responses: '204': description: Response @@ -50383,8 +50746,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -50402,7 +50765,7 @@ paths: type: integer workflows: type: array - items: &368 + items: &375 title: Workflow description: A GitHub Actions workflow type: object @@ -50509,9 +50872,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow parameters: - - *325 - - *326 - - &369 + - *332 + - *333 + - &376 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -50526,7 +50889,7 @@ paths: description: Response content: application/json: - schema: *368 + schema: *375 examples: default: value: @@ -50559,9 +50922,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow parameters: - - *325 - - *326 - - *369 + - *332 + - *333 + - *376 responses: '204': description: Response @@ -50586,9 +50949,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *325 - - *326 - - *369 + - *332 + - *333 + - *376 responses: '204': description: Response @@ -50639,9 +51002,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow parameters: - - *325 - - *326 - - *369 + - *332 + - *333 + - *376 responses: '204': description: Response @@ -50668,19 +51031,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: - - *325 - - *326 - - *369 - - *370 - - *371 - - *372 - - *373 + - *332 + - *333 + - *376 + - *377 + - *378 + - *379 + - *380 - *18 - *20 - - *374 - - *353 - - *375 - - *376 + - *381 + - *360 + - *382 + - *383 responses: '200': description: Response @@ -50696,9 +51059,9 @@ paths: type: integer workflow_runs: type: array - items: *354 + items: *361 examples: - default: *377 + default: *384 headers: Link: *39 x-github: @@ -50724,9 +51087,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage parameters: - - *325 - - *326 - - *369 + - *332 + - *333 + - *376 responses: '200': description: Response @@ -50787,8 +51150,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities parameters: - - *325 - - *326 + - *332 + - *333 - *78 - *18 - *76 @@ -50952,8 +51315,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -50965,7 +51328,7 @@ paths: type: array items: *19 examples: - default: *246 + default: *258 headers: Link: *39 '404': *7 @@ -50990,8 +51353,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: - - *325 - - *326 + - *332 + - *333 - name: assignee in: path required: true @@ -51027,8 +51390,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-attestation parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -51140,8 +51503,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-attestations parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *76 - *77 @@ -51184,8 +51547,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: *378 + default: *385 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51205,8 +51570,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -51214,7 +51579,7 @@ paths: application/json: schema: type: array - items: &379 + items: &386 title: Autolink reference description: An autolink reference. type: object @@ -51264,8 +51629,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: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -51304,9 +51669,9 @@ paths: description: response content: application/json: - schema: *379 + schema: *386 examples: - default: &380 + default: &387 value: id: 1 key_prefix: TICKET- @@ -51337,9 +51702,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: - - *325 - - *326 - - &381 + - *332 + - *333 + - &388 name: autolink_id description: The unique identifier of the autolink. in: path @@ -51351,9 +51716,9 @@ paths: description: Response content: application/json: - schema: *379 + schema: *386 examples: - default: *380 + default: *387 '404': *7 x-github: githubCloudOnly: false @@ -51373,9 +51738,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: - - *325 - - *326 - - *381 + - *332 + - *333 + - *388 responses: '204': description: Response @@ -51399,8 +51764,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response if Dependabot is enabled @@ -51448,8 +51813,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-automated-security-fixes parameters: - - *325 - - *326 + - *332 + - *333 responses: '204': description: Response @@ -51470,8 +51835,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-automated-security-fixes parameters: - - *325 - - *326 + - *332 + - *333 responses: '204': description: Response @@ -51491,8 +51856,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches parameters: - - *325 - - *326 + - *332 + - *333 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -51530,7 +51895,7 @@ paths: - url protected: type: boolean - protection: &383 + protection: &390 title: Branch Protection description: Branch Protection type: object @@ -51572,7 +51937,7 @@ paths: required: - contexts - checks - enforce_admins: &386 + enforce_admins: &393 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -51587,7 +51952,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &388 + required_pull_request_reviews: &395 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -51608,7 +51973,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *243 + items: *255 apps: description: The list of apps with review dismissal access. @@ -51637,7 +52002,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *243 + items: *255 apps: description: The list of apps allowed to bypass pull request requirements. @@ -51663,7 +52028,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &385 + restrictions: &392 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -51970,9 +52335,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch parameters: - - *325 - - *326 - - &384 + - *332 + - *333 + - &391 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). @@ -51986,14 +52351,14 @@ paths: description: Response content: application/json: - schema: &394 + schema: &401 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &441 + commit: &448 title: Commit description: Commit type: object @@ -52027,7 +52392,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &382 + properties: &389 name: type: string example: '"Chris Wanstrath"' @@ -52042,7 +52407,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *382 + properties: *389 nullable: true message: type: string @@ -52063,7 +52428,7 @@ paths: required: - sha - url - verification: &493 + verification: &500 title: Verification type: object properties: @@ -52096,12 +52461,12 @@ paths: nullable: true oneOf: - *19 - - *174 + - *186 committer: nullable: true oneOf: - *19 - - *174 + - *186 parents: type: array items: @@ -52132,7 +52497,7 @@ paths: type: integer files: type: array - items: &456 + items: &463 title: Diff Entry description: Diff Entry type: object @@ -52215,7 +52580,7 @@ paths: - self protected: type: boolean - protection: *383 + protection: *390 protection_url: type: string format: uri @@ -52322,7 +52687,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *339 + '301': *346 '404': *7 x-github: githubCloudOnly: false @@ -52344,15 +52709,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 responses: '200': description: Response content: application/json: - schema: *383 + schema: *390 examples: default: value: @@ -52546,9 +52911,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 requestBody: required: true content: @@ -52803,7 +53168,7 @@ paths: url: type: string format: uri - required_status_checks: &391 + required_status_checks: &398 title: Status Check Policy description: Status Check Policy type: object @@ -52879,7 +53244,7 @@ paths: items: *19 teams: type: array - items: *243 + items: *255 apps: type: array items: *6 @@ -52897,7 +53262,7 @@ paths: items: *19 teams: type: array - items: *243 + items: *255 apps: type: array items: *6 @@ -52955,7 +53320,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *385 + restrictions: *392 required_conversation_resolution: type: object properties: @@ -53067,9 +53432,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 responses: '204': description: Response @@ -53094,17 +53459,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 responses: '200': description: Response content: application/json: - schema: *386 + schema: *393 examples: - default: &387 + default: &394 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -53126,17 +53491,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 responses: '200': description: Response content: application/json: - schema: *386 + schema: *393 examples: - default: *387 + default: *394 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53155,9 +53520,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 responses: '204': description: Response @@ -53182,17 +53547,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 responses: '200': description: Response content: application/json: - schema: *388 + schema: *395 examples: - default: &389 + default: &396 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -53288,9 +53653,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 requestBody: required: false content: @@ -53388,9 +53753,9 @@ paths: description: Response content: application/json: - schema: *388 + schema: *395 examples: - default: *389 + default: *396 '422': *16 x-github: githubCloudOnly: false @@ -53411,9 +53776,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 responses: '204': description: Response @@ -53440,17 +53805,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 responses: '200': description: Response content: application/json: - schema: *386 + schema: *393 examples: - default: &390 + default: &397 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -53473,17 +53838,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 responses: '200': description: Response content: application/json: - schema: *386 + schema: *393 examples: - default: *390 + default: *397 '404': *7 x-github: githubCloudOnly: false @@ -53503,9 +53868,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 responses: '204': description: Response @@ -53530,17 +53895,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 responses: '200': description: Response content: application/json: - schema: *391 + schema: *398 examples: - default: &392 + default: &399 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -53566,9 +53931,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 requestBody: required: false content: @@ -53620,9 +53985,9 @@ paths: description: Response content: application/json: - schema: *391 + schema: *398 examples: - default: *392 + default: *399 '404': *7 '422': *16 x-github: @@ -53644,9 +54009,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 responses: '204': description: Response @@ -53670,9 +54035,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 responses: '200': description: Response @@ -53706,9 +54071,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 requestBody: required: false content: @@ -53775,9 +54140,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 requestBody: required: false content: @@ -53841,9 +54206,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 requestBody: content: application/json: @@ -53909,15 +54274,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 responses: '200': description: Response content: application/json: - schema: *385 + schema: *392 examples: default: value: @@ -54008,9 +54373,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 responses: '204': description: Response @@ -54033,9 +54398,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: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 responses: '200': description: Response @@ -54045,7 +54410,7 @@ paths: type: array items: *6 examples: - default: &393 + default: &400 value: - id: 1 slug: octoapp @@ -54102,9 +54467,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 requestBody: required: true content: @@ -54138,7 +54503,7 @@ paths: type: array items: *6 examples: - default: *393 + default: *400 '422': *16 x-github: githubCloudOnly: false @@ -54159,9 +54524,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 requestBody: required: true content: @@ -54195,7 +54560,7 @@ paths: type: array items: *6 examples: - default: *393 + default: *400 '422': *16 x-github: githubCloudOnly: false @@ -54216,9 +54581,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 requestBody: required: true content: @@ -54252,7 +54617,7 @@ paths: type: array items: *6 examples: - default: *393 + default: *400 '422': *16 x-github: githubCloudOnly: false @@ -54274,9 +54639,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: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 responses: '200': description: Response @@ -54284,9 +54649,9 @@ paths: application/json: schema: type: array - items: *243 + items: *255 examples: - default: *258 + default: *270 '404': *7 x-github: githubCloudOnly: false @@ -54306,9 +54671,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 requestBody: required: false content: @@ -54344,9 +54709,9 @@ paths: application/json: schema: type: array - items: *243 + items: *255 examples: - default: *258 + default: *270 '422': *16 x-github: githubCloudOnly: false @@ -54367,9 +54732,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 requestBody: required: false content: @@ -54405,9 +54770,9 @@ paths: application/json: schema: type: array - items: *243 + items: *255 examples: - default: *258 + default: *270 '422': *16 x-github: githubCloudOnly: false @@ -54428,9 +54793,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 requestBody: content: application/json: @@ -54465,9 +54830,9 @@ paths: application/json: schema: type: array - items: *243 + items: *255 examples: - default: *258 + default: *270 '422': *16 x-github: githubCloudOnly: false @@ -54489,9 +54854,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: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 responses: '200': description: Response @@ -54501,7 +54866,7 @@ paths: type: array items: *19 examples: - default: *246 + default: *258 '404': *7 x-github: githubCloudOnly: false @@ -54525,9 +54890,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 requestBody: required: true content: @@ -54560,7 +54925,7 @@ paths: type: array items: *19 examples: - default: *246 + default: *258 '422': *16 x-github: githubCloudOnly: false @@ -54585,9 +54950,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 requestBody: required: true content: @@ -54620,7 +54985,7 @@ paths: type: array items: *19 examples: - default: *246 + default: *258 '422': *16 x-github: githubCloudOnly: false @@ -54645,9 +55010,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 requestBody: required: true content: @@ -54680,7 +55045,7 @@ paths: type: array items: *19 examples: - default: *246 + default: *258 '422': *16 x-github: githubCloudOnly: false @@ -54707,9 +55072,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 requestBody: required: true content: @@ -54731,7 +55096,7 @@ paths: description: Response content: application/json: - schema: *394 + schema: *401 examples: default: value: @@ -54847,8 +55212,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -55127,7 +55492,7 @@ paths: description: Response content: application/json: - schema: &396 + schema: &403 title: CheckRun description: A check performed on the code of a given code change type: object @@ -55238,16 +55603,16 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 pull_requests: description: Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check. type: array - items: *395 - deployment: &708 + items: *402 + deployment: &715 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -55314,8 +55679,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 required: - id - node_id @@ -55527,9 +55892,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run parameters: - - *325 - - *326 - - &397 + - *332 + - *333 + - &404 name: check_run_id description: The unique identifier of the check run. in: path @@ -55541,9 +55906,9 @@ paths: description: Response content: application/json: - schema: *396 + schema: *403 examples: - default: &398 + default: &405 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -55643,9 +56008,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run parameters: - - *325 - - *326 - - *397 + - *332 + - *333 + - *404 requestBody: required: true content: @@ -55885,9 +56250,9 @@ paths: description: Response content: application/json: - schema: *396 + schema: *403 examples: - default: *398 + default: *405 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55907,9 +56272,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations parameters: - - *325 - - *326 - - *397 + - *332 + - *333 + - *404 - *18 - *20 responses: @@ -56006,15 +56371,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run parameters: - - *325 - - *326 - - *397 + - *332 + - *333 + - *404 responses: '201': description: Response content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -56052,8 +56417,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -56075,7 +56440,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &401 + schema: &408 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -56139,7 +56504,7 @@ paths: nullable: true pull_requests: type: array - items: *395 + items: *402 nullable: true app: title: GitHub app @@ -56150,9 +56515,9 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 - repository: *163 + properties: *119 + required: *120 + repository: *175 created_at: type: string format: date-time @@ -56161,12 +56526,12 @@ paths: type: string format: date-time nullable: true - head_commit: &734 + head_commit: &741 title: Simple Commit description: A commit. type: object - properties: *399 - required: *400 + properties: *406 + required: *407 latest_check_runs_count: type: integer check_runs_url: @@ -56194,7 +56559,7 @@ paths: - check_runs_url - pull_requests examples: - default: &402 + default: &409 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -56485,9 +56850,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *401 + schema: *408 examples: - default: *402 + default: *409 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56506,8 +56871,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -56568,7 +56933,7 @@ paths: required: - app_id - setting - repository: *163 + repository: *175 examples: default: value: @@ -56816,9 +57181,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite parameters: - - *325 - - *326 - - &403 + - *332 + - *333 + - &410 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -56830,9 +57195,9 @@ paths: description: Response content: application/json: - schema: *401 + schema: *408 examples: - default: *402 + default: *409 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56855,17 +57220,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: - - *325 - - *326 - - *403 - - &449 + - *332 + - *333 + - *410 + - &456 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &450 + - &457 name: status description: Returns check runs with the specified `status`. in: query @@ -56904,9 +57269,9 @@ paths: type: integer check_runs: type: array - items: *396 + items: *403 examples: - default: &451 + default: &458 value: total_count: 1 check_runs: @@ -57008,15 +57373,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite parameters: - - *325 - - *326 - - *403 + - *332 + - *333 + - *410 responses: '201': description: Response content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -57043,21 +57408,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: - - *325 - - *326 - - *186 - - *187 + - *332 + - *333 + - *198 + - *199 - *20 - *18 - - &415 + - &422 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: *404 - - &416 + schema: *411 + - &423 name: pr description: The number of the pull request for the results you want to list. in: query @@ -57082,13 +57447,13 @@ paths: be returned. in: query required: false - schema: *188 + schema: *200 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *405 + schema: *412 responses: '200': description: Response @@ -57104,7 +57469,7 @@ paths: updated_at: *92 url: *89 html_url: *90 - instances_url: *406 + instances_url: *413 state: *81 fixed_at: *94 dismissed_by: @@ -57115,11 +57480,11 @@ paths: required: *5 nullable: true dismissed_at: *93 - dismissed_reason: *407 - dismissed_comment: *408 - rule: *409 - tool: *410 - most_recent_instance: *411 + dismissed_reason: *414 + dismissed_comment: *415 + rule: *416 + tool: *417 + most_recent_instance: *418 required: - number - created_at @@ -57235,14 +57600,14 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &412 + '403': &419 description: Response if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *7 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57262,9 +57627,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: - - *325 - - *326 - - &413 + - *332 + - *333 + - &420 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -57278,7 +57643,7 @@ paths: description: Response content: application/json: - schema: &414 + schema: &421 type: object properties: number: *85 @@ -57286,7 +57651,7 @@ paths: updated_at: *92 url: *89 html_url: *90 - instances_url: *406 + instances_url: *413 state: *81 fixed_at: *94 dismissed_by: @@ -57297,8 +57662,8 @@ paths: required: *5 nullable: true dismissed_at: *93 - dismissed_reason: *407 - dismissed_comment: *408 + dismissed_reason: *414 + dismissed_comment: *415 rule: type: object properties: @@ -57352,8 +57717,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *410 - most_recent_instance: *411 + tool: *417 + most_recent_instance: *418 required: - number - created_at @@ -57442,9 +57807,9 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *412 + '403': *419 '404': *7 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57462,9 +57827,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: - - *325 - - *326 - - *413 + - *332 + - *333 + - *420 requestBody: required: true content: @@ -57479,8 +57844,8 @@ paths: enum: - open - dismissed - dismissed_reason: *407 - dismissed_comment: *408 + dismissed_reason: *414 + dismissed_comment: *415 required: - state examples: @@ -57495,7 +57860,7 @@ paths: description: Response content: application/json: - schema: *414 + schema: *421 examples: default: value: @@ -57570,14 +57935,14 @@ paths: classifications: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances - '403': &421 + '403': &428 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *7 - '503': *100 + '503': *112 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -57597,13 +57962,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: - - *325 - - *326 - - *413 + - *332 + - *333 + - *420 - *20 - *18 - - *415 - - *416 + - *422 + - *423 responses: '200': description: Response @@ -57611,7 +57976,7 @@ paths: application/json: schema: type: array - items: *411 + items: *418 examples: default: value: @@ -57650,9 +58015,9 @@ paths: end_column: 50 classifications: - source - '403': *412 + '403': *419 '404': *7 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57684,25 +58049,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: - - *325 - - *326 - - *186 - - *187 + - *332 + - *333 + - *198 + - *199 - *20 - *18 - - *416 + - *423 - 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: *404 + schema: *411 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &419 + schema: &426 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -57723,23 +58088,23 @@ paths: application/json: schema: type: array - items: &420 + items: &427 type: object properties: - ref: *404 - commit_sha: &429 + ref: *411 + commit_sha: &436 description: The SHA of the commit to which the analysis you are uploading relates. type: string minLength: 40 maxLength: 40 pattern: "^[0-9a-fA-F]+$" - analysis_key: *417 + analysis_key: *424 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *418 + category: *425 error: type: string example: error reading field xyz @@ -57763,8 +58128,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *419 - tool: *410 + sarif_id: *426 + tool: *417 deletable: type: boolean warning: @@ -57825,9 +58190,9 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *412 + '403': *419 '404': *7 - '503': *100 + '503': *112 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -57861,8 +58226,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: - - *325 - - *326 + - *332 + - *333 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -57875,7 +58240,7 @@ paths: description: Response content: application/json: - schema: *420 + schema: *427 examples: response: summary: application/json response @@ -57929,9 +58294,9 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *412 + '403': *419 '404': *7 - '503': *100 + '503': *112 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -58011,8 +58376,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: - - *325 - - *326 + - *332 + - *333 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -58065,9 +58430,9 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *15 - '403': *421 + '403': *428 '404': *7 - '503': *100 + '503': *112 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -58087,8 +58452,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -58096,7 +58461,7 @@ paths: application/json: schema: type: array - items: &422 + items: &429 title: CodeQL Database description: A CodeQL database. type: object @@ -58207,9 +58572,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': *412 + '403': *419 '404': *7 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58236,8 +58601,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: - - *325 - - *326 + - *332 + - *333 - name: language in: path description: The language of the CodeQL database. @@ -58249,7 +58614,7 @@ paths: description: Response content: application/json: - schema: *422 + schema: *429 examples: default: value: @@ -58281,11 +58646,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': &458 + '302': &465 description: Found - '403': *412 + '403': *419 '404': *7 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58305,8 +58670,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *325 - - *326 + - *332 + - *333 - name: language in: path description: The language of the CodeQL database. @@ -58316,9 +58681,9 @@ paths: responses: '204': description: Response - '403': *421 + '403': *428 '404': *7 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58344,8 +58709,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: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -58354,7 +58719,7 @@ paths: type: object additionalProperties: false properties: - language: &423 + language: &430 type: string description: The language targeted by the CodeQL query enum: @@ -58432,7 +58797,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &427 + schema: &434 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -58442,7 +58807,7 @@ paths: description: The ID of the variant analysis. controller_repo: *95 actor: *19 - query_language: *423 + query_language: *430 query_pack_url: type: string description: The download url for the query pack. @@ -58489,7 +58854,7 @@ paths: items: type: object properties: - repository: &424 + repository: &431 title: Repository Identifier description: Repository Identifier type: object @@ -58525,7 +58890,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &428 + analysis_status: &435 type: string description: The new status of the CodeQL variant analysis repository task. @@ -58557,7 +58922,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &425 + access_mismatch_repos: &432 type: object properties: repository_count: @@ -58571,7 +58936,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: *424 + items: *431 required: - repository_count - repositories @@ -58593,8 +58958,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *425 - over_limit_repos: *425 + no_codeql_db_repos: *432 + over_limit_repos: *432 required: - access_mismatch_repos - not_found_repos @@ -58610,7 +58975,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &426 + value: &433 summary: Default response value: id: 1 @@ -58762,17 +59127,17 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *426 + value: *433 repository_lists: summary: Response for a successful variant analysis submission - value: *426 + value: *433 '404': *7 '422': description: Unable to process variant analysis submission content: application/json: schema: *3 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58793,8 +59158,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: - - *325 - - *326 + - *332 + - *333 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -58806,11 +59171,11 @@ paths: description: Response content: application/json: - schema: *427 + schema: *434 examples: - default: *426 + default: *433 '404': *7 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58831,7 +59196,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: - - *325 + - *332 - name: repo in: path description: The name of the controller repository. @@ -58866,7 +59231,7 @@ paths: type: object properties: repository: *95 - analysis_status: *428 + analysis_status: *435 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -58970,7 +59335,7 @@ paths: source_location_prefix: "/" artifact_url: https://example.com '404': *7 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58991,8 +59356,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -59053,9 +59418,9 @@ paths: query_suite: default updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *412 + '403': *419 '404': *7 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59074,8 +59439,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: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -59131,7 +59496,7 @@ paths: description: Response content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -59156,7 +59521,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *421 + '403': *428 '404': *7 '409': description: Response if there is already a validation run in progress with @@ -59164,7 +59529,7 @@ paths: content: application/json: schema: *3 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59221,8 +59586,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: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -59230,7 +59595,7 @@ paths: schema: type: object properties: - commit_sha: *429 + commit_sha: *436 ref: type: string description: |- @@ -59288,7 +59653,7 @@ paths: schema: type: object properties: - id: *419 + id: *426 url: type: string description: The REST API URL for checking the status of the upload. @@ -59302,11 +59667,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': *421 + '403': *428 '404': *7 '413': description: Payload Too Large if the sarif field is too large - '503': *100 + '503': *112 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -59325,8 +59690,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: - - *325 - - *326 + - *332 + - *333 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -59372,10 +59737,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': *412 + '403': *419 '404': description: Not Found if the sarif id does not match any upload - '503': *100 + '503': *112 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -59397,8 +59762,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -59422,7 +59787,7 @@ paths: - failed - updating - removed_by_enterprise - configuration: *191 + configuration: *203 examples: default: value: @@ -59451,7 +59816,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': *192 + '204': *204 '304': *37 '403': *29 '404': *7 @@ -59476,8 +59841,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors parameters: - - *325 - - *326 + - *332 + - *333 - 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 @@ -59597,8 +59962,8 @@ paths: parameters: - *18 - *20 - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -59614,7 +59979,7 @@ paths: type: integer codespaces: type: array - items: *247 + items: *259 examples: default: value: @@ -59912,8 +60277,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -59976,22 +60341,22 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *247 + schema: *259 examples: - default: *430 + default: *437 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *247 + schema: *259 examples: - default: *430 + default: *437 '400': *15 '401': *25 '403': *29 '404': *7 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -60015,8 +60380,8 @@ paths: parameters: - *18 - *20 - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -60080,8 +60445,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: - - *325 - - *326 + - *332 + - *333 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -60116,14 +60481,14 @@ paths: type: integer machines: type: array - items: &664 + items: &671 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *431 - required: *432 + properties: *438 + required: *439 examples: - default: &665 + default: &672 value: total_count: 2 machines: @@ -60163,8 +60528,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *325 - - *326 + - *332 + - *333 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -60248,8 +60613,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: - - *325 - - *326 + - *332 + - *333 - 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 @@ -60294,7 +60659,7 @@ paths: '403': *29 '404': *7 '422': *16 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60315,8 +60680,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -60334,7 +60699,7 @@ paths: type: integer secrets: type: array - items: &436 + items: &443 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -60354,7 +60719,7 @@ paths: - created_at - updated_at examples: - default: *433 + default: *440 headers: Link: *39 x-github: @@ -60377,16 +60742,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *434 + schema: *441 examples: - default: *435 + default: *442 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -60406,17 +60771,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *325 - - *326 - - *173 + - *332 + - *333 + - *185 responses: '200': description: Response content: application/json: - schema: *436 + schema: *443 examples: - default: *437 + default: *444 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60436,9 +60801,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: - - *325 - - *326 - - *173 + - *332 + - *333 + - *185 requestBody: required: true content: @@ -60466,7 +60831,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -60490,9 +60855,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *325 - - *326 - - *173 + - *332 + - *333 + - *185 responses: '204': description: Response @@ -60520,8 +60885,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators parameters: - - *325 - - *326 + - *332 + - *333 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -60563,7 +60928,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &438 + properties: &445 login: type: string example: octocat @@ -60656,7 +61021,7 @@ paths: user_view_type: type: string example: public - required: &439 + required: &446 - avatar_url - events_url - followers_url @@ -60730,9 +61095,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: - - *325 - - *326 - - *185 + - *332 + - *333 + - *197 responses: '204': description: Response if user is a collaborator @@ -60774,9 +61139,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *325 - - *326 - - *185 + - *332 + - *333 + - *197 requestBody: required: false content: @@ -60802,7 +61167,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &506 + schema: &513 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -60813,7 +61178,7 @@ paths: example: 42 type: integer format: int64 - repository: *163 + repository: *175 invitee: title: Simple User description: A GitHub user. @@ -61024,9 +61389,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *325 - - *326 - - *185 + - *332 + - *333 + - *197 responses: '204': description: No Content when collaborator was removed from the repository. @@ -61055,9 +61420,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *325 - - *326 - - *185 + - *332 + - *333 + - *197 responses: '200': description: if user has admin permissions @@ -61077,8 +61442,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *438 - required: *439 + properties: *445 + required: *446 nullable: true required: - permission @@ -61133,8 +61498,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -61144,7 +61509,7 @@ paths: application/json: schema: type: array - items: &440 + items: &447 title: Commit Comment description: Commit Comment type: object @@ -61185,8 +61550,8 @@ paths: updated_at: type: string format: date-time - author_association: *109 - reactions: *110 + author_association: *121 + reactions: *122 required: - url - html_url @@ -61202,7 +61567,7 @@ paths: - created_at - updated_at examples: - default: &443 + default: &450 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -61261,17 +61626,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment parameters: - - *325 - - *326 - - *121 + - *332 + - *333 + - *133 responses: '200': description: Response content: application/json: - schema: *440 + schema: *447 examples: - default: &444 + default: &451 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -61328,9 +61693,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment parameters: - - *325 - - *326 - - *121 + - *332 + - *333 + - *133 requestBody: required: true content: @@ -61352,7 +61717,7 @@ paths: description: Response content: application/json: - schema: *440 + schema: *447 examples: default: value: @@ -61403,9 +61768,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment parameters: - - *325 - - *326 - - *121 + - *332 + - *333 + - *133 responses: '204': description: Response @@ -61426,9 +61791,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *325 - - *326 - - *121 + - *332 + - *333 + - *133 - 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. @@ -61454,9 +61819,9 @@ paths: application/json: schema: type: array - items: *314 + items: *321 examples: - default: *316 + default: *323 headers: Link: *39 '404': *7 @@ -61477,9 +61842,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *325 - - *326 - - *121 + - *332 + - *333 + - *133 requestBody: required: true content: @@ -61511,16 +61876,16 @@ paths: description: Reaction exists content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 '201': description: Reaction created content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 '422': *16 x-github: githubCloudOnly: false @@ -61542,10 +61907,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *325 - - *326 - - *121 - - *317 + - *332 + - *333 + - *133 + - *324 responses: '204': description: Response @@ -61594,8 +61959,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits parameters: - - *325 - - *326 + - *332 + - *333 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -61651,9 +62016,9 @@ paths: application/json: schema: type: array - items: *441 + items: *448 examples: - default: &557 + default: &564 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -61727,7 +62092,7 @@ paths: '500': *84 '400': *15 '404': *7 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61747,9 +62112,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit parameters: - - *325 - - *326 - - &442 + - *332 + - *333 + - &449 name: commit_sha description: The SHA of the commit. in: path @@ -61796,7 +62161,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc protected: false '422': *16 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61821,9 +62186,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments parameters: - - *325 - - *326 - - *442 + - *332 + - *333 + - *449 - *18 - *20 responses: @@ -61833,9 +62198,9 @@ paths: application/json: schema: type: array - items: *440 + items: *447 examples: - default: *443 + default: *450 headers: Link: *39 x-github: @@ -61863,9 +62228,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment parameters: - - *325 - - *326 - - *442 + - *332 + - *333 + - *449 requestBody: required: true content: @@ -61900,9 +62265,9 @@ paths: description: Response content: application/json: - schema: *440 + schema: *447 examples: - default: *444 + default: *451 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -61930,9 +62295,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: - - *325 - - *326 - - *442 + - *332 + - *333 + - *449 - *18 - *20 responses: @@ -61942,7 +62307,7 @@ paths: application/json: schema: type: array - items: &548 + items: &555 title: Pull Request Simple description: Pull Request Simple type: object @@ -62048,8 +62413,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *445 - required: *446 + properties: *452 + required: *453 nullable: true active_lock_reason: type: string @@ -62094,7 +62459,7 @@ paths: nullable: true requested_teams: type: array - items: *243 + items: *255 nullable: true head: type: object @@ -62145,7 +62510,7 @@ paths: _links: type: object properties: - comments: &447 + comments: &454 title: Link description: Hypermedia Link type: object @@ -62154,13 +62519,13 @@ paths: type: string required: - href - commits: *447 - statuses: *447 - html: *447 - issue: *447 - review_comments: *447 - review_comment: *447 - self: *447 + commits: *454 + statuses: *454 + html: *454 + issue: *454 + review_comments: *454 + review_comment: *454 + self: *454 required: - comments - commits @@ -62170,8 +62535,8 @@ paths: - review_comments - review_comment - self - author_association: *109 - auto_merge: &550 + author_association: *121 + auto_merge: &557 title: Auto merge description: The status of auto merging a pull request. type: object @@ -62234,7 +62599,7 @@ paths: - author_association - auto_merge examples: - default: &549 + default: &556 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -62714,7 +63079,7 @@ paths: draft: false headers: Link: *39 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62771,11 +63136,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit parameters: - - *325 - - *326 + - *332 + - *333 - *20 - *18 - - &448 + - &455 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)" @@ -62790,9 +63155,9 @@ paths: description: Response content: application/json: - schema: *441 + schema: *448 examples: - default: &535 + default: &542 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -62879,8 +63244,8 @@ paths: '422': *16 '404': *7 '500': *84 - '503': *100 - '409': *150 + '503': *112 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62905,11 +63270,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: - - *325 - - *326 - - *448 - - *449 - - *450 + - *332 + - *333 + - *455 + - *456 + - *457 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -62943,9 +63308,9 @@ paths: type: integer check_runs: type: array - items: *396 + items: *403 examples: - default: *451 + default: *458 headers: Link: *39 x-github: @@ -62970,9 +63335,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: - - *325 - - *326 - - *448 + - *332 + - *333 + - *455 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -62980,7 +63345,7 @@ paths: schema: type: integer example: 1 - - *449 + - *456 - *18 - *20 responses: @@ -62998,7 +63363,7 @@ paths: type: integer check_suites: type: array - items: *401 + items: *408 examples: default: value: @@ -63198,9 +63563,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: - - *325 - - *326 - - *448 + - *332 + - *333 + - *455 - *18 - *20 responses: @@ -63267,7 +63632,7 @@ paths: type: string total_count: type: integer - repository: *163 + repository: *175 commit_url: type: string format: uri @@ -63398,9 +63763,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *325 - - *326 - - *448 + - *332 + - *333 + - *455 - *18 - *20 responses: @@ -63410,7 +63775,7 @@ paths: application/json: schema: type: array - items: &612 + items: &619 title: Status description: The status of a commit. type: object @@ -63491,7 +63856,7 @@ paths: site_admin: false headers: Link: *39 - '301': *339 + '301': *346 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63519,8 +63884,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -63549,20 +63914,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *452 - required: *453 + properties: *459 + required: *460 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &454 + properties: &461 url: type: string format: uri html_url: type: string format: uri - required: &455 + required: &462 - url - html_url nullable: true @@ -63570,32 +63935,32 @@ paths: title: License Simple description: License Simple type: object - properties: *123 - required: *124 + properties: *135 + required: *136 nullable: true contributing: title: Community Health File type: object - properties: *454 - required: *455 + properties: *461 + required: *462 nullable: true readme: title: Community Health File type: object - properties: *454 - required: *455 + properties: *461 + required: *462 nullable: true issue_template: title: Community Health File type: object - properties: *454 - required: *455 + properties: *461 + required: *462 nullable: true pull_request_template: title: Community Health File type: object - properties: *454 - required: *455 + properties: *461 + required: *462 nullable: true required: - code_of_conduct @@ -63722,8 +64087,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits parameters: - - *325 - - *326 + - *332 + - *333 - *20 - *18 - name: basehead @@ -63766,8 +64131,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *441 - merge_base_commit: *441 + base_commit: *448 + merge_base_commit: *448 status: type: string enum: @@ -63787,10 +64152,10 @@ paths: example: 6 commits: type: array - items: *441 + items: *448 files: type: array - items: *456 + items: *463 required: - url - html_url @@ -64034,7 +64399,7 @@ paths: module Test" '404': *7 '500': *84 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64076,8 +64441,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content parameters: - - *325 - - *326 + - *332 + - *333 - name: path description: path parameter in: path @@ -64218,7 +64583,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &457 + response-if-content-is-a-file: &464 summary: Response if content is a file value: type: file @@ -64350,7 +64715,7 @@ paths: - size - type - url - - &562 + - &569 title: Content File description: Content File type: object @@ -64551,7 +64916,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *457 + response-if-content-is-a-file: *464 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -64620,7 +64985,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *7 '403': *29 - '302': *458 + '302': *465 '304': *37 x-github: githubCloudOnly: false @@ -64643,8 +65008,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents parameters: - - *325 - - *326 + - *332 + - *333 - name: path description: path parameter in: path @@ -64737,7 +65102,7 @@ paths: description: Response content: application/json: - schema: &459 + schema: &466 title: File Commit description: File Commit type: object @@ -64889,7 +65254,7 @@ paths: description: Response content: application/json: - schema: *459 + schema: *466 examples: example-for-creating-a-file: value: @@ -64943,7 +65308,7 @@ paths: schema: oneOf: - *3 - - &488 + - &495 description: Repository rule violation was detected type: object properties: @@ -64964,7 +65329,7 @@ paths: items: type: object properties: - placeholder_id: &604 + placeholder_id: &611 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -64996,8 +65361,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file parameters: - - *325 - - *326 + - *332 + - *333 - name: path description: path parameter in: path @@ -65058,7 +65423,7 @@ paths: description: Response content: application/json: - schema: *459 + schema: *466 examples: default: value: @@ -65092,8 +65457,8 @@ paths: verified_at: '422': *16 '404': *7 - '409': *150 - '503': *100 + '409': *162 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65113,8 +65478,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors parameters: - - *325 - - *326 + - *332 + - *333 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -65237,20 +65602,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *325 - - *326 - - *205 - - *206 - - *207 - - *208 + - *332 + - *333 + - *217 + - *218 + - *219 + - *220 - 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 - - *209 - - *210 + - *221 + - *222 - *78 - name: page description: "**Closing down notice**. Page number of the results to fetch. @@ -65270,8 +65635,8 @@ paths: default: 30 - *76 - *77 - - *211 - - *212 + - *223 + - *224 responses: '200': description: Response @@ -65279,7 +65644,7 @@ paths: application/json: schema: type: array - items: &462 + items: &469 type: object description: A Dependabot alert. properties: @@ -65312,7 +65677,7 @@ paths: enum: - development - runtime - security_advisory: *460 + security_advisory: *467 security_vulnerability: *88 url: *89 html_url: *90 @@ -65343,7 +65708,7 @@ paths: nullable: true maxLength: 280 fixed_at: *94 - auto_dismissed_at: *461 + auto_dismissed_at: *468 required: - number - state @@ -65570,9 +65935,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *325 - - *326 - - &463 + - *332 + - *333 + - &470 name: alert_number in: path description: |- @@ -65587,7 +65952,7 @@ paths: description: Response content: application/json: - schema: *462 + schema: *469 examples: default: value: @@ -65697,9 +66062,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *325 - - *326 - - *463 + - *332 + - *333 + - *470 requestBody: required: true content: @@ -65744,7 +66109,7 @@ paths: description: Response content: application/json: - schema: *462 + schema: *469 examples: default: value: @@ -65850,7 +66215,7 @@ paths: '400': *15 '403': *29 '404': *7 - '409': *150 + '409': *162 '422': *8 x-github: githubCloudOnly: false @@ -65873,8 +66238,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -65892,7 +66257,7 @@ paths: type: integer secrets: type: array - items: &466 + items: &473 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -65945,16 +66310,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *464 + schema: *471 examples: - default: *465 + default: *472 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65974,15 +66339,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret parameters: - - *325 - - *326 - - *173 + - *332 + - *333 + - *185 responses: '200': description: Response content: application/json: - schema: *466 + schema: *473 examples: default: value: @@ -66008,9 +66373,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *325 - - *326 - - *173 + - *332 + - *333 + - *185 requestBody: required: true content: @@ -66038,7 +66403,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -66062,9 +66427,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret parameters: - - *325 - - *326 - - *173 + - *332 + - *333 + - *185 responses: '204': description: Response @@ -66086,8 +66451,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: - - *325 - - *326 + - *332 + - *333 - 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 @@ -66247,8 +66612,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -66487,8 +66852,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: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -66563,7 +66928,7 @@ paths: - version - url additionalProperties: false - metadata: &467 + metadata: &474 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -66596,7 +66961,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *467 + metadata: *474 resolved: type: object description: A collection of resolved package dependencies. @@ -66609,7 +66974,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *467 + metadata: *474 relationship: type: string description: A notation of whether a dependency is requested @@ -66738,8 +67103,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments parameters: - - *325 - - *326 + - *332 + - *333 - name: sha description: The SHA recorded at creation time. in: query @@ -66779,9 +67144,9 @@ paths: application/json: schema: type: array - items: *468 + items: *475 examples: - default: *469 + default: *476 headers: Link: *39 x-github: @@ -66847,8 +67212,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -66929,7 +67294,7 @@ paths: description: Response content: application/json: - schema: *468 + schema: *475 examples: simple-example: summary: Simple example @@ -67002,9 +67367,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment parameters: - - *325 - - *326 - - &470 + - *332 + - *333 + - &477 name: deployment_id description: deployment_id parameter in: path @@ -67016,7 +67381,7 @@ paths: description: Response content: application/json: - schema: *468 + schema: *475 examples: default: value: @@ -67081,9 +67446,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment parameters: - - *325 - - *326 - - *470 + - *332 + - *333 + - *477 responses: '204': description: Response @@ -67105,9 +67470,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses parameters: - - *325 - - *326 - - *470 + - *332 + - *333 + - *477 - *18 - *20 responses: @@ -67117,7 +67482,7 @@ paths: application/json: schema: type: array - items: &471 + items: &478 title: Deployment Status description: The status of a deployment. type: object @@ -67208,8 +67573,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 required: - id - node_id @@ -67278,9 +67643,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status parameters: - - *325 - - *326 - - *470 + - *332 + - *333 + - *477 requestBody: required: true content: @@ -67355,9 +67720,9 @@ paths: description: Response content: application/json: - schema: *471 + schema: *478 examples: - default: &472 + default: &479 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -67413,9 +67778,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status parameters: - - *325 - - *326 - - *470 + - *332 + - *333 + - *477 - name: status_id in: path required: true @@ -67426,9 +67791,9 @@ paths: description: Response content: application/json: - schema: *471 + schema: *478 examples: - default: *472 + default: *479 '404': *7 x-github: githubCloudOnly: false @@ -67453,8 +67818,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -67511,8 +67876,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -67529,7 +67894,7 @@ paths: type: integer environments: type: array - items: &474 + items: &481 title: Environment description: Details of a deployment environment type: object @@ -67581,7 +67946,7 @@ paths: type: type: string example: wait_timer - wait_timer: &476 + wait_timer: &483 type: integer example: 30 description: The amount of time to delay a job after @@ -67618,11 +67983,11 @@ paths: items: type: object properties: - type: *473 + type: *480 reviewer: anyOf: - *19 - - *243 + - *255 required: - id - node_id @@ -67642,7 +68007,7 @@ paths: - id - node_id - type - deployment_branch_policy: &477 + deployment_branch_policy: &484 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -67758,9 +68123,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment parameters: - - *325 - - *326 - - &475 + - *332 + - *333 + - &482 name: environment_name in: path required: true @@ -67773,9 +68138,9 @@ paths: description: Response content: application/json: - schema: *474 + schema: *481 examples: - default: &478 + default: &485 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -67859,9 +68224,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment parameters: - - *325 - - *326 - - *475 + - *332 + - *333 + - *482 requestBody: required: false content: @@ -67870,7 +68235,7 @@ paths: type: object nullable: true properties: - wait_timer: *476 + wait_timer: *483 prevent_self_review: type: boolean example: false @@ -67887,13 +68252,13 @@ paths: items: type: object properties: - type: *473 + type: *480 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *477 + deployment_branch_policy: *484 additionalProperties: false examples: default: @@ -67913,9 +68278,9 @@ paths: description: Response content: application/json: - schema: *474 + schema: *481 examples: - default: *478 + default: *485 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -67939,9 +68304,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment parameters: - - *325 - - *326 - - *475 + - *332 + - *333 + - *482 responses: '204': description: Default response @@ -67966,9 +68331,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *325 - - *326 - - *475 + - *332 + - *333 + - *482 - *18 - *20 responses: @@ -67986,7 +68351,7 @@ paths: example: 2 branch_policies: type: array - items: &479 + items: &486 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -68043,9 +68408,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *325 - - *326 - - *475 + - *332 + - *333 + - *482 requestBody: required: true content: @@ -68091,9 +68456,9 @@ paths: description: Response content: application/json: - schema: *479 + schema: *486 examples: - example-wildcard: &480 + example-wildcard: &487 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -68135,10 +68500,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *325 - - *326 - - *475 - - &481 + - *332 + - *333 + - *482 + - &488 name: branch_policy_id in: path required: true @@ -68150,9 +68515,9 @@ paths: description: Response content: application/json: - schema: *479 + schema: *486 examples: - default: *480 + default: *487 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68171,10 +68536,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *325 - - *326 - - *475 - - *481 + - *332 + - *333 + - *482 + - *488 requestBody: required: true content: @@ -68202,9 +68567,9 @@ paths: description: Response content: application/json: - schema: *479 + schema: *486 examples: - default: *480 + default: *487 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68223,10 +68588,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *325 - - *326 - - *475 - - *481 + - *332 + - *333 + - *482 + - *488 responses: '204': description: Response @@ -68251,9 +68616,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: - - *475 - - *326 - - *325 + - *482 + - *333 + - *332 responses: '200': description: List of deployment protection rules @@ -68269,7 +68634,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &482 + items: &489 title: Deployment protection rule description: Deployment protection rule type: object @@ -68288,7 +68653,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &483 + app: &490 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -68387,9 +68752,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: - - *475 - - *326 - - *325 + - *482 + - *333 + - *332 requestBody: content: application/json: @@ -68410,9 +68775,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *482 + schema: *489 examples: - default: &484 + default: &491 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -68447,9 +68812,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: - - *475 - - *326 - - *325 + - *482 + - *333 + - *332 - *20 - *18 responses: @@ -68468,7 +68833,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *483 + items: *490 examples: default: value: @@ -68503,10 +68868,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: - - *325 - - *326 - - *475 - - &485 + - *332 + - *333 + - *482 + - &492 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -68518,9 +68883,9 @@ paths: description: Response content: application/json: - schema: *482 + schema: *489 examples: - default: *484 + default: *491 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68541,10 +68906,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: - - *475 - - *326 - - *325 - - *485 + - *482 + - *333 + - *332 + - *492 responses: '204': description: Response @@ -68570,9 +68935,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets parameters: - - *325 - - *326 - - *475 + - *332 + - *333 + - *482 - *18 - *20 responses: @@ -68590,9 +68955,9 @@ paths: type: integer secrets: type: array - items: *362 + items: *369 examples: - default: *363 + default: *370 headers: Link: *39 x-github: @@ -68617,17 +68982,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key parameters: - - *325 - - *326 - - *475 + - *332 + - *333 + - *482 responses: '200': description: Response content: application/json: - schema: *364 + schema: *371 examples: - default: *365 + default: *372 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68649,18 +69014,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret parameters: - - *325 - - *326 - - *475 - - *173 + - *332 + - *333 + - *482 + - *185 responses: '200': description: Response content: application/json: - schema: *362 + schema: *369 examples: - default: *486 + default: *493 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68682,10 +69047,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *325 - - *326 - - *475 - - *173 + - *332 + - *333 + - *482 + - *185 requestBody: required: true content: @@ -68716,7 +69081,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -68742,10 +69107,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret parameters: - - *325 - - *326 - - *475 - - *173 + - *332 + - *333 + - *482 + - *185 responses: '204': description: Default response @@ -68770,10 +69135,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables parameters: - - *325 - - *326 - - *475 - - *349 + - *332 + - *333 + - *482 + - *356 - *20 responses: '200': @@ -68790,9 +69155,9 @@ paths: type: integer variables: type: array - items: *366 + items: *373 examples: - default: *367 + default: *374 headers: Link: *39 x-github: @@ -68815,9 +69180,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable parameters: - - *325 - - *326 - - *475 + - *332 + - *333 + - *482 requestBody: required: true content: @@ -68844,7 +69209,7 @@ paths: description: Response content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -68869,18 +69234,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable parameters: - - *325 - - *326 - - *475 - - *176 + - *332 + - *333 + - *482 + - *188 responses: '200': description: Response content: application/json: - schema: *366 + schema: *373 examples: - default: *487 + default: *494 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68901,10 +69266,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable parameters: - - *325 - - *326 - - *176 - - *475 + - *332 + - *333 + - *188 + - *482 requestBody: required: true content: @@ -68946,10 +69311,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable parameters: - - *325 - - *326 - - *176 - - *475 + - *332 + - *333 + - *188 + - *482 responses: '204': description: Response @@ -68971,8 +69336,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -68982,7 +69347,7 @@ paths: application/json: schema: type: array - items: *134 + items: *146 examples: 200-response: value: @@ -69049,8 +69414,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks parameters: - - *325 - - *326 + - *332 + - *333 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -69072,7 +69437,7 @@ paths: application/json: schema: type: array - items: *163 + items: *175 examples: default: value: @@ -69209,8 +69574,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: false content: @@ -69242,9 +69607,9 @@ paths: description: Response content: application/json: - schema: *338 + schema: *345 examples: - default: *340 + default: *347 '400': *15 '422': *16 '403': *29 @@ -69265,8 +69630,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -69317,7 +69682,7 @@ paths: schema: type: string '404': *7 - '409': *150 + '409': *162 '403': *29 '422': description: Validation failed @@ -69325,8 +69690,8 @@ paths: application/json: schema: oneOf: - - *148 - - *488 + - *160 + - *495 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69351,8 +69716,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob parameters: - - *325 - - *326 + - *332 + - *333 - name: file_sha in: path required: true @@ -69403,7 +69768,7 @@ paths: '404': *7 '422': *16 '403': *29 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69451,8 +69816,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -69561,7 +69926,7 @@ paths: description: Response content: application/json: - schema: &489 + schema: &496 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -69724,7 +70089,7 @@ paths: type: string '422': *16 '404': *7 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69774,15 +70139,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object parameters: - - *325 - - *326 - - *442 + - *332 + - *333 + - *449 responses: '200': description: Response content: application/json: - schema: *489 + schema: *496 examples: default: value: @@ -69813,7 +70178,7 @@ paths: payload: verified_at: '404': *7 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69838,9 +70203,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references parameters: - - *325 - - *326 - - &490 + - *332 + - *333 + - &497 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. @@ -69857,7 +70222,7 @@ paths: application/json: schema: type: array - items: &491 + items: &498 title: Git Reference description: Git references within a repository type: object @@ -69911,7 +70276,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: Link: *39 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69932,17 +70297,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference parameters: - - *325 - - *326 - - *490 + - *332 + - *333 + - *497 responses: '200': description: Response content: application/json: - schema: *491 + schema: *498 examples: - default: &492 + default: &499 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -69952,7 +70317,7 @@ paths: sha: aa218f56b14c9653891f9e74264a383fa43fefbd url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd '404': *7 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69971,8 +70336,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -70001,16 +70366,16 @@ paths: description: Response content: application/json: - schema: *491 + schema: *498 examples: - default: *492 + default: *499 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA schema: type: string '422': *16 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70029,9 +70394,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference parameters: - - *325 - - *326 - - *490 + - *332 + - *333 + - *497 requestBody: required: true content: @@ -70060,11 +70425,11 @@ paths: description: Response content: application/json: - schema: *491 + schema: *498 examples: - default: *492 + default: *499 '422': *16 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70080,14 +70445,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference parameters: - - *325 - - *326 - - *490 + - *332 + - *333 + - *497 responses: '204': description: Response '422': *16 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70135,8 +70500,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -70203,7 +70568,7 @@ paths: description: Response content: application/json: - schema: &494 + schema: &501 title: Git Tag description: Metadata for a Git tag type: object @@ -70254,7 +70619,7 @@ paths: - sha - type - url - verification: *493 + verification: *500 required: - sha - url @@ -70264,7 +70629,7 @@ paths: - tag - message examples: - default: &495 + default: &502 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -70291,7 +70656,7 @@ paths: schema: type: string '422': *16 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70337,8 +70702,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag parameters: - - *325 - - *326 + - *332 + - *333 - name: tag_sha in: path required: true @@ -70349,11 +70714,11 @@ paths: description: Response content: application/json: - schema: *494 + schema: *501 examples: - default: *495 + default: *502 '404': *7 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70375,8 +70740,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -70449,7 +70814,7 @@ paths: description: Response content: application/json: - schema: &496 + schema: &503 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -70538,7 +70903,7 @@ paths: '422': *16 '404': *7 '403': *29 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70561,8 +70926,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree parameters: - - *325 - - *326 + - *332 + - *333 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -70585,7 +70950,7 @@ paths: description: Response content: application/json: - schema: *496 + schema: *503 examples: default-response: summary: Default response @@ -70626,7 +70991,7 @@ paths: truncated: false '422': *16 '404': *7 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70644,8 +71009,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -70655,7 +71020,7 @@ paths: application/json: schema: type: array - items: &497 + items: &504 title: Webhook description: Webhooks for repositories. type: object @@ -70709,7 +71074,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &742 + last_response: &749 title: Hook Response type: object properties: @@ -70783,8 +71148,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: false content: @@ -70836,9 +71201,9 @@ paths: description: Response content: application/json: - schema: *497 + schema: *504 examples: - default: &498 + default: &505 value: type: Repository id: 12345678 @@ -70886,17 +71251,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook parameters: - - *325 - - *326 - - *220 + - *332 + - *333 + - *232 responses: '200': description: Response content: application/json: - schema: *497 + schema: *504 examples: - default: *498 + default: *505 '404': *7 x-github: githubCloudOnly: false @@ -70916,9 +71281,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook parameters: - - *325 - - *326 - - *220 + - *332 + - *333 + - *232 requestBody: required: true content: @@ -70963,9 +71328,9 @@ paths: description: Response content: application/json: - schema: *497 + schema: *504 examples: - default: *498 + default: *505 '422': *16 '404': *7 x-github: @@ -70986,9 +71351,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook parameters: - - *325 - - *326 - - *220 + - *332 + - *333 + - *232 responses: '204': description: Response @@ -71012,9 +71377,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: - - *325 - - *326 - - *220 + - *332 + - *333 + - *232 responses: '200': description: Response @@ -71041,9 +71406,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: - - *325 - - *326 - - *220 + - *332 + - *333 + - *232 requestBody: required: false content: @@ -71087,11 +71452,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *325 - - *326 - - *220 + - *332 + - *333 + - *232 - *18 - - *221 + - *233 responses: '200': description: Response @@ -71099,9 +71464,9 @@ paths: application/json: schema: type: array - items: *222 + items: *234 examples: - default: *223 + default: *235 '400': *15 '422': *16 x-github: @@ -71120,18 +71485,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: - - *325 - - *326 - - *220 + - *332 + - *333 + - *232 - *17 responses: '200': description: Response content: application/json: - schema: *224 + schema: *236 examples: - default: *225 + default: *237 '400': *15 '422': *16 x-github: @@ -71150,12 +71515,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: - - *325 - - *326 - - *220 + - *332 + - *333 + - *232 - *17 responses: - '202': *151 + '202': *163 '400': *15 '422': *16 x-github: @@ -71175,9 +71540,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook parameters: - - *325 - - *326 - - *220 + - *332 + - *333 + - *232 responses: '204': description: Response @@ -71202,9 +71567,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *325 - - *326 - - *220 + - *332 + - *333 + - *232 responses: '204': description: Response @@ -71262,14 +71627,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: &499 + schema: &506 title: Import description: A repository import from an external source. type: object @@ -71368,7 +71733,7 @@ paths: - html_url - authors_url examples: - default: &502 + default: &509 value: vcs: subversion use_lfs: true @@ -71384,7 +71749,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *7 - '503': &500 + '503': &507 description: Unavailable due to service under maintenance. content: application/json: @@ -71413,8 +71778,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -71462,7 +71827,7 @@ paths: description: Response content: application/json: - schema: *499 + schema: *506 examples: default: value: @@ -71487,7 +71852,7 @@ paths: type: string '422': *16 '404': *7 - '503': *500 + '503': *507 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71515,8 +71880,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: false content: @@ -71565,7 +71930,7 @@ paths: description: Response content: application/json: - schema: *499 + schema: *506 examples: example-1: summary: Example 1 @@ -71613,7 +71978,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': *500 + '503': *507 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71636,12 +72001,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import parameters: - - *325 - - *326 + - *332 + - *333 responses: '204': description: Response - '503': *500 + '503': *507 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71667,9 +72032,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors parameters: - - *325 - - *326 - - &688 + - *332 + - *333 + - &695 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -71683,7 +72048,7 @@ paths: application/json: schema: type: array - items: &501 + items: &508 title: Porter Author description: Porter Author type: object @@ -71737,7 +72102,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *7 - '503': *500 + '503': *507 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71762,8 +72127,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author parameters: - - *325 - - *326 + - *332 + - *333 - name: author_id in: path required: true @@ -71793,7 +72158,7 @@ paths: description: Response content: application/json: - schema: *501 + schema: *508 examples: default: value: @@ -71806,7 +72171,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *16 '404': *7 - '503': *500 + '503': *507 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71830,8 +72195,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -71872,7 +72237,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *500 + '503': *507 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71900,8 +72265,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -71928,11 +72293,11 @@ paths: description: Response content: application/json: - schema: *499 + schema: *506 examples: - default: *502 + default: *509 '422': *16 - '503': *500 + '503': *507 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71955,8 +72320,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -71964,8 +72329,8 @@ paths: application/json: schema: *22 examples: - default: *503 - '301': *339 + default: *510 + '301': *346 '404': *7 x-github: githubCloudOnly: false @@ -71985,8 +72350,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -71994,12 +72359,12 @@ paths: application/json: schema: anyOf: - - *238 + - *250 - type: object properties: {} additionalProperties: false examples: - default: &505 + default: &512 value: limit: collaborators_only origin: repository @@ -72024,13 +72389,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: application/json: - schema: *504 + schema: *511 examples: default: summary: Example request body @@ -72042,9 +72407,9 @@ paths: description: Response content: application/json: - schema: *238 + schema: *250 examples: - default: *505 + default: *512 '409': description: Response x-github: @@ -72066,8 +72431,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *325 - - *326 + - *332 + - *333 responses: '204': description: Response @@ -72090,8 +72455,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -72101,9 +72466,9 @@ paths: application/json: schema: type: array - items: *506 + items: *513 examples: - default: &681 + default: &688 value: - id: 1 repository: @@ -72234,9 +72599,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation parameters: - - *325 - - *326 - - *242 + - *332 + - *333 + - *254 requestBody: required: false content: @@ -72265,7 +72630,7 @@ paths: description: Response content: application/json: - schema: *506 + schema: *513 examples: default: value: @@ -72396,9 +72761,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *325 - - *326 - - *242 + - *332 + - *333 + - *254 responses: '204': description: Response @@ -72429,8 +72794,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues parameters: - - *325 - - *326 + - *332 + - *333 - 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 @@ -72470,7 +72835,7 @@ paths: required: false schema: type: string - - *244 + - *256 - name: sort description: What to sort results by. in: query @@ -72483,7 +72848,7 @@ paths: - comments default: created - *78 - - *112 + - *124 - *18 - *20 responses: @@ -72493,9 +72858,9 @@ paths: application/json: schema: type: array - items: *122 + items: *134 examples: - default: &517 + default: &524 value: - id: 1 node_id: MDU6SXNzdWUx @@ -72643,7 +73008,7 @@ paths: state_reason: completed headers: Link: *39 - '301': *339 + '301': *346 '422': *16 '404': *7 x-github: @@ -72672,8 +73037,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -72748,9 +73113,9 @@ paths: description: Response content: application/json: - schema: *122 + schema: *134 examples: - default: &512 + default: &519 value: id: 1 node_id: MDU6SXNzdWUx @@ -72904,9 +73269,9 @@ paths: '400': *15 '403': *29 '422': *16 - '503': *100 + '503': *112 '404': *7 - '410': *336 + '410': *343 x-github: triggersNotification: true githubCloudOnly: false @@ -72934,9 +73299,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *325 - - *326 - - *132 + - *332 + - *333 + - *144 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -72946,7 +73311,7 @@ paths: enum: - asc - desc - - *112 + - *124 - *18 - *20 responses: @@ -72956,9 +73321,9 @@ paths: application/json: schema: type: array - items: *507 + items: *514 examples: - default: &514 + default: &521 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -73016,17 +73381,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment parameters: - - *325 - - *326 - - *121 + - *332 + - *333 + - *133 responses: '200': description: Response content: application/json: - schema: *507 + schema: *514 examples: - default: &508 + default: &515 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -73080,9 +73445,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment parameters: - - *325 - - *326 - - *121 + - *332 + - *333 + - *133 requestBody: required: true content: @@ -73104,9 +73469,9 @@ paths: description: Response content: application/json: - schema: *507 + schema: *514 examples: - default: *508 + default: *515 '422': *16 x-github: githubCloudOnly: false @@ -73124,9 +73489,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment parameters: - - *325 - - *326 - - *121 + - *332 + - *333 + - *133 responses: '204': description: Response @@ -73146,9 +73511,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *325 - - *326 - - *121 + - *332 + - *333 + - *133 - 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. @@ -73174,9 +73539,9 @@ paths: application/json: schema: type: array - items: *314 + items: *321 examples: - default: *316 + default: *323 headers: Link: *39 '404': *7 @@ -73197,9 +73562,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *325 - - *326 - - *121 + - *332 + - *333 + - *133 requestBody: required: true content: @@ -73231,16 +73596,16 @@ paths: description: Reaction exists content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 '201': description: Reaction created content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 '422': *16 x-github: githubCloudOnly: false @@ -73262,10 +73627,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *325 - - *326 - - *121 - - *317 + - *332 + - *333 + - *133 + - *324 responses: '204': description: Response @@ -73285,8 +73650,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -73296,7 +73661,7 @@ paths: application/json: schema: type: array - items: &511 + items: &518 title: Issue Event description: Issue Event type: object @@ -73339,8 +73704,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *509 - required: *510 + properties: *516 + required: *517 nullable: true label: title: Issue Event Label @@ -73384,7 +73749,7 @@ paths: properties: *4 required: *5 nullable: true - requested_team: *243 + requested_team: *255 dismissed_review: title: Issue Event Dismissed Review type: object @@ -73449,7 +73814,7 @@ paths: required: - from - to - author_association: *109 + author_association: *121 lock_reason: type: string nullable: true @@ -73462,8 +73827,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 required: - id - node_id @@ -73647,8 +74012,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event parameters: - - *325 - - *326 + - *332 + - *333 - name: event_id in: path required: true @@ -73659,7 +74024,7 @@ paths: description: Response content: application/json: - schema: *511 + schema: *518 examples: default: value: @@ -73852,7 +74217,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *7 - '410': *336 + '410': *343 '403': *29 x-github: githubCloudOnly: false @@ -73886,9 +74251,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue parameters: - - *325 - - *326 - - &513 + - *332 + - *333 + - &520 name: issue_number description: The number that identifies the issue. in: path @@ -73900,12 +74265,12 @@ paths: description: Response content: application/json: - schema: *122 + schema: *134 examples: - default: *512 - '301': *339 + default: *519 + '301': *346 '404': *7 - '410': *336 + '410': *343 '304': *37 x-github: githubCloudOnly: false @@ -73930,9 +74295,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 requestBody: required: false content: @@ -74027,15 +74392,15 @@ paths: description: Response content: application/json: - schema: *122 + schema: *134 examples: - default: *512 + default: *519 '422': *16 - '503': *100 + '503': *112 '403': *29 - '301': *339 + '301': *346 '404': *7 - '410': *336 + '410': *343 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74053,9 +74418,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 requestBody: required: false content: @@ -74081,9 +74446,9 @@ paths: description: Response content: application/json: - schema: *122 + schema: *134 examples: - default: *512 + default: *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74099,9 +74464,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 requestBody: content: application/json: @@ -74126,9 +74491,9 @@ paths: description: Response content: application/json: - schema: *122 + schema: *134 examples: - default: *512 + default: *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74150,9 +74515,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: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 - name: assignee in: path required: true @@ -74192,10 +74557,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments parameters: - - *325 - - *326 - - *513 - - *112 + - *332 + - *333 + - *520 + - *124 - *18 - *20 responses: @@ -74205,13 +74570,13 @@ paths: application/json: schema: type: array - items: *507 + items: *514 examples: - default: *514 + default: *521 headers: Link: *39 '404': *7 - '410': *336 + '410': *343 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74240,9 +74605,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 requestBody: required: true content: @@ -74264,16 +74629,16 @@ paths: description: Response content: application/json: - schema: *507 + schema: *514 examples: - default: *508 + default: *515 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *336 + '410': *343 '422': *16 '404': *7 x-github: @@ -74293,9 +74658,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 - *18 - *20 responses: @@ -74309,7 +74674,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &518 + - &525 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -74340,8 +74705,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 label: type: object properties: @@ -74363,7 +74728,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &519 + - &526 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -74394,8 +74759,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 label: type: object properties: @@ -74483,8 +74848,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 assignee: *19 assigner: *19 required: @@ -74499,7 +74864,7 @@ paths: - performed_via_github_app - assignee - assigner - - &520 + - &527 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -74530,8 +74895,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 milestone: type: object properties: @@ -74550,7 +74915,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &521 + - &528 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -74581,8 +74946,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 milestone: type: object properties: @@ -74601,7 +74966,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &522 + - &529 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -74632,8 +74997,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 rename: type: object properties: @@ -74655,7 +75020,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &523 + - &530 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -74686,10 +75051,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 review_requester: *19 - requested_team: *243 + requested_team: *255 requested_reviewer: *19 required: - review_requester @@ -74702,7 +75067,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &524 + - &531 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -74733,10 +75098,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 review_requester: *19 - requested_team: *243 + requested_team: *255 requested_reviewer: *19 required: - review_requester @@ -74749,7 +75114,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &525 + - &532 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -74780,8 +75145,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 dismissed_review: type: object properties: @@ -74809,7 +75174,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &526 + - &533 title: Locked Issue Event description: Locked Issue Event type: object @@ -74840,8 +75205,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 lock_reason: type: string example: '"off-topic"' @@ -74857,7 +75222,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &527 + - &534 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -74888,8 +75253,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 project_card: type: object properties: @@ -74923,7 +75288,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &528 + - &535 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -74954,8 +75319,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 project_card: type: object properties: @@ -74989,7 +75354,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &529 + - &536 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -75020,8 +75385,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 project_card: type: object properties: @@ -75055,7 +75420,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &530 + - &537 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -75146,7 +75511,7 @@ paths: color: red headers: Link: *39 - '410': *336 + '410': *343 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75163,9 +75528,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 - *18 - *20 responses: @@ -75175,7 +75540,7 @@ paths: application/json: schema: type: array - items: &515 + items: &522 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -75222,7 +75587,7 @@ paths: - color - default examples: - default: &516 + default: &523 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -75240,9 +75605,9 @@ paths: default: false headers: Link: *39 - '301': *339 + '301': *346 '404': *7 - '410': *336 + '410': *343 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75259,9 +75624,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 requestBody: required: false content: @@ -75320,12 +75685,12 @@ paths: application/json: schema: type: array - items: *515 + items: *522 examples: - default: *516 - '301': *339 + default: *523 + '301': *346 '404': *7 - '410': *336 + '410': *343 '422': *16 x-github: githubCloudOnly: false @@ -75342,9 +75707,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 requestBody: required: false content: @@ -75404,12 +75769,12 @@ paths: application/json: schema: type: array - items: *515 + items: *522 examples: - default: *516 - '301': *339 + default: *523 + '301': *346 '404': *7 - '410': *336 + '410': *343 '422': *16 x-github: githubCloudOnly: false @@ -75426,15 +75791,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 responses: '204': description: Response - '301': *339 + '301': *346 '404': *7 - '410': *336 + '410': *343 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75453,9 +75818,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 - name: name in: path required: true @@ -75468,7 +75833,7 @@ paths: application/json: schema: type: array - items: *515 + items: *522 examples: default: value: @@ -75479,9 +75844,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *339 + '301': *346 '404': *7 - '410': *336 + '410': *343 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75501,9 +75866,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 requestBody: required: false content: @@ -75531,7 +75896,7 @@ paths: '204': description: Response '403': *29 - '410': *336 + '410': *343 '404': *7 '422': *16 x-github: @@ -75549,9 +75914,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 responses: '204': description: Response @@ -75573,9 +75938,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 - 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. @@ -75601,13 +75966,13 @@ paths: application/json: schema: type: array - items: *314 + items: *321 examples: - default: *316 + default: *323 headers: Link: *39 '404': *7 - '410': *336 + '410': *343 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75625,9 +75990,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 requestBody: required: true content: @@ -75659,16 +76024,16 @@ paths: description: Response content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 '201': description: Response content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 '422': *16 x-github: githubCloudOnly: false @@ -75690,10 +76055,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction parameters: - - *325 - - *326 - - *513 - - *317 + - *332 + - *333 + - *520 + - *324 responses: '204': description: Response @@ -75722,9 +76087,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 requestBody: required: true content: @@ -75746,9 +76111,9 @@ paths: description: Response content: application/json: - schema: *122 + schema: *134 examples: - default: *512 + default: *519 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -75781,9 +76146,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 - *18 - *20 responses: @@ -75793,13 +76158,13 @@ paths: application/json: schema: type: array - items: *122 + items: *134 examples: - default: *517 + default: *524 headers: Link: *39 '404': *7 - '410': *336 + '410': *343 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75827,9 +76192,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 requestBody: required: true content: @@ -75855,16 +76220,16 @@ paths: description: Response content: application/json: - schema: *122 + schema: *134 examples: - default: *512 + default: *519 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *336 + '410': *343 '422': *16 '404': *7 x-github: @@ -75884,9 +76249,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 requestBody: required: true content: @@ -75917,13 +76282,13 @@ paths: description: Response content: application/json: - schema: *122 + schema: *134 examples: - default: *512 + default: *519 '403': *29 '404': *7 '422': *8 - '503': *100 + '503': *112 x-github: triggersNotification: true githubCloudOnly: false @@ -75941,9 +76306,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *325 - - *326 - - *513 + - *332 + - *333 + - *520 - *18 - *20 responses: @@ -75958,19 +76323,19 @@ paths: description: Timeline Event type: object anyOf: - - *518 - - *519 - - *520 - - *521 - - *522 - - *523 - - *524 - *525 - *526 - *527 - *528 - *529 - *530 + - *531 + - *532 + - *533 + - *534 + - *535 + - *536 + - *537 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -76013,7 +76378,7 @@ paths: issue_url: type: string format: uri - author_association: *109 + author_association: *121 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. They @@ -76023,9 +76388,9 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 - reactions: *110 + properties: *119 + required: *120 + reactions: *122 required: - event - actor @@ -76056,7 +76421,7 @@ paths: properties: type: type: string - issue: *122 + issue: *134 required: - event - created_at @@ -76251,7 +76616,7 @@ paths: type: string body_text: type: string - author_association: *109 + author_association: *121 required: - event - id @@ -76274,7 +76639,7 @@ paths: type: string comments: type: array - items: &551 + items: &558 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -76363,7 +76728,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *109 + author_association: *121 _links: type: object properties: @@ -76447,7 +76812,7 @@ paths: enum: - line - file - reactions: *110 + reactions: *122 body_html: type: string example: '"

comment body

"' @@ -76483,7 +76848,7 @@ paths: type: string comments: type: array - items: *440 + items: *447 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -76514,8 +76879,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 assignee: *19 required: - id @@ -76558,8 +76923,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 assignee: *19 required: - id @@ -76602,8 +76967,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 state_reason: type: string nullable: true @@ -76772,7 +77137,7 @@ paths: headers: Link: *39 '404': *7 - '410': *336 + '410': *343 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76789,8 +77154,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -76800,7 +77165,7 @@ paths: application/json: schema: type: array - items: &531 + items: &538 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -76865,8 +77230,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -76902,9 +77267,9 @@ paths: description: Response content: application/json: - schema: *531 + schema: *538 examples: - default: &532 + default: &539 value: id: 1 key: ssh-rsa AAA... @@ -76938,9 +77303,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *325 - - *326 - - &533 + - *332 + - *333 + - &540 name: key_id description: The unique identifier of the key. in: path @@ -76952,9 +77317,9 @@ paths: description: Response content: application/json: - schema: *531 + schema: *538 examples: - default: *532 + default: *539 '404': *7 x-github: githubCloudOnly: false @@ -76972,9 +77337,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *325 - - *326 - - *533 + - *332 + - *333 + - *540 responses: '204': description: Response @@ -76994,8 +77359,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -77005,9 +77370,9 @@ paths: application/json: schema: type: array - items: *515 + items: *522 examples: - default: *516 + default: *523 headers: Link: *39 '404': *7 @@ -77028,8 +77393,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -77065,9 +77430,9 @@ paths: description: Response content: application/json: - schema: *515 + schema: *522 examples: - default: &534 + default: &541 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -77099,8 +77464,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label parameters: - - *325 - - *326 + - *332 + - *333 - name: name in: path required: true @@ -77111,9 +77476,9 @@ paths: description: Response content: application/json: - schema: *515 + schema: *522 examples: - default: *534 + default: *541 '404': *7 x-github: githubCloudOnly: false @@ -77130,8 +77495,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label parameters: - - *325 - - *326 + - *332 + - *333 - name: name in: path required: true @@ -77170,7 +77535,7 @@ paths: description: Response content: application/json: - schema: *515 + schema: *522 examples: default: value: @@ -77196,8 +77561,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label parameters: - - *325 - - *326 + - *332 + - *333 - name: name in: path required: true @@ -77223,8 +77588,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -77260,10 +77625,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *325 - - *326 + - *332 + - *333 responses: - '202': *151 + '202': *163 '403': description: |- We will return a 403 with one of the following messages: @@ -77289,8 +77654,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *325 - - *326 + - *332 + - *333 responses: '204': description: Response @@ -77316,9 +77681,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *325 - - *326 - - *415 + - *332 + - *333 + - *422 responses: '200': description: Response @@ -77380,8 +77745,8 @@ paths: title: License Simple description: License Simple type: object - properties: *123 - required: *124 + properties: *135 + required: *136 nullable: true required: - _links @@ -77463,8 +77828,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: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -77529,8 +77894,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -77564,9 +77929,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *441 + schema: *448 examples: - default: *535 + default: *542 '204': description: Response when already merged '404': @@ -77591,8 +77956,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones parameters: - - *325 - - *326 + - *332 + - *333 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -77633,12 +77998,12 @@ paths: application/json: schema: type: array - items: &536 + items: &543 title: Milestone description: A collection of related issues and pull requests. type: object - properties: *445 - required: *446 + properties: *452 + required: *453 examples: default: value: @@ -77694,8 +78059,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -77735,9 +78100,9 @@ paths: description: Response content: application/json: - schema: *536 + schema: *543 examples: - default: &537 + default: &544 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -77796,9 +78161,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone parameters: - - *325 - - *326 - - &538 + - *332 + - *333 + - &545 name: milestone_number description: The number that identifies the milestone. in: path @@ -77810,9 +78175,9 @@ paths: description: Response content: application/json: - schema: *536 + schema: *543 examples: - default: *537 + default: *544 '404': *7 x-github: githubCloudOnly: false @@ -77829,9 +78194,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone parameters: - - *325 - - *326 - - *538 + - *332 + - *333 + - *545 requestBody: required: false content: @@ -77869,9 +78234,9 @@ paths: description: Response content: application/json: - schema: *536 + schema: *543 examples: - default: *537 + default: *544 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77887,9 +78252,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone parameters: - - *325 - - *326 - - *538 + - *332 + - *333 + - *545 responses: '204': description: Response @@ -77910,9 +78275,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: - - *325 - - *326 - - *538 + - *332 + - *333 + - *545 - *18 - *20 responses: @@ -77922,9 +78287,9 @@ paths: application/json: schema: type: array - items: *515 + items: *522 examples: - default: *516 + default: *523 headers: Link: *39 x-github: @@ -77943,12 +78308,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: - - *325 - - *326 - - *539 - - *540 - - *112 - - *541 + - *332 + - *333 + - *546 + - *547 + - *124 + - *548 - *18 - *20 responses: @@ -77958,9 +78323,9 @@ paths: application/json: schema: type: array - items: *135 + items: *147 examples: - default: *542 + default: *549 headers: Link: *39 x-github: @@ -77984,8 +78349,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: false content: @@ -78043,14 +78408,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: &543 + schema: &550 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -78175,7 +78540,7 @@ paths: - custom_404 - public examples: - default: &544 + default: &551 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -78216,8 +78581,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -78271,11 +78636,11 @@ paths: description: Response content: application/json: - schema: *543 + schema: *550 examples: - default: *544 + default: *551 '422': *16 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78296,8 +78661,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: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -78383,7 +78748,7 @@ paths: description: Response '422': *16 '400': *15 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78404,14 +78769,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site parameters: - - *325 - - *326 + - *332 + - *333 responses: '204': description: Response '422': *16 '404': *7 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78431,8 +78796,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -78442,7 +78807,7 @@ paths: application/json: schema: type: array - items: &545 + items: &552 title: Page Build description: Page Build type: object @@ -78536,8 +78901,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build parameters: - - *325 - - *326 + - *332 + - *333 responses: '201': description: Response @@ -78582,16 +78947,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *545 + schema: *552 examples: - default: &546 + default: &553 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -78639,8 +79004,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build parameters: - - *325 - - *326 + - *332 + - *333 - name: build_id in: path required: true @@ -78651,9 +79016,9 @@ paths: description: Response content: application/json: - schema: *545 + schema: *552 examples: - default: *546 + default: *553 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78673,8 +79038,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -78780,9 +79145,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: - - *325 - - *326 - - &547 + - *332 + - *333 + - &554 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -78840,11 +79205,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *325 - - *326 - - *547 + - *332 + - *333 + - *554 responses: - '204': *192 + '204': *204 '404': *7 x-github: githubCloudOnly: false @@ -78869,8 +79234,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -79101,7 +79466,7 @@ paths: description: Empty response content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -79128,8 +79493,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Private vulnerability reporting status @@ -79166,10 +79531,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: - - *325 - - *326 + - *332 + - *333 responses: - '204': *192 + '204': *204 '422': *15 x-github: githubCloudOnly: false @@ -79188,10 +79553,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: - - *325 - - *326 + - *332 + - *333 responses: - '204': *192 + '204': *204 '422': *15 x-github: githubCloudOnly: false @@ -79212,8 +79577,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-repository-projects parameters: - - *325 - - *326 + - *332 + - *333 - name: state description: Indicates the state of the projects to return. in: query @@ -79234,7 +79599,7 @@ paths: application/json: schema: type: array - items: *272 + items: *284 examples: default: value: @@ -79274,7 +79639,7 @@ paths: '401': *25 '403': *29 '404': *7 - '410': *336 + '410': *343 '422': *8 x-github: githubCloudOnly: false @@ -79294,8 +79659,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#create-a-repository-project parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -79321,13 +79686,13 @@ paths: description: Response content: application/json: - schema: *272 + schema: *284 examples: - default: *335 + default: *342 '401': *25 '403': *29 '404': *7 - '410': *336 + '410': *343 '422': *8 x-github: githubCloudOnly: false @@ -79347,8 +79712,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -79356,7 +79721,7 @@ paths: application/json: schema: type: array - items: *273 + items: *286 examples: default: value: @@ -79387,8 +79752,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: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -79400,7 +79765,7 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *273 + items: *286 required: - properties examples: @@ -79450,8 +79815,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests parameters: - - *325 - - *326 + - *332 + - *333 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -79511,9 +79876,9 @@ paths: application/json: schema: type: array - items: *548 + items: *555 examples: - default: *549 + default: *556 headers: Link: *39 '304': *37 @@ -79545,8 +79910,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -79611,7 +79976,7 @@ paths: description: Response content: application/json: - schema: &553 + schema: &560 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -79722,8 +80087,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *445 - required: *446 + properties: *452 + required: *453 nullable: true active_lock_reason: type: string @@ -79768,7 +80133,7 @@ paths: nullable: true requested_teams: type: array - items: *297 + items: *304 nullable: true head: type: object @@ -79807,14 +80172,14 @@ paths: _links: type: object properties: - comments: *447 - commits: *447 - statuses: *447 - html: *447 - issue: *447 - review_comments: *447 - review_comment: *447 - self: *447 + comments: *454 + commits: *454 + statuses: *454 + html: *454 + issue: *454 + review_comments: *454 + review_comment: *454 + self: *454 required: - comments - commits @@ -79824,8 +80189,8 @@ paths: - review_comments - review_comment - self - author_association: *109 - auto_merge: *550 + author_association: *121 + auto_merge: *557 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -79917,7 +80282,7 @@ paths: - merged_by - review_comments examples: - default: &554 + default: &561 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -80444,8 +80809,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *325 - - *326 + - *332 + - *333 - name: sort in: query required: false @@ -80464,7 +80829,7 @@ paths: enum: - asc - desc - - *112 + - *124 - *18 - *20 responses: @@ -80474,9 +80839,9 @@ paths: application/json: schema: type: array - items: *551 + items: *558 examples: - default: &556 + default: &563 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -80553,17 +80918,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: - - *325 - - *326 - - *121 + - *332 + - *333 + - *133 responses: '200': description: Response content: application/json: - schema: *551 + schema: *558 examples: - default: &552 + default: &559 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -80638,9 +81003,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: - - *325 - - *326 - - *121 + - *332 + - *333 + - *133 requestBody: required: true content: @@ -80662,9 +81027,9 @@ paths: description: Response content: application/json: - schema: *551 + schema: *558 examples: - default: *552 + default: *559 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80680,9 +81045,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: - - *325 - - *326 - - *121 + - *332 + - *333 + - *133 responses: '204': description: Response @@ -80703,9 +81068,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: - - *325 - - *326 - - *121 + - *332 + - *333 + - *133 - 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. @@ -80731,9 +81096,9 @@ paths: application/json: schema: type: array - items: *314 + items: *321 examples: - default: *316 + default: *323 headers: Link: *39 '404': *7 @@ -80754,9 +81119,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: - - *325 - - *326 - - *121 + - *332 + - *333 + - *133 requestBody: required: true content: @@ -80788,16 +81153,16 @@ paths: description: Reaction exists content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 '201': description: Reaction created content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 '422': *16 x-github: githubCloudOnly: false @@ -80819,10 +81184,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *325 - - *326 - - *121 - - *317 + - *332 + - *333 + - *133 + - *324 responses: '204': description: Response @@ -80865,9 +81230,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request parameters: - - *325 - - *326 - - &555 + - *332 + - *333 + - &562 name: pull_number description: The number that identifies the pull request. in: path @@ -80880,9 +81245,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *553 + schema: *560 examples: - default: *554 + default: *561 '304': *37 '404': *7 '406': @@ -80891,7 +81256,7 @@ paths: application/json: schema: *3 '500': *84 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80917,9 +81282,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request parameters: - - *325 - - *326 - - *555 + - *332 + - *333 + - *562 requestBody: required: false content: @@ -80961,9 +81326,9 @@ paths: description: Response content: application/json: - schema: *553 + schema: *560 examples: - default: *554 + default: *561 '422': *16 '403': *29 x-github: @@ -80985,9 +81350,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: - - *325 - - *326 - - *555 + - *332 + - *333 + - *562 requestBody: required: true content: @@ -81047,21 +81412,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *247 + schema: *259 examples: - default: *430 + default: *437 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *247 + schema: *259 examples: - default: *430 + default: *437 '401': *25 '403': *29 '404': *7 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -81087,10 +81452,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: - - *325 - - *326 - - *555 - - *132 + - *332 + - *333 + - *562 + - *144 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -81100,7 +81465,7 @@ paths: enum: - asc - desc - - *112 + - *124 - *18 - *20 responses: @@ -81110,9 +81475,9 @@ paths: application/json: schema: type: array - items: *551 + items: *558 examples: - default: *556 + default: *563 headers: Link: *39 x-github: @@ -81145,9 +81510,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: - - *325 - - *326 - - *555 + - *332 + - *333 + - *562 requestBody: required: true content: @@ -81252,7 +81617,7 @@ paths: description: Response content: application/json: - schema: *551 + schema: *558 examples: example-for-a-multi-line-comment: value: @@ -81340,10 +81705,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: - - *325 - - *326 - - *555 - - *121 + - *332 + - *333 + - *562 + - *133 requestBody: required: true content: @@ -81365,7 +81730,7 @@ paths: description: Response content: application/json: - schema: *551 + schema: *558 examples: default: value: @@ -81451,9 +81816,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *325 - - *326 - - *555 + - *332 + - *333 + - *562 - *18 - *20 responses: @@ -81463,9 +81828,9 @@ paths: application/json: schema: type: array - items: *441 + items: *448 examples: - default: *557 + default: *564 headers: Link: *39 x-github: @@ -81495,9 +81860,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files parameters: - - *325 - - *326 - - *555 + - *332 + - *333 + - *562 - *18 - *20 responses: @@ -81507,7 +81872,7 @@ paths: application/json: schema: type: array - items: *456 + items: *463 examples: default: value: @@ -81526,7 +81891,7 @@ paths: Link: *39 '422': *16 '500': *84 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81545,9 +81910,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: - - *325 - - *326 - - *555 + - *332 + - *333 + - *562 responses: '204': description: Response if pull request has been merged @@ -81570,9 +81935,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request parameters: - - *325 - - *326 - - *555 + - *332 + - *333 + - *562 requestBody: required: false content: @@ -81683,9 +82048,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: - - *325 - - *326 - - *555 + - *332 + - *333 + - *562 responses: '200': description: Response @@ -81701,7 +82066,7 @@ paths: items: *19 teams: type: array - items: *243 + items: *255 required: - users - teams @@ -81760,9 +82125,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: - - *325 - - *326 - - *555 + - *332 + - *333 + - *562 requestBody: required: false content: @@ -81799,7 +82164,7 @@ paths: description: Response content: application/json: - schema: *548 + schema: *555 examples: default: value: @@ -82335,9 +82700,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: - - *325 - - *326 - - *555 + - *332 + - *333 + - *562 requestBody: required: true content: @@ -82371,7 +82736,7 @@ paths: description: Response content: application/json: - schema: *548 + schema: *555 examples: default: value: @@ -82876,9 +83241,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *325 - - *326 - - *555 + - *332 + - *333 + - *562 - *18 - *20 responses: @@ -82888,7 +83253,7 @@ paths: application/json: schema: type: array - items: &558 + items: &565 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -82957,7 +83322,7 @@ paths: type: string body_text: type: string - author_association: *109 + author_association: *121 required: - id - node_id @@ -83039,9 +83404,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: - - *325 - - *326 - - *555 + - *332 + - *333 + - *562 requestBody: required: false content: @@ -83127,9 +83492,9 @@ paths: description: Response content: application/json: - schema: *558 + schema: *565 examples: - default: &560 + default: &567 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -83192,10 +83557,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: - - *325 - - *326 - - *555 - - &559 + - *332 + - *333 + - *562 + - &566 name: review_id description: The unique identifier of the review. in: path @@ -83207,9 +83572,9 @@ paths: description: Response content: application/json: - schema: *558 + schema: *565 examples: - default: &561 + default: &568 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -83268,10 +83633,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: - - *325 - - *326 - - *555 - - *559 + - *332 + - *333 + - *562 + - *566 requestBody: required: true content: @@ -83294,7 +83659,7 @@ paths: description: Response content: application/json: - schema: *558 + schema: *565 examples: default: value: @@ -83356,18 +83721,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: - - *325 - - *326 - - *555 - - *559 + - *332 + - *333 + - *562 + - *566 responses: '200': description: Response content: application/json: - schema: *558 + schema: *565 examples: - default: *560 + default: *567 '422': *8 '404': *7 x-github: @@ -83394,10 +83759,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: - - *325 - - *326 - - *555 - - *559 + - *332 + - *333 + - *562 + - *566 - *18 - *20 responses: @@ -83476,13 +83841,13 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *109 + author_association: *121 _links: type: object properties: - self: *447 - html: *447 - pull_request: *447 + self: *454 + html: *454 + pull_request: *454 required: - self - html @@ -83491,7 +83856,7 @@ paths: type: string body_html: type: string - reactions: *110 + reactions: *122 side: description: The side of the first line of the range for a multi-line comment. @@ -83625,10 +83990,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: - - *325 - - *326 - - *555 - - *559 + - *332 + - *333 + - *562 + - *566 requestBody: required: true content: @@ -83656,7 +84021,7 @@ paths: description: Response content: application/json: - schema: *558 + schema: *565 examples: default: value: @@ -83719,10 +84084,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: - - *325 - - *326 - - *555 - - *559 + - *332 + - *333 + - *562 + - *566 requestBody: required: true content: @@ -83757,9 +84122,9 @@ paths: description: Response content: application/json: - schema: *558 + schema: *565 examples: - default: *561 + default: *568 '404': *7 '422': *8 '403': *29 @@ -83781,9 +84146,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch parameters: - - *325 - - *326 - - *555 + - *332 + - *333 + - *562 requestBody: required: false content: @@ -83846,8 +84211,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme parameters: - - *325 - - *326 + - *332 + - *333 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -83860,9 +84225,9 @@ paths: description: Response content: application/json: - schema: *562 + schema: *569 examples: - default: &563 + default: &570 value: type: file encoding: base64 @@ -83904,8 +84269,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: - - *325 - - *326 + - *332 + - *333 - name: dir description: The alternate path to look for a README file in: path @@ -83925,9 +84290,9 @@ paths: description: Response content: application/json: - schema: *562 + schema: *569 examples: - default: *563 + default: *570 '404': *7 '422': *16 x-github: @@ -83949,8 +84314,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -83960,7 +84325,7 @@ paths: application/json: schema: type: array - items: &564 + items: &571 title: Release description: A release. type: object @@ -84023,7 +84388,7 @@ paths: author: *19 assets: type: array - items: &565 + items: &572 title: Release Asset description: Data related to a release. type: object @@ -84094,7 +84459,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *110 + reactions: *122 required: - assets_url - upload_url @@ -84204,8 +84569,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -84281,9 +84646,9 @@ paths: description: Response content: application/json: - schema: *564 + schema: *571 examples: - default: &568 + default: &575 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -84386,9 +84751,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset parameters: - - *325 - - *326 - - &566 + - *332 + - *333 + - &573 name: asset_id description: The unique identifier of the asset. in: path @@ -84400,9 +84765,9 @@ paths: description: Response content: application/json: - schema: *565 + schema: *572 examples: - default: &567 + default: &574 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 @@ -84436,7 +84801,7 @@ paths: type: User site_admin: false '404': *7 - '302': *458 + '302': *465 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84452,9 +84817,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset parameters: - - *325 - - *326 - - *566 + - *332 + - *333 + - *573 requestBody: required: false content: @@ -84482,9 +84847,9 @@ paths: description: Response content: application/json: - schema: *565 + schema: *572 examples: - default: *567 + default: *574 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84500,9 +84865,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset parameters: - - *325 - - *326 - - *566 + - *332 + - *333 + - *573 responses: '204': description: Response @@ -84526,8 +84891,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: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -84612,16 +84977,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *564 + schema: *571 examples: - default: *568 + default: *575 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84638,8 +85003,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name parameters: - - *325 - - *326 + - *332 + - *333 - name: tag description: tag parameter in: path @@ -84652,9 +85017,9 @@ paths: description: Response content: application/json: - schema: *564 + schema: *571 examples: - default: *568 + default: *575 '404': *7 x-github: githubCloudOnly: false @@ -84676,9 +85041,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release parameters: - - *325 - - *326 - - &569 + - *332 + - *333 + - &576 name: release_id description: The unique identifier of the release. in: path @@ -84692,9 +85057,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: *564 + schema: *571 examples: - default: *568 + default: *575 '401': description: Unauthorized x-github: @@ -84712,9 +85077,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release parameters: - - *325 - - *326 - - *569 + - *332 + - *333 + - *576 requestBody: required: false content: @@ -84778,9 +85143,9 @@ paths: description: Response content: application/json: - schema: *564 + schema: *571 examples: - default: *568 + default: *575 '404': description: Not Found if the discussion category name is invalid content: @@ -84801,9 +85166,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release parameters: - - *325 - - *326 - - *569 + - *332 + - *333 + - *576 responses: '204': description: Response @@ -84823,9 +85188,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets parameters: - - *325 - - *326 - - *569 + - *332 + - *333 + - *576 - *18 - *20 responses: @@ -84835,7 +85200,7 @@ paths: application/json: schema: type: array - items: *565 + items: *572 examples: default: value: @@ -84916,9 +85281,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: - - *325 - - *326 - - *569 + - *332 + - *333 + - *576 - name: name in: query required: true @@ -84944,7 +85309,7 @@ paths: description: Response for successful upload content: application/json: - schema: *565 + schema: *572 examples: response-for-successful-upload: value: @@ -84998,9 +85363,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release parameters: - - *325 - - *326 - - *569 + - *332 + - *333 + - *576 - 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. @@ -85024,9 +85389,9 @@ paths: application/json: schema: type: array - items: *314 + items: *321 examples: - default: *316 + default: *323 headers: Link: *39 '404': *7 @@ -85047,9 +85412,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release parameters: - - *325 - - *326 - - *569 + - *332 + - *333 + - *576 requestBody: required: true content: @@ -85079,16 +85444,16 @@ paths: description: Reaction exists content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 '201': description: Reaction created content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 '422': *16 x-github: githubCloudOnly: false @@ -85110,10 +85475,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction parameters: - - *325 - - *326 - - *569 - - *317 + - *332 + - *333 + - *576 + - *324 responses: '204': description: Response @@ -85137,9 +85502,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch parameters: - - *325 - - *326 - - *384 + - *332 + - *333 + - *391 - *18 - *20 responses: @@ -85155,8 +85520,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *570 - - &572 + - *577 + - &579 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -85175,54 +85540,54 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. - - allOf: - - *571 - - *572 - - allOf: - - *573 - - *572 - - allOf: - - *574 - - *572 - - allOf: - - *575 - - *572 - - allOf: - - *576 - - *572 - - allOf: - - *577 - - *572 - allOf: - *578 - - *572 - - allOf: - *579 - - *572 - allOf: - *580 - - *572 + - *579 - allOf: - *581 - - *572 + - *579 - allOf: - *582 - - *572 + - *579 - allOf: - *583 - - *572 + - *579 - allOf: - *584 - - *572 + - *579 - allOf: - *585 - - *572 + - *579 - allOf: - *586 - - *572 + - *579 - allOf: - *587 - - *572 + - *579 + - allOf: + - *588 + - *579 + - allOf: + - *589 + - *579 + - allOf: + - *590 + - *579 + - allOf: + - *591 + - *579 + - allOf: + - *592 + - *579 + - allOf: + - *593 + - *579 + - allOf: + - *594 + - *579 examples: default: value: @@ -85261,8 +85626,8 @@ paths: category: repos subcategory: rules parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 - name: includes_parents @@ -85273,7 +85638,7 @@ paths: schema: type: boolean default: true - - *588 + - *595 responses: '200': description: Response @@ -85281,7 +85646,7 @@ paths: application/json: schema: type: array - items: *285 + items: *109 examples: default: value: @@ -85328,8 +85693,8 @@ paths: category: repos subcategory: rules parameters: - - *325 - - *326 + - *332 + - *333 requestBody: description: Request body required: true @@ -85349,16 +85714,16 @@ paths: - tag - push default: branch - enforcement: *281 + enforcement: *106 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *282 - conditions: *279 + items: *107 + conditions: *102 rules: type: array description: An array of rules within the ruleset. - items: *284 + items: *108 required: - name - enforcement @@ -85389,9 +85754,9 @@ paths: description: Response content: application/json: - schema: *285 + schema: *109 examples: - default: &598 + default: &605 value: id: 42 name: super cool ruleset @@ -85438,12 +85803,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites parameters: - - *325 - - *326 - - *589 - - *590 - - *591 - - *592 + - *332 + - *333 + - *596 + - *597 + - *598 + - *599 - *18 - *20 responses: @@ -85451,9 +85816,9 @@ paths: description: Response content: application/json: - schema: *593 + schema: *600 examples: - default: *594 + default: *601 '404': *7 '500': *84 x-github: @@ -85474,17 +85839,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *325 - - *326 - - *595 + - *332 + - *333 + - *602 responses: '200': description: Response content: application/json: - schema: *596 + schema: *603 examples: - default: *597 + default: *604 '404': *7 '500': *84 x-github: @@ -85512,8 +85877,8 @@ paths: category: repos subcategory: rules parameters: - - *325 - - *326 + - *332 + - *333 - name: ruleset_id description: The ID of the ruleset. in: path @@ -85533,9 +85898,9 @@ paths: description: Response content: application/json: - schema: *285 + schema: *109 examples: - default: *598 + default: *605 '404': *7 '500': *84 put: @@ -85553,8 +85918,8 @@ paths: category: repos subcategory: rules parameters: - - *325 - - *326 + - *332 + - *333 - name: ruleset_id description: The ID of the ruleset. in: path @@ -85579,16 +85944,16 @@ paths: - branch - tag - push - enforcement: *281 + enforcement: *106 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *282 - conditions: *279 + items: *107 + conditions: *102 rules: description: An array of rules within the ruleset. type: array - items: *284 + items: *108 examples: default: value: @@ -85616,9 +85981,9 @@ paths: description: Response content: application/json: - schema: *285 + schema: *109 examples: - default: *598 + default: *605 '404': *7 '500': *84 delete: @@ -85636,8 +86001,8 @@ paths: category: repos subcategory: rules parameters: - - *325 - - *326 + - *332 + - *333 - name: ruleset_id description: The ID of the ruleset. in: path @@ -85665,20 +86030,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: - - *325 - - *326 - - *287 - - *288 - - *289 - - *290 + - *332 + - *333 + - *294 + - *295 + - *296 + - *297 - *78 - *20 - *18 - - *599 - - *600 - - *291 - - *292 - - *293 + - *606 + - *607 + - *298 + - *299 + - *300 responses: '200': description: Response @@ -85686,7 +86051,7 @@ paths: application/json: schema: type: array - items: &603 + items: &610 type: object properties: number: *85 @@ -85705,8 +86070,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *601 - resolution: *602 + state: *608 + resolution: *609 resolved_at: type: string format: date-time @@ -85760,6 +86125,11 @@ paths: properties: *4 required: *5 nullable: true + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection + bypass. + nullable: true push_protection_bypass_request_comment: type: string description: An optional comment when requesting a push protection @@ -85859,6 +86229,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 @@ -85881,6 +86252,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: @@ -85890,7 +86262,7 @@ paths: '404': description: Repository is public or secret scanning is disabled for the repository - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85912,15 +86284,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: - - *325 - - *326 - - *413 + - *332 + - *333 + - *420 responses: '200': description: Response content: application/json: - schema: *603 + schema: *610 examples: default: value: @@ -85940,6 +86312,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: @@ -85950,7 +86323,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85971,9 +86344,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: - - *325 - - *326 - - *413 + - *332 + - *333 + - *420 requestBody: required: true content: @@ -85981,8 +86354,8 @@ paths: schema: type: object properties: - state: *601 - resolution: *602 + state: *608 + resolution: *609 resolution_comment: description: An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. @@ -86000,7 +86373,7 @@ paths: description: Response content: application/json: - schema: *603 + schema: *610 examples: default: value: @@ -86038,6 +86411,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 @@ -86052,7 +86426,7 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment - '503': *100 + '503': *112 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -86074,9 +86448,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: - - *325 - - *326 - - *413 + - *332 + - *333 + - *420 - *20 - *18 responses: @@ -86087,7 +86461,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &763 + items: &770 type: object properties: type: @@ -86424,7 +86798,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86446,8 +86820,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: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -86455,14 +86829,14 @@ paths: schema: type: object properties: - reason: &605 + reason: &612 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *604 + placeholder_id: *611 required: - reason - placeholder_id @@ -86479,7 +86853,7 @@ paths: schema: type: object properties: - reason: *605 + reason: *612 expire_at: type: string format: date-time @@ -86502,7 +86876,7 @@ paths: this repository. '422': description: Bad request, input data missing or incorrect. - '503': *100 + '503': *112 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -86522,13 +86896,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: - - *325 - - *326 + - *332 + - *333 responses: '404': description: Repository does not have GitHub Advanced Security or secret scanning enabled - '503': *100 + '503': *112 '200': description: Response content: @@ -86538,7 +86912,7 @@ paths: properties: incremental_scans: type: array - items: &606 + items: &613 description: Information on a single scan performed by secret scanning on the repository type: object @@ -86564,15 +86938,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *606 + items: *613 backfill_scans: type: array - items: *606 + items: *613 custom_pattern_backfill_scans: type: array items: allOf: - - *606 + - *613 - type: object properties: pattern_name: @@ -86642,8 +87016,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *325 - - *326 + - *332 + - *333 - *78 - name: sort description: The property to sort the results by. @@ -86687,9 +87061,9 @@ paths: application/json: schema: type: array - items: *607 + items: *614 examples: - default: *608 + default: *615 '400': *15 '404': *7 x-github: @@ -86712,8 +87086,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: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -86786,7 +87160,7 @@ paths: login: type: string description: The username of the user credited. - type: *296 + type: *303 required: - login - type @@ -86873,9 +87247,9 @@ paths: description: Response content: application/json: - schema: *607 + schema: *614 examples: - default: &610 + default: &617 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -87108,8 +87482,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: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -87213,7 +87587,7 @@ paths: description: Response content: application/json: - schema: *607 + schema: *614 examples: default: value: @@ -87360,17 +87734,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: - - *325 - - *326 - - *609 + - *332 + - *333 + - *616 responses: '200': description: Response content: application/json: - schema: *607 + schema: *614 examples: - default: *610 + default: *617 '403': *29 '404': *7 x-github: @@ -87394,9 +87768,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: - - *325 - - *326 - - *609 + - *332 + - *333 + - *616 requestBody: required: true content: @@ -87469,7 +87843,7 @@ paths: login: type: string description: The username of the user credited. - type: *296 + type: *303 required: - login - type @@ -87555,17 +87929,17 @@ paths: description: Response content: application/json: - schema: *607 + schema: *614 examples: - default: *610 - add_credit: *610 + default: *617 + add_credit: *617 '403': *29 '404': *7 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *148 + schema: *160 examples: invalid_state_transition: value: @@ -87596,11 +87970,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: - - *325 - - *326 - - *609 + - *332 + - *333 + - *616 responses: - '202': *151 + '202': *163 '400': *15 '403': *29 '404': *7 @@ -87625,17 +87999,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: - - *325 - - *326 - - *609 + - *332 + - *333 + - *616 responses: '202': description: Response content: application/json: - schema: *338 + schema: *345 examples: - default: *340 + default: *347 '400': *15 '422': *16 '403': *29 @@ -87661,8 +88035,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -87761,8 +88135,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -87771,7 +88145,7 @@ paths: application/json: schema: type: array - items: &611 + items: &618 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -87783,8 +88157,8 @@ paths: - - 1302998400 - 1124 - -435 - '202': *151 - '204': *192 + '202': *163 + '204': *204 '422': description: Repository contains more than 10,000 commits x-github: @@ -87804,8 +88178,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -87853,8 +88227,8 @@ paths: - 0 total: 89 week: 1336280400 - '202': *151 - '204': *192 + '202': *163 + '204': *204 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87881,8 +88255,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -87955,8 +88329,8 @@ paths: a: 6898 d: 77 c: 10 - '202': *151 - '204': *192 + '202': *163 + '204': *204 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87978,8 +88352,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -88133,8 +88507,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -88144,7 +88518,7 @@ paths: application/json: schema: type: array - items: *611 + items: *618 examples: default: value: @@ -88157,7 +88531,7 @@ paths: - - 0 - 2 - 21 - '204': *192 + '204': *204 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88177,8 +88551,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status parameters: - - *325 - - *326 + - *332 + - *333 - name: sha in: path required: true @@ -88232,7 +88606,7 @@ paths: description: Response content: application/json: - schema: *612 + schema: *619 examples: default: value: @@ -88286,8 +88660,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -88299,7 +88673,7 @@ paths: type: array items: *19 examples: - default: *246 + default: *258 headers: Link: *39 x-github: @@ -88319,14 +88693,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &613 + schema: &620 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -88394,8 +88768,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: false content: @@ -88421,7 +88795,7 @@ paths: description: Response content: application/json: - schema: *613 + schema: *620 examples: default: value: @@ -88448,8 +88822,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription parameters: - - *325 - - *326 + - *332 + - *333 responses: '204': description: Response @@ -88469,8 +88843,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -88549,8 +88923,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: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -88558,7 +88932,7 @@ paths: application/json: schema: type: array - items: &614 + items: &621 title: Tag protection description: Tag protection type: object @@ -88610,8 +88984,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: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -88634,7 +89008,7 @@ paths: description: Response content: application/json: - schema: *614 + schema: *621 examples: default: value: @@ -88665,8 +89039,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: - - *325 - - *326 + - *332 + - *333 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -88703,8 +89077,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *325 - - *326 + - *332 + - *333 - name: ref in: path required: true @@ -88740,8 +89114,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams parameters: - - *325 - - *326 + - *332 + - *333 - *18 - *20 responses: @@ -88751,9 +89125,9 @@ paths: application/json: schema: type: array - items: *243 + items: *255 examples: - default: *258 + default: *270 headers: Link: *39 '404': *7 @@ -88773,8 +89147,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics parameters: - - *325 - - *326 + - *332 + - *333 - *20 - *18 responses: @@ -88782,7 +89156,7 @@ paths: description: Response content: application/json: - schema: &615 + schema: &622 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -88794,7 +89168,7 @@ paths: required: - names examples: - default: &616 + default: &623 value: names: - octocat @@ -88817,8 +89191,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -88849,9 +89223,9 @@ paths: description: Response content: application/json: - schema: *615 + schema: *622 examples: - default: *616 + default: *623 '404': *7 '422': *8 x-github: @@ -88872,9 +89246,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones parameters: - - *325 - - *326 - - &617 + - *332 + - *333 + - &624 name: per description: The time frame to display results for. in: query @@ -88903,7 +89277,7 @@ paths: example: 128 clones: type: array - items: &618 + items: &625 title: Traffic type: object properties: @@ -88990,8 +89364,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -89081,8 +89455,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources parameters: - - *325 - - *326 + - *332 + - *333 responses: '200': description: Response @@ -89142,9 +89516,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views parameters: - - *325 - - *326 - - *617 + - *332 + - *333 + - *624 responses: '200': description: Response @@ -89163,7 +89537,7 @@ paths: example: 3782 views: type: array - items: *618 + items: *625 required: - uniques - count @@ -89240,8 +89614,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository parameters: - - *325 - - *326 + - *332 + - *333 requestBody: required: true content: @@ -89277,7 +89651,7 @@ paths: description: Response content: application/json: - schema: *163 + schema: *175 examples: default: value: @@ -89515,8 +89889,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: - - *325 - - *326 + - *332 + - *333 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -89539,8 +89913,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts parameters: - - *325 - - *326 + - *332 + - *333 responses: '204': description: Response @@ -89562,8 +89936,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts parameters: - - *325 - - *326 + - *332 + - *333 responses: '204': description: Response @@ -89589,8 +89963,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *325 - - *326 + - *332 + - *333 - name: ref in: path required: true @@ -89682,9 +90056,9 @@ paths: description: Response content: application/json: - schema: *338 + schema: *345 examples: - default: *340 + default: *347 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -89725,7 +90099,7 @@ paths: application/json: schema: type: array - items: *163 + items: *175 examples: default: value: @@ -89835,7 +90209,7 @@ paths: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - - &626 + - &633 name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. @@ -89844,7 +90218,7 @@ paths: schema: type: string example: members - - &631 + - &638 name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' @@ -89855,7 +90229,7 @@ paths: default: 1 format: int32 example: 1 - - &632 + - &639 name: count description: 'Used for pagination: the number of results to return per page.' in: query @@ -89897,7 +90271,7 @@ paths: Resources: type: array description: Information about each provisioned group. - items: &620 + items: &627 allOf: - type: object required: @@ -89972,7 +90346,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: &633 + meta: &640 type: object description: The metadata associated with the creation/updates to the user. @@ -90032,31 +90406,31 @@ paths: location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 startIndex: 1 itemsPerPage: 20 - '400': &621 + '400': &628 description: Bad request content: application/json: - schema: *619 + schema: *626 application/scim+json: - schema: *619 - '401': &622 + schema: *626 + '401': &629 description: Authorization failure - '403': &623 + '403': &630 description: Permission denied - '429': &624 + '429': &631 description: Too many requests content: application/json: - schema: *619 + schema: *626 application/scim+json: - schema: *619 - '500': &625 + schema: *626 + '500': &632 description: Internal server error content: application/json: - schema: *619 + schema: *626 application/scim+json: - schema: *619 + schema: *626 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -90080,7 +90454,7 @@ paths: required: true content: application/json: - schema: &629 + schema: &636 type: object required: - schemas @@ -90136,9 +90510,9 @@ paths: description: Group has been created content: application/scim+json: - schema: *620 + schema: *627 examples: - group: &627 + group: &634 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group @@ -90157,13 +90531,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': *621 - '401': *622 - '403': *623 - '409': &630 + '400': *628 + '401': *629 + '403': *630 + '409': &637 description: Duplicate record detected - '429': *624 - '500': *625 + '429': *631 + '500': *632 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -90180,7 +90554,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: - - &628 + - &635 name: scim_group_id description: A unique identifier of the SCIM group. in: path @@ -90188,22 +90562,22 @@ paths: schema: type: string example: 7fce0092-d52e-4f76-b727-3955bd72c939 - - *626 + - *633 - *40 responses: '200': description: Success, a group was found content: application/scim+json: - schema: *620 + schema: *627 examples: - default: *627 - '400': *621 - '401': *622 - '403': *623 + default: *634 + '400': *628 + '401': *629 + '403': *630 '404': *7 - '429': *624 - '500': *625 + '429': *631 + '500': *632 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -90222,13 +90596,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: - - *628 + - *635 - *40 requestBody: required: true content: application/json: - schema: *629 + schema: *636 examples: group: summary: Group @@ -90254,17 +90628,17 @@ paths: description: Group was updated content: application/scim+json: - schema: *620 + schema: *627 examples: - group: *627 - groupWithMembers: *627 - '400': *621 - '401': *622 - '403': *623 + group: *634 + groupWithMembers: *634 + '400': *628 + '401': *629 + '403': *630 '404': *7 - '409': *630 - '429': *624 - '500': *625 + '409': *637 + '429': *631 + '500': *632 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -90288,13 +90662,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: - - *628 + - *635 - *40 requestBody: required: true content: application/json: - schema: &640 + schema: &647 type: object required: - Operations @@ -90354,17 +90728,17 @@ paths: description: Success, group was updated content: application/scim+json: - schema: *620 + schema: *627 examples: - updateGroup: *627 - addMembers: *627 - '400': *621 - '401': *622 - '403': *623 + updateGroup: *634 + addMembers: *634 + '400': *628 + '401': *629 + '403': *630 '404': *7 - '409': *630 - '429': *624 - '500': *625 + '409': *637 + '429': *631 + '500': *632 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -90380,17 +90754,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: - - *628 + - *635 - *40 responses: '204': description: Group was deleted, no content - '400': *621 - '401': *622 - '403': *623 + '400': *628 + '401': *629 + '403': *630 '404': *7 - '429': *624 - '500': *625 + '429': *631 + '500': *632 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -90424,8 +90798,8 @@ paths: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - - *631 - - *632 + - *638 + - *639 - *40 responses: '200': @@ -90458,7 +90832,7 @@ paths: Resources: type: array description: Information about each provisioned account. - items: &635 + items: &642 allOf: - type: object required: @@ -90537,7 +90911,7 @@ paths: description: Whether this email address is the primary address. example: true - roles: &634 + roles: &641 type: array description: The roles assigned to the user. items: @@ -90593,7 +90967,7 @@ paths: type: string description: Provisioned SCIM groups that the user is a member of. - meta: *633 + meta: *640 startIndex: type: integer description: A starting index for the returned page @@ -90630,11 +91004,11 @@ paths: primary: false startIndex: 1 itemsPerPage: 20 - '400': *621 - '401': *622 - '403': *623 - '429': *624 - '500': *625 + '400': *628 + '401': *629 + '403': *630 + '429': *631 + '500': *632 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -90658,7 +91032,7 @@ paths: required: true content: application/json: - schema: &638 + schema: &645 type: object required: - schemas @@ -90740,9 +91114,9 @@ paths: type: boolean description: Whether this email address is the primary address. example: true - roles: *634 + roles: *641 examples: - user: &639 + user: &646 summary: User value: schemas: @@ -90789,9 +91163,9 @@ paths: description: User has been created content: application/scim+json: - schema: *635 + schema: *642 examples: - user: &636 + user: &643 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -90817,13 +91191,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: *636 - '400': *621 - '401': *622 - '403': *623 - '409': *630 - '429': *624 - '500': *625 + enterpriseOwner: *643 + '400': *628 + '401': *629 + '403': *630 + '409': *637 + '429': *631 + '500': *632 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -90840,7 +91214,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: - - &637 + - &644 name: scim_user_id description: The unique identifier of the SCIM user. in: path @@ -90853,15 +91227,15 @@ paths: description: Success, a user was found content: application/scim+json: - schema: *635 + schema: *642 examples: - default: *636 - '400': *621 - '401': *622 - '403': *623 + default: *643 + '400': *628 + '401': *629 + '403': *630 '404': *7 - '429': *624 - '500': *625 + '429': *631 + '500': *632 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -90883,30 +91257,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: - - *637 + - *644 - *40 requestBody: required: true content: application/json: - schema: *638 + schema: *645 examples: - user: *639 + user: *646 responses: '200': description: User was updated content: application/scim+json: - schema: *635 + schema: *642 examples: - user: *636 - '400': *621 - '401': *622 - '403': *623 + user: *643 + '400': *628 + '401': *629 + '403': *630 '404': *7 - '409': *630 - '429': *624 - '500': *625 + '409': *637 + '429': *631 + '500': *632 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -90941,13 +91315,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: - - *637 + - *644 - *40 requestBody: required: true content: application/json: - schema: *640 + schema: *647 examples: userMultiValuedProperties: summary: Multi Valued Property @@ -90987,18 +91361,18 @@ paths: description: Success, user was updated content: application/scim+json: - schema: *635 - examples: - userMultiValuedProperties: *636 - userSingleValuedProperties: *636 - disableUser: *636 - '400': *621 - '401': *622 - '403': *623 + schema: *642 + examples: + userMultiValuedProperties: *643 + userSingleValuedProperties: *643 + disableUser: *643 + '400': *628 + '401': *629 + '403': *630 '404': *7 - '409': *630 - '429': *624 - '500': *625 + '409': *637 + '429': *631 + '500': *632 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -91018,17 +91392,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: - - *637 + - *644 - *40 responses: '204': description: User was deleted, no content - '400': *621 - '401': *622 - '403': *623 + '400': *628 + '401': *629 + '403': *630 '404': *7 - '429': *624 - '500': *625 + '429': *631 + '500': *632 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -91061,7 +91435,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#list-scim-provisioned-identities parameters: - - *145 + - *157 - name: startIndex description: 'Used for pagination: the index of the first result to return.' in: query @@ -91115,7 +91489,7 @@ paths: example: 1 Resources: type: array - items: &641 + items: &648 title: SCIM /Users description: SCIM /Users provisioning endpoints type: object @@ -91346,22 +91720,22 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243 '304': *37 - '404': &642 + '404': &649 description: Resource not found content: application/json: - schema: *619 + schema: *626 application/scim+json: - schema: *619 - '403': &643 + schema: *626 + '403': &650 description: Forbidden content: application/json: - schema: *619 + schema: *626 application/scim+json: - schema: *619 - '400': *621 - '429': *624 + schema: *626 + '400': *628 + '429': *631 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -91381,15 +91755,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#provision-and-invite-a-scim-user parameters: - - *145 + - *157 responses: '201': description: Response content: application/scim+json: - schema: *641 + schema: *648 examples: - default: &644 + default: &651 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -91412,17 +91786,17 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32 '304': *37 - '404': *642 - '403': *643 - '500': *625 + '404': *649 + '403': *650 + '500': *632 '409': description: Conflict content: application/json: - schema: *619 + schema: *626 application/scim+json: - schema: *619 - '400': *621 + schema: *626 + '400': *628 requestBody: required: true content: @@ -91514,18 +91888,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: - - *145 - - *637 + - *157 + - *644 responses: '200': description: Response content: application/scim+json: - schema: *641 + schema: *648 examples: - default: *644 - '404': *642 - '403': *643 + default: *651 + '404': *649 + '403': *650 '304': *37 x-github: githubCloudOnly: true @@ -91548,19 +91922,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership parameters: - - *145 - - *637 + - *157 + - *644 responses: '200': description: Response content: application/scim+json: - schema: *641 + schema: *648 examples: - default: *644 + default: *651 '304': *37 - '404': *642 - '403': *643 + '404': *649 + '403': *650 requestBody: required: true content: @@ -91668,20 +92042,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: - - *145 - - *637 + - *157 + - *644 responses: '200': description: Response content: application/scim+json: - schema: *641 + schema: *648 examples: - default: *644 + default: *651 '304': *37 - '404': *642 - '403': *643 - '400': *621 + '404': *649 + '403': *650 + '400': *628 '429': description: Response content: @@ -91771,13 +92145,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: - - *145 - - *637 + - *157 + - *644 responses: '204': description: Response - '404': *642 - '403': *643 + '404': *649 + '403': *650 '304': *37 x-github: githubCloudOnly: true @@ -91892,7 +92266,7 @@ paths: html_url: type: string format: uri - repository: *163 + repository: *175 score: type: number file_size: @@ -91910,7 +92284,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &645 + text_matches: &652 title: Search Result Text Matches type: array items: @@ -92024,7 +92398,7 @@ paths: releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} score: 1 '304': *37 - '503': *100 + '503': *112 '422': *16 '403': *29 x-github: @@ -92073,7 +92447,7 @@ paths: enum: - author-date - committer-date - - &646 + - &653 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 @@ -92144,7 +92518,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *382 + properties: *389 nullable: true comment_count: type: integer @@ -92164,7 +92538,7 @@ paths: url: type: string format: uri - verification: *493 + verification: *500 required: - author - committer @@ -92183,7 +92557,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *382 + properties: *389 nullable: true parents: type: array @@ -92196,12 +92570,12 @@ paths: type: string sha: type: string - repository: *163 + repository: *175 score: type: number node_id: type: string - text_matches: *645 + text_matches: *652 required: - sha - node_id @@ -92394,7 +92768,7 @@ paths: - interactions - created - updated - - *646 + - *653 - *18 - *20 responses: @@ -92513,8 +92887,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *445 - required: *446 + properties: *452 + required: *453 nullable: true comments: type: integer @@ -92528,7 +92902,7 @@ paths: type: string format: date-time nullable: true - text_matches: *645 + text_matches: *652 pull_request: type: object properties: @@ -92561,7 +92935,7 @@ paths: type: string score: type: number - author_association: *109 + author_association: *121 draft: type: boolean repository: *57 @@ -92581,9 +92955,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 - reactions: *110 + properties: *119 + required: *120 + reactions: *122 required: - assignee - closed_at @@ -92699,7 +93073,7 @@ paths: locked: true author_association: COLLABORATOR state_reason: completed - '503': *100 + '503': *112 '422': *16 '304': *37 '403': *29 @@ -92752,7 +93126,7 @@ paths: enum: - created - updated - - *646 + - *653 - *18 - *20 responses: @@ -92796,7 +93170,7 @@ paths: nullable: true score: type: number - text_matches: *645 + text_matches: *652 required: - id - node_id @@ -92882,7 +93256,7 @@ paths: - forks - help-wanted-issues - updated - - *646 + - *653 - *18 - *20 responses: @@ -93101,8 +93475,8 @@ paths: title: License Simple description: License Simple type: object - properties: *123 - required: *124 + properties: *135 + required: *136 nullable: true permissions: type: object @@ -93121,7 +93495,7 @@ paths: - admin - pull - push - text_matches: *645 + text_matches: *652 temp_clone_token: type: string allow_merge_commit: @@ -93323,7 +93697,7 @@ paths: spdx_id: MIT node_id: MDc6TGljZW5zZW1pdA== html_url: https://api.github.com/licenses/mit - '503': *100 + '503': *112 '422': *16 '304': *37 x-github: @@ -93422,7 +93796,7 @@ paths: type: string format: uri nullable: true - text_matches: *645 + text_matches: *652 related: type: array nullable: true @@ -93615,7 +93989,7 @@ paths: - followers - repositories - joined - - *646 + - *653 - *18 - *20 responses: @@ -93719,7 +94093,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *645 + text_matches: *652 blog: type: string nullable: true @@ -93778,7 +94152,7 @@ paths: events_url: https://api.github.com/users/mojombo/events{/privacy} site_admin: true '304': *37 - '503': *100 + '503': *112 '422': *16 x-github: githubCloudOnly: false @@ -93798,7 +94172,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy parameters: - - &647 + - &654 name: team_id description: The unique identifier of the team. in: path @@ -93810,9 +94184,9 @@ paths: description: Response content: application/json: - schema: *306 + schema: *313 examples: - default: *307 + default: *314 '404': *7 x-github: githubCloudOnly: false @@ -93839,7 +94213,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy parameters: - - *647 + - *654 requestBody: required: true content: @@ -93902,16 +94276,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *306 + schema: *313 examples: - default: *307 + default: *314 '201': description: Response content: application/json: - schema: *306 + schema: *313 examples: - default: *307 + default: *314 '404': *7 '422': *16 '403': *29 @@ -93939,7 +94313,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy parameters: - - *647 + - *654 responses: '204': description: Response @@ -93970,7 +94344,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy parameters: - - *647 + - *654 - *78 - *18 - *20 @@ -93981,9 +94355,9 @@ paths: application/json: schema: type: array - items: *308 + items: *315 examples: - default: *648 + default: *655 headers: Link: *39 x-github: @@ -94012,7 +94386,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy parameters: - - *647 + - *654 requestBody: required: true content: @@ -94046,9 +94420,9 @@ paths: description: Response content: application/json: - schema: *308 + schema: *315 examples: - default: *309 + default: *316 x-github: triggersNotification: true githubCloudOnly: false @@ -94075,16 +94449,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy parameters: - - *647 - - *310 + - *654 + - *317 responses: '200': description: Response content: application/json: - schema: *308 + schema: *315 examples: - default: *309 + default: *316 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94109,8 +94483,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy parameters: - - *647 - - *310 + - *654 + - *317 requestBody: required: false content: @@ -94133,9 +94507,9 @@ paths: description: Response content: application/json: - schema: *308 + schema: *315 examples: - default: *649 + default: *656 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94160,8 +94534,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy parameters: - - *647 - - *310 + - *654 + - *317 responses: '204': description: Response @@ -94190,8 +94564,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *647 - - *310 + - *654 + - *317 - *78 - *18 - *20 @@ -94202,9 +94576,9 @@ paths: application/json: schema: type: array - items: *311 + items: *318 examples: - default: *650 + default: *657 headers: Link: *39 x-github: @@ -94233,8 +94607,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *647 - - *310 + - *654 + - *317 requestBody: required: true content: @@ -94256,9 +94630,9 @@ paths: description: Response content: application/json: - schema: *311 + schema: *318 examples: - default: *312 + default: *319 x-github: triggersNotification: true githubCloudOnly: false @@ -94285,17 +94659,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *647 - - *310 - - *313 + - *654 + - *317 + - *320 responses: '200': description: Response content: application/json: - schema: *311 + schema: *318 examples: - default: *312 + default: *319 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94320,9 +94694,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *647 - - *310 - - *313 + - *654 + - *317 + - *320 requestBody: required: true content: @@ -94344,9 +94718,9 @@ paths: description: Response content: application/json: - schema: *311 + schema: *318 examples: - default: *651 + default: *658 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94371,9 +94745,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *647 - - *310 - - *313 + - *654 + - *317 + - *320 responses: '204': description: Response @@ -94402,9 +94776,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: - - *647 - - *310 - - *313 + - *654 + - *317 + - *320 - 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. @@ -94430,9 +94804,9 @@ paths: application/json: schema: type: array - items: *314 + items: *321 examples: - default: *316 + default: *323 headers: Link: *39 x-github: @@ -94461,9 +94835,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: - - *647 - - *310 - - *313 + - *654 + - *317 + - *320 requestBody: required: true content: @@ -94495,9 +94869,9 @@ paths: description: Response content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94523,8 +94897,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: - - *647 - - *310 + - *654 + - *317 - 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. @@ -94550,9 +94924,9 @@ paths: application/json: schema: type: array - items: *314 + items: *321 examples: - default: *316 + default: *323 headers: Link: *39 x-github: @@ -94581,8 +94955,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: - - *647 - - *310 + - *654 + - *317 requestBody: required: true content: @@ -94614,9 +94988,9 @@ paths: description: Response content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -94640,7 +95014,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy parameters: - - *647 + - *654 - *18 - *20 responses: @@ -94650,9 +95024,9 @@ paths: application/json: schema: type: array - items: *240 + items: *252 examples: - default: *241 + default: *253 headers: Link: *39 x-github: @@ -94678,7 +95052,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy parameters: - - *647 + - *654 - name: role description: Filters members returned by their role in the team. in: query @@ -94701,7 +95075,7 @@ paths: type: array items: *19 examples: - default: *246 + default: *258 headers: Link: *39 '404': *7 @@ -94729,8 +95103,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy parameters: - - *647 - - *185 + - *654 + - *197 responses: '204': description: if user is a member @@ -94766,8 +95140,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy parameters: - - *647 - - *185 + - *654 + - *197 responses: '204': description: Response @@ -94806,8 +95180,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy parameters: - - *647 - - *185 + - *654 + - *197 responses: '204': description: Response @@ -94843,16 +95217,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: - - *647 - - *185 + - *654 + - *197 responses: '200': description: Response content: application/json: - schema: *322 + schema: *329 examples: - response-if-user-is-a-team-maintainer: *652 + response-if-user-is-a-team-maintainer: *659 '404': *7 x-github: githubCloudOnly: false @@ -94885,8 +95259,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: - - *647 - - *185 + - *654 + - *197 requestBody: required: false content: @@ -94911,9 +95285,9 @@ paths: description: Response content: application/json: - schema: *322 + schema: *329 examples: - response-if-users-membership-with-team-is-now-pending: *653 + response-if-users-membership-with-team-is-now-pending: *660 '403': description: Forbidden if team synchronization is set up '422': @@ -94947,8 +95321,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: - - *647 - - *185 + - *654 + - *197 responses: '204': description: Response @@ -94977,7 +95351,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects-legacy parameters: - - *647 + - *654 - *18 - *20 responses: @@ -94987,9 +95361,9 @@ paths: application/json: schema: type: array - items: *323 + items: *330 examples: - default: *654 + default: *661 headers: Link: *39 '404': *7 @@ -95016,16 +95390,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: - - *647 - - *324 + - *654 + - *331 responses: '200': description: Response content: application/json: - schema: *323 + schema: *330 examples: - default: *655 + default: *662 '404': description: Not Found if project is not managed by this team x-github: @@ -95050,8 +95424,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: - - *647 - - *324 + - *654 + - *331 requestBody: required: false content: @@ -95119,8 +95493,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: - - *647 - - *324 + - *654 + - *331 responses: '204': description: Response @@ -95147,7 +95521,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy parameters: - - *647 + - *654 - *18 - *20 responses: @@ -95157,9 +95531,9 @@ paths: application/json: schema: type: array - items: *163 + items: *175 examples: - default: *265 + default: *277 headers: Link: *39 '404': *7 @@ -95189,15 +95563,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: - - *647 - - *325 - - *326 + - *654 + - *332 + - *333 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *656 + schema: *663 examples: alternative-response-with-extra-repository-information: value: @@ -95348,9 +95722,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: - - *647 - - *325 - - *326 + - *654 + - *332 + - *333 requestBody: required: false content: @@ -95400,9 +95774,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: - - *647 - - *325 - - *326 + - *654 + - *332 + - *333 responses: '204': description: Response @@ -95431,15 +95805,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: - - *647 + - *654 responses: '200': description: Response content: application/json: - schema: *327 + schema: *334 examples: - default: *328 + default: *335 '403': *29 '404': *7 x-github: @@ -95466,7 +95840,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: - - *647 + - *654 requestBody: required: true content: @@ -95523,7 +95897,7 @@ paths: description: Response content: application/json: - schema: *327 + schema: *334 examples: default: value: @@ -95554,7 +95928,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy parameters: - - *647 + - *654 - *18 - *20 responses: @@ -95564,9 +95938,9 @@ paths: application/json: schema: type: array - items: *243 + items: *255 examples: - response-if-child-teams-exist: *657 + response-if-child-teams-exist: *664 headers: Link: *39 '404': *7 @@ -95599,7 +95973,7 @@ paths: application/json: schema: oneOf: - - &659 + - &666 title: Private User description: Private User type: object @@ -95802,7 +96176,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *658 + - *665 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -95955,7 +96329,7 @@ paths: description: Response content: application/json: - schema: *659 + schema: *666 examples: default: value: @@ -96034,7 +96408,7 @@ paths: type: array items: *19 examples: - default: *246 + default: *258 '304': *37 '404': *7 '403': *29 @@ -96057,7 +96431,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: - - *185 + - *197 responses: '204': description: If the user is blocked @@ -96085,7 +96459,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#block-a-user parameters: - - *185 + - *197 responses: '204': description: Response @@ -96109,7 +96483,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#unblock-a-user parameters: - - *185 + - *197 responses: '204': description: Response @@ -96158,9 +96532,9 @@ paths: type: integer codespaces: type: array - items: *247 + items: *259 examples: - default: *248 + default: *260 '304': *37 '500': *84 '401': *25 @@ -96299,21 +96673,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *247 + schema: *259 examples: - default: *430 + default: *437 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *247 + schema: *259 examples: - default: *430 + default: *437 '401': *25 '403': *29 '404': *7 - '503': *100 + '503': *112 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -96353,7 +96727,7 @@ paths: type: integer secrets: type: array - items: &660 + items: &667 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -96393,7 +96767,7 @@ paths: - visibility - selected_repositories_url examples: - default: *433 + default: *440 headers: Link: *39 x-github: @@ -96463,13 +96837,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: - - *173 + - *185 responses: '200': description: Response content: application/json: - schema: *660 + schema: *667 examples: default: value: @@ -96499,7 +96873,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: - - *173 + - *185 requestBody: required: true content: @@ -96544,7 +96918,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -96572,7 +96946,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: - - *173 + - *185 responses: '204': description: Response @@ -96597,7 +96971,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: - - *173 + - *185 responses: '200': description: Response @@ -96613,9 +96987,9 @@ paths: type: integer repositories: type: array - items: *163 + items: *175 examples: - default: *661 + default: *668 '401': *25 '403': *29 '404': *7 @@ -96640,7 +97014,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: - - *173 + - *185 requestBody: required: true content: @@ -96694,7 +97068,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: - - *173 + - *185 - name: repository_id in: path required: true @@ -96727,7 +97101,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: - - *173 + - *185 - name: repository_id in: path required: true @@ -96759,15 +97133,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: - - *249 + - *261 responses: '200': description: Response content: application/json: - schema: *247 + schema: *259 examples: - default: *430 + default: *437 '304': *37 '500': *84 '401': *25 @@ -96793,7 +97167,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: - - *249 + - *261 requestBody: required: false content: @@ -96823,9 +97197,9 @@ paths: description: Response content: application/json: - schema: *247 + schema: *259 examples: - default: *430 + default: *437 '401': *25 '403': *29 '404': *7 @@ -96847,9 +97221,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: - - *249 + - *261 responses: - '202': *151 + '202': *163 '304': *37 '500': *84 '401': *25 @@ -96876,13 +97250,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: - - *249 + - *261 responses: '202': description: Response content: application/json: - schema: &662 + schema: &669 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -96923,7 +97297,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &663 + default: &670 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -96955,7 +97329,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *249 + - *261 - name: export_id in: path required: true @@ -96968,9 +97342,9 @@ paths: description: Response content: application/json: - schema: *662 + schema: *669 examples: - default: *663 + default: *670 '404': *7 x-github: githubCloudOnly: false @@ -96991,7 +97365,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *249 + - *261 responses: '200': description: Response @@ -97007,9 +97381,9 @@ paths: type: integer machines: type: array - items: *664 + items: *671 examples: - default: *665 + default: *672 '304': *37 '500': *84 '401': *25 @@ -97038,7 +97412,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: - - *249 + - *261 requestBody: required: true content: @@ -97088,13 +97462,13 @@ paths: nullable: true owner: *19 billable_owner: *19 - repository: *338 + repository: *345 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *431 - required: *432 + properties: *438 + required: *439 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -97868,15 +98242,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: - - *249 + - *261 responses: '200': description: Response content: application/json: - schema: *247 + schema: *259 examples: - default: *430 + default: *437 '304': *37 '500': *84 '400': *15 @@ -97888,7 +98262,7 @@ paths: schema: *3 '403': *29 '404': *7 - '409': *150 + '409': *162 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -97908,15 +98282,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: - - *249 + - *261 responses: '200': description: Response content: application/json: - schema: *247 + schema: *259 examples: - default: *430 + default: *437 '500': *84 '401': *25 '403': *29 @@ -97946,9 +98320,9 @@ paths: application/json: schema: type: array - items: *259 + items: *271 examples: - default: &678 + default: &685 value: - id: 197 name: hello_docker @@ -98049,7 +98423,7 @@ paths: application/json: schema: type: array - items: &666 + items: &673 title: Email description: Email type: object @@ -98114,9 +98488,9 @@ paths: application/json: schema: type: array - items: *666 + items: *673 examples: - default: &680 + default: &687 value: - email: octocat@github.com verified: true @@ -98191,7 +98565,7 @@ paths: application/json: schema: type: array - items: *666 + items: *673 examples: default: value: @@ -98301,7 +98675,7 @@ paths: type: array items: *19 examples: - default: *246 + default: *258 headers: Link: *39 '304': *37 @@ -98334,7 +98708,7 @@ paths: type: array items: *19 examples: - default: *246 + default: *258 headers: Link: *39 '304': *37 @@ -98356,7 +98730,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: - - *185 + - *197 responses: '204': description: if the person is followed by the authenticated user @@ -98386,7 +98760,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#follow-a-user parameters: - - *185 + - *197 responses: '204': description: Response @@ -98411,7 +98785,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#unfollow-a-user parameters: - - *185 + - *197 responses: '204': description: Response @@ -98447,7 +98821,7 @@ paths: application/json: schema: type: array - items: &667 + items: &674 title: GPG Key description: A unique encryption key type: object @@ -98578,7 +98952,7 @@ paths: - subkeys - revoked examples: - default: &691 + default: &698 value: - id: 3 name: Octocat's GPG Key @@ -98663,9 +99037,9 @@ paths: description: Response content: application/json: - schema: *667 + schema: *674 examples: - default: &668 + default: &675 value: id: 3 name: Octocat's GPG Key @@ -98722,7 +99096,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: - - &669 + - &676 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -98734,9 +99108,9 @@ paths: description: Response content: application/json: - schema: *667 + schema: *674 examples: - default: *668 + default: *675 '404': *7 '304': *37 '403': *29 @@ -98759,7 +99133,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: - - *669 + - *676 responses: '204': description: Response @@ -98950,7 +99324,7 @@ paths: type: array items: *57 examples: - default: *670 + default: *677 headers: Link: *39 '404': *7 @@ -98975,7 +99349,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *23 - - *158 + - *170 responses: '204': description: Response @@ -99001,7 +99375,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *23 - - *158 + - *170 responses: '204': description: Response @@ -99035,12 +99409,12 @@ paths: application/json: schema: anyOf: - - *238 + - *250 - type: object properties: {} additionalProperties: false examples: - default: *239 + default: *251 '204': description: Response when there are no restrictions x-github: @@ -99064,7 +99438,7 @@ paths: required: true content: application/json: - schema: *504 + schema: *511 examples: default: value: @@ -99075,7 +99449,7 @@ paths: description: Response content: application/json: - schema: *238 + schema: *250 examples: default: value: @@ -99156,7 +99530,7 @@ paths: - closed - all default: open - - *244 + - *256 - name: sort description: What to sort results by. in: query @@ -99169,7 +99543,7 @@ paths: - comments default: created - *78 - - *112 + - *124 - *18 - *20 responses: @@ -99179,9 +99553,9 @@ paths: application/json: schema: type: array - items: *122 + items: *134 examples: - default: *245 + default: *257 headers: Link: *39 '404': *7 @@ -99214,7 +99588,7 @@ paths: application/json: schema: type: array - items: &671 + items: &678 title: Key description: Key type: object @@ -99311,9 +99685,9 @@ paths: description: Response content: application/json: - schema: *671 + schema: *678 examples: - default: &672 + default: &679 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -99346,15 +99720,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: - - *533 + - *540 responses: '200': description: Response content: application/json: - schema: *671 + schema: *678 examples: - default: *672 + default: *679 '404': *7 '304': *37 '403': *29 @@ -99377,7 +99751,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: - - *533 + - *540 responses: '204': description: Response @@ -99410,7 +99784,7 @@ paths: application/json: schema: type: array - items: &673 + items: &680 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -99467,7 +99841,7 @@ paths: - id - type - login - plan: *126 + plan: *138 required: - billing_cycle - next_billing_date @@ -99478,7 +99852,7 @@ paths: - account - plan examples: - default: &674 + default: &681 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -99540,9 +99914,9 @@ paths: application/json: schema: type: array - items: *673 + items: *680 examples: - default: *674 + default: *681 headers: Link: *39 '304': *37 @@ -99582,7 +99956,7 @@ paths: application/json: schema: type: array - items: *250 + items: *262 examples: default: value: @@ -99684,13 +100058,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: - - *145 + - *157 responses: '200': description: Response content: application/json: - schema: *250 + schema: *262 examples: default: value: @@ -99748,7 +100122,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: - - *145 + - *157 requestBody: required: true content: @@ -99773,7 +100147,7 @@ paths: description: Response content: application/json: - schema: *250 + schema: *262 examples: default: value: @@ -99841,7 +100215,7 @@ paths: application/json: schema: type: array - items: *252 + items: *264 examples: default: value: @@ -100094,7 +100468,7 @@ paths: description: Response content: application/json: - schema: *252 + schema: *264 examples: default: value: @@ -100274,7 +100648,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#get-a-user-migration-status parameters: - - *253 + - *265 - name: exclude in: query required: false @@ -100287,7 +100661,7 @@ paths: description: Response content: application/json: - schema: *252 + schema: *264 examples: default: value: @@ -100481,7 +100855,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive parameters: - - *253 + - *265 responses: '302': description: Response @@ -100507,7 +100881,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#delete-a-user-migration-archive parameters: - - *253 + - *265 responses: '204': description: Response @@ -100536,8 +100910,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository parameters: - - *253 - - *675 + - *265 + - *682 responses: '204': description: Response @@ -100561,7 +100935,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *253 + - *265 - *18 - *20 responses: @@ -100571,9 +100945,9 @@ paths: application/json: schema: type: array - items: *163 + items: *175 examples: - default: *265 + default: *277 headers: Link: *39 '404': *7 @@ -100610,7 +100984,7 @@ paths: type: array items: *52 examples: - default: *676 + default: *683 headers: Link: *39 '304': *37 @@ -100652,7 +101026,7 @@ paths: - docker - nuget - container - - *677 + - *684 - *20 - *18 responses: @@ -100662,10 +101036,10 @@ paths: application/json: schema: type: array - items: *259 + items: *271 examples: - default: *678 - '400': *679 + default: *685 + '400': *686 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100685,16 +101059,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: - - *261 - - *262 + - *273 + - *274 responses: '200': description: Response content: application/json: - schema: *259 + schema: *271 examples: - default: &692 + default: &699 value: id: 40201 name: octo-name @@ -100807,8 +101181,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: - - *261 - - *262 + - *273 + - *274 responses: '204': description: Response @@ -100838,8 +101212,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: - - *261 - - *262 + - *273 + - *274 - name: token description: package token schema: @@ -100871,8 +101245,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: - - *261 - - *262 + - *273 + - *274 - *20 - *18 - name: state @@ -100892,7 +101266,7 @@ paths: application/json: schema: type: array - items: *263 + items: *275 examples: default: value: @@ -100941,15 +101315,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: - - *261 - - *262 - - *264 + - *273 + - *274 + - *276 responses: '200': description: Response content: application/json: - schema: *263 + schema: *275 examples: default: value: @@ -100985,9 +101359,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: - - *261 - - *262 - - *264 + - *273 + - *274 + - *276 responses: '204': description: Response @@ -101017,9 +101391,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: - - *261 - - *262 - - *264 + - *273 + - *274 + - *276 responses: '204': description: Response @@ -101075,7 +101449,7 @@ paths: description: Response content: application/json: - schema: *272 + schema: *284 examples: default: value: @@ -101144,9 +101518,9 @@ paths: application/json: schema: type: array - items: *666 + items: *673 examples: - default: *680 + default: *687 headers: Link: *39 '304': *37 @@ -101259,7 +101633,7 @@ paths: type: array items: *57 examples: - default: &687 + default: &694 summary: Default response value: - id: 1296269 @@ -101561,9 +101935,9 @@ paths: description: Response content: application/json: - schema: *338 + schema: *345 examples: - default: *340 + default: *347 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -101601,9 +101975,9 @@ paths: application/json: schema: type: array - items: *506 + items: *513 examples: - default: *681 + default: *688 headers: Link: *39 '304': *37 @@ -101626,12 +102000,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *242 + - *254 responses: '204': description: Response '403': *29 - '409': *150 + '409': *162 '404': *7 '304': *37 x-github: @@ -101649,11 +102023,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *242 + - *254 responses: '204': description: Response - '409': *150 + '409': *162 '304': *37 '404': *7 '403': *29 @@ -101682,7 +102056,7 @@ paths: application/json: schema: type: array - items: &682 + items: &689 title: Social account description: Social media account type: object @@ -101697,7 +102071,7 @@ paths: - provider - url examples: - default: &683 + default: &690 value: - provider: twitter url: https://twitter.com/github @@ -101759,9 +102133,9 @@ paths: application/json: schema: type: array - items: *682 + items: *689 examples: - default: *683 + default: *690 '422': *16 '304': *37 '404': *7 @@ -101848,7 +102222,7 @@ paths: application/json: schema: type: array - items: &684 + items: &691 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -101868,7 +102242,7 @@ paths: - title - created_at examples: - default: &693 + default: &700 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -101934,9 +102308,9 @@ paths: description: Response content: application/json: - schema: *684 + schema: *691 examples: - default: &685 + default: &692 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -101967,7 +102341,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: - - &686 + - &693 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -101979,9 +102353,9 @@ paths: description: Response content: application/json: - schema: *684 + schema: *691 examples: - default: *685 + default: *692 '404': *7 '304': *37 '403': *29 @@ -102004,7 +102378,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: - - *686 + - *693 responses: '204': description: Response @@ -102033,7 +102407,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: - - &694 + - &701 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 @@ -102058,11 +102432,11 @@ paths: type: array items: *57 examples: - default-response: *687 + default-response: *694 application/vnd.github.v3.star+json: schema: type: array - items: &695 + items: &702 title: Starred Repository description: Starred Repository type: object @@ -102218,8 +102592,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: - - *325 - - *326 + - *332 + - *333 responses: '204': description: Response if this repository is starred by you @@ -102247,8 +102621,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: - - *325 - - *326 + - *332 + - *333 responses: '204': description: Response @@ -102272,8 +102646,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: - - *325 - - *326 + - *332 + - *333 responses: '204': description: Response @@ -102306,9 +102680,9 @@ paths: application/json: schema: type: array - items: *163 + items: *175 examples: - default: *265 + default: *277 headers: Link: *39 '304': *37 @@ -102345,7 +102719,7 @@ paths: application/json: schema: type: array - items: *306 + items: *313 examples: default: value: @@ -102421,7 +102795,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user-using-their-id parameters: - - *128 + - *140 responses: '200': description: Response @@ -102429,10 +102803,10 @@ paths: application/json: schema: oneOf: - - *659 - - *658 + - *666 + - *665 examples: - default-response: &689 + default-response: &696 summary: Default response value: login: octocat @@ -102467,7 +102841,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &690 + response-with-git-hub-plan-information: &697 summary: Response with GitHub plan information value: login: octocat @@ -102527,7 +102901,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users parameters: - - *688 + - *695 - *18 responses: '200': @@ -102538,7 +102912,7 @@ paths: type: array items: *19 examples: - default: *246 + default: *258 headers: Link: example: ; rel="next" @@ -102566,7 +102940,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user parameters: - - *185 + - *197 responses: '200': description: Response @@ -102574,11 +102948,11 @@ paths: application/json: schema: oneOf: - - *659 - - *658 + - *666 + - *665 examples: - default-response: *689 - response-with-git-hub-plan-information: *690 + default-response: *696 + response-with-git-hub-plan-information: *697 '404': *7 x-github: githubCloudOnly: false @@ -102604,7 +102978,7 @@ paths: - *18 - *76 - *77 - - *185 + - *197 - name: subject_digest description: Subject Digest in: path @@ -102697,6 +103071,8 @@ paths: type: string repository_id: type: integer + bundle_url: + type: string examples: default: value: @@ -102704,7 +103080,7 @@ paths: description: Response content: application/json: - schema: *174 + schema: *186 examples: default: value: @@ -102730,7 +103106,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: - - *185 + - *197 responses: '200': description: Response @@ -102738,9 +103114,9 @@ paths: application/json: schema: type: array - items: *259 + items: *271 examples: - default: *678 + default: *685 '403': *29 '401': *25 x-github: @@ -102763,7 +103139,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-for-the-authenticated-user parameters: - - *185 + - *197 - *18 - *20 responses: @@ -102773,7 +103149,7 @@ paths: application/json: schema: type: array - items: *134 + items: *146 examples: default: value: @@ -102844,8 +103220,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: - - *185 - - *145 + - *197 + - *157 - *18 - *20 responses: @@ -102855,7 +103231,7 @@ paths: application/json: schema: type: array - items: *134 + items: *146 examples: default: value: @@ -102934,7 +103310,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-user parameters: - - *185 + - *197 - *18 - *20 responses: @@ -102944,7 +103320,7 @@ paths: application/json: schema: type: array - items: *134 + items: *146 examples: default: value: @@ -103011,7 +103387,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-followers-of-a-user parameters: - - *185 + - *197 - *18 - *20 responses: @@ -103023,7 +103399,7 @@ paths: type: array items: *19 examples: - default: *246 + default: *258 headers: Link: *39 x-github: @@ -103042,7 +103418,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-the-people-a-user-follows parameters: - - *185 + - *197 - *18 - *20 responses: @@ -103054,7 +103430,7 @@ paths: type: array items: *19 examples: - default: *246 + default: *258 headers: Link: *39 x-github: @@ -103073,7 +103449,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: - - *185 + - *197 - name: target_user in: path required: true @@ -103100,8 +103476,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-a-user parameters: - - *185 - - *112 + - *197 + - *124 - *18 - *20 responses: @@ -103111,9 +103487,9 @@ paths: application/json: schema: type: array - items: *113 + items: *125 examples: - default: *114 + default: *126 headers: Link: *39 '422': *16 @@ -103134,7 +103510,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: - - *185 + - *197 - *18 - *20 responses: @@ -103144,9 +103520,9 @@ paths: application/json: schema: type: array - items: *667 + items: *674 examples: - default: *691 + default: *698 headers: Link: *39 x-github: @@ -103170,7 +103546,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-contextual-information-for-a-user parameters: - - *185 + - *197 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -103242,7 +103618,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: - - *185 + - *197 responses: '200': description: Response @@ -103250,7 +103626,7 @@ paths: application/json: schema: *22 examples: - default: *503 + default: *510 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -103268,7 +103644,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#list-public-keys-for-a-user parameters: - - *185 + - *197 - *18 - *20 responses: @@ -103316,7 +103692,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-a-user parameters: - - *185 + - *197 - *18 - *20 responses: @@ -103328,7 +103704,7 @@ paths: type: array items: *52 examples: - default: *676 + default: *683 headers: Link: *39 x-github: @@ -103367,8 +103743,8 @@ paths: - docker - nuget - container - - *677 - - *185 + - *684 + - *197 - *20 - *18 responses: @@ -103378,12 +103754,12 @@ paths: application/json: schema: type: array - items: *259 + items: *271 examples: - default: *678 + default: *685 '403': *29 '401': *25 - '400': *679 + '400': *686 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -103403,17 +103779,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-a-user parameters: - - *261 - - *262 - - *185 + - *273 + - *274 + - *197 responses: '200': description: Response content: application/json: - schema: *259 + schema: *271 examples: - default: *692 + default: *699 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -103434,9 +103810,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-a-user parameters: - - *261 - - *262 - - *185 + - *273 + - *274 + - *197 responses: '204': description: Response @@ -103468,9 +103844,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-a-user parameters: - - *261 - - *262 - - *185 + - *273 + - *274 + - *197 - name: token description: package token schema: @@ -103502,9 +103878,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: - - *261 - - *262 - - *185 + - *273 + - *274 + - *197 responses: '200': description: Response @@ -103512,7 +103888,7 @@ paths: application/json: schema: type: array - items: *263 + items: *275 examples: default: value: @@ -103570,16 +103946,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: - - *261 - - *262 - - *264 - - *185 + - *273 + - *274 + - *276 + - *197 responses: '200': description: Response content: application/json: - schema: *263 + schema: *275 examples: default: value: @@ -103614,10 +103990,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-a-user parameters: - - *261 - - *262 - - *185 - - *264 + - *273 + - *274 + - *197 + - *276 responses: '204': description: Response @@ -103649,10 +104025,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-a-user parameters: - - *261 - - *262 - - *185 - - *264 + - *273 + - *274 + - *197 + - *276 responses: '204': description: Response @@ -103675,7 +104051,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-user-projects parameters: - - *185 + - *197 - name: state description: Indicates the state of the projects to return. in: query @@ -103696,7 +104072,7 @@ paths: application/json: schema: type: array - items: *272 + items: *284 examples: default: value: @@ -103755,7 +104131,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: - - *185 + - *197 - *18 - *20 responses: @@ -103765,7 +104141,7 @@ paths: application/json: schema: type: array - items: *134 + items: *146 examples: default: value: @@ -103844,7 +104220,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: - - *185 + - *197 - *18 - *20 responses: @@ -103854,7 +104230,7 @@ paths: application/json: schema: type: array - items: *134 + items: *146 examples: default: value: @@ -103931,7 +104307,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repositories-for-a-user parameters: - - *185 + - *197 - name: type description: Limit results to repositories of the specified type. in: query @@ -103974,9 +104350,9 @@ paths: application/json: schema: type: array - items: *163 + items: *175 examples: - default: *265 + default: *277 headers: Link: *39 x-github: @@ -104000,15 +104376,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: - - *185 + - *197 responses: '200': description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: *299 + default: *306 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104030,15 +104406,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: - - *185 + - *197 responses: '200': description: Response content: application/json: - schema: *302 + schema: *309 examples: - default: *303 + default: *310 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104060,15 +104436,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: - - *185 + - *197 responses: '200': description: Response content: application/json: - schema: *304 + schema: *311 examples: - default: *305 + default: *312 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104086,7 +104462,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: - - *185 + - *197 - *18 - *20 responses: @@ -104096,9 +104472,9 @@ paths: application/json: schema: type: array - items: *682 + items: *689 examples: - default: *683 + default: *690 headers: Link: *39 x-github: @@ -104118,7 +104494,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: - - *185 + - *197 - *18 - *20 responses: @@ -104128,9 +104504,9 @@ paths: application/json: schema: type: array - items: *684 + items: *691 examples: - default: *693 + default: *700 headers: Link: *39 x-github: @@ -104154,8 +104530,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *185 - - *694 + - *197 + - *701 - *78 - *18 - *20 @@ -104167,11 +104543,11 @@ paths: schema: anyOf: - type: array - items: *695 + items: *702 - type: array items: *57 examples: - default-response: *687 + default-response: *694 headers: Link: *39 x-github: @@ -104190,7 +104566,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *185 + - *197 - *18 - *20 responses: @@ -104200,9 +104576,9 @@ paths: application/json: schema: type: array - items: *163 + items: *175 examples: - default: *265 + default: *277 headers: Link: *39 x-github: @@ -104330,7 +104706,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &696 + enterprise: &703 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -104388,7 +104764,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &697 + installation: &704 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -104407,7 +104783,7 @@ x-webhooks: required: - id - node_id - organization: &698 + organization: &705 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -104467,13 +104843,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &699 + repository: &706 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &736 + properties: &743 id: description: Unique identifier of the repository example: 42 @@ -104493,8 +104869,8 @@ x-webhooks: title: License Simple description: License Simple type: object - properties: *123 - required: *124 + properties: *135 + required: *136 nullable: true organization: title: Simple User @@ -105156,7 +105532,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &737 + required: &744 - archive_url - assignees_url - blobs_url @@ -105307,10 +105683,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -105386,11 +105762,11 @@ x-webhooks: type: string enum: - created - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 - rule: &700 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + rule: &707 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) @@ -105613,11 +105989,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 - rule: *700 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + rule: *707 sender: *19 required: - action @@ -105800,11 +106176,11 @@ x-webhooks: - everyone required: - from - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 - rule: *700 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + rule: *707 sender: *19 required: - action @@ -105877,7 +106253,7 @@ x-webhooks: required: true content: application/json: - schema: &703 + schema: &710 title: Exemption request cancellation event type: object properties: @@ -105885,11 +106261,11 @@ x-webhooks: type: string enum: - cancelled - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 - exemption_request: &701 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + exemption_request: &708 title: Exemption Request description: A request from a user to be exempted from a set of rules. @@ -106039,7 +106415,7 @@ x-webhooks: type: array description: The responses to the exemption request. nullable: true - items: &702 + items: &709 title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -106063,6 +106439,11 @@ x-webhooks: - approved - rejected - dismissed + reviewer_comment: + type: string + description: The comment the reviewer provided when responding + to the exemption request. + nullable: true created_at: type: string format: date-time @@ -106144,7 +106525,7 @@ x-webhooks: required: true content: application/json: - schema: &704 + schema: &711 title: Exemption request completed event type: object properties: @@ -106152,11 +106533,11 @@ x-webhooks: type: string enum: - completed - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 - exemption_request: *701 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + exemption_request: *708 sender: *19 required: - action @@ -106228,7 +106609,7 @@ x-webhooks: required: true content: application/json: - schema: &705 + schema: &712 title: Exemption request created event type: object properties: @@ -106236,11 +106617,11 @@ x-webhooks: type: string enum: - created - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 - exemption_request: *701 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + exemption_request: *708 sender: *19 required: - action @@ -106312,7 +106693,7 @@ x-webhooks: required: true content: application/json: - schema: &706 + schema: &713 title: Exemption response dismissed event type: object properties: @@ -106320,12 +106701,12 @@ x-webhooks: type: string enum: - response_dismissed - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 - exemption_request: *701 - exemption_response: *702 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + exemption_request: *708 + exemption_response: *709 sender: *19 required: - action @@ -106399,7 +106780,7 @@ x-webhooks: required: true content: application/json: - schema: &707 + schema: &714 title: Exemption response submitted event type: object properties: @@ -106407,12 +106788,12 @@ x-webhooks: type: string enum: - response_submitted - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 - exemption_request: *701 - exemption_response: *702 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + exemption_request: *708 + exemption_response: *709 sender: *19 required: - action @@ -106485,7 +106866,7 @@ x-webhooks: required: true content: application/json: - schema: *703 + schema: *710 responses: '200': description: Return a 200 status to indicate that the data was received @@ -106552,7 +106933,7 @@ x-webhooks: required: true content: application/json: - schema: *704 + schema: *711 responses: '200': description: Return a 200 status to indicate that the data was received @@ -106619,7 +107000,7 @@ x-webhooks: required: true content: application/json: - schema: *705 + schema: *712 responses: '200': description: Return a 200 status to indicate that the data was received @@ -106686,7 +107067,7 @@ x-webhooks: required: true content: application/json: - schema: *706 + schema: *713 responses: '200': description: Return a 200 status to indicate that the data was received @@ -106754,7 +107135,7 @@ x-webhooks: required: true content: application/json: - schema: *707 + schema: *714 responses: '200': description: Return a 200 status to indicate that the data was received @@ -106832,7 +107213,7 @@ x-webhooks: type: string enum: - completed - check_run: &709 + check_run: &716 title: CheckRun description: A check performed on the code of a given code change type: object @@ -106846,8 +107227,8 @@ x-webhooks: first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 check_suite: description: A suite of checks performed on the code of a given code change @@ -106895,8 +107276,8 @@ x-webhooks: type: string pull_requests: type: array - items: *395 - repository: *163 + items: *402 + repository: *175 status: example: completed type: string @@ -106933,7 +107314,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *708 + deployment: *715 details_url: example: https://example.com type: string @@ -106983,7 +107364,7 @@ x-webhooks: - annotations_url pull_requests: type: array - items: *395 + items: *402 started_at: example: '2018-05-04T01:14:52Z' type: string @@ -107018,9 +107399,9 @@ x-webhooks: - output - app - pull_requests - installation: *697 - organization: *698 - repository: *699 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - check_run @@ -107413,10 +107794,10 @@ x-webhooks: type: string enum: - created - check_run: *709 - installation: *697 - organization: *698 - repository: *699 + check_run: *716 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - check_run @@ -107812,10 +108193,10 @@ x-webhooks: type: string enum: - requested_action - check_run: *709 - installation: *697 - organization: *698 - repository: *699 + check_run: *716 + installation: *704 + organization: *705 + repository: *706 requested_action: description: The action requested by the user. type: object @@ -108220,10 +108601,10 @@ x-webhooks: type: string enum: - rerequested - check_run: *709 - installation: *697 - organization: *698 - repository: *699 + check_run: *716 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - check_run @@ -109200,10 +109581,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -109873,10 +110254,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -110540,10 +110921,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -110843,20 +111224,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &710 + commit_oid: &717 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: *696 - installation: *697 - organization: *698 - ref: &711 + enterprise: *703 + installation: *704 + organization: *705 + ref: &718 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: *699 + repository: *706 sender: *19 required: - action @@ -111174,12 +111555,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *710 - enterprise: *696 - installation: *697 - organization: *698 - ref: *711 - repository: *699 + commit_oid: *717 + enterprise: *703 + installation: *704 + organization: *705 + ref: *718 + repository: *706 sender: *19 required: - action @@ -111274,7 +111655,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *408 + dismissed_comment: *415 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -111436,12 +111817,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *710 - enterprise: *696 - installation: *697 - organization: *698 - ref: *711 - repository: *699 + commit_oid: *717 + enterprise: *703 + installation: *704 + organization: *705 + ref: *718 + repository: *706 sender: *19 required: - action @@ -111762,12 +112143,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *710 - enterprise: *696 - installation: *697 - organization: *698 - ref: *711 - repository: *699 + commit_oid: *717 + enterprise: *703 + installation: *704 + organization: *705 + ref: *718 + repository: *706 sender: *19 required: - action @@ -112024,16 +112405,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *699 + repository: *706 sender: *19 required: - action @@ -112259,12 +112640,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *710 - enterprise: *696 - installation: *697 - organization: *698 - ref: *711 - repository: *699 + commit_oid: *717 + enterprise: *703 + installation: *704 + organization: *705 + ref: *718 + repository: *706 sender: *19 required: - action @@ -112521,10 +112902,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -112604,18 +112985,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *698 - pusher_type: &712 + organization: *705 + pusher_type: &719 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &713 + ref: &720 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource. type: string @@ -112625,7 +113006,7 @@ x-webhooks: enum: - tag - branch - repository: *699 + repository: *706 sender: *19 required: - ref @@ -112708,9 +113089,9 @@ x-webhooks: enum: - created definition: *96 - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 sender: *19 required: - action @@ -112795,9 +113176,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 sender: *19 required: - action @@ -112875,9 +113256,9 @@ x-webhooks: enum: - updated definition: *96 - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 sender: *19 required: - action @@ -112954,19 +113335,19 @@ x-webhooks: type: string enum: - updated - enterprise: *696 - installation: *697 - repository: *699 - organization: *698 + enterprise: *703 + installation: *704 + repository: *706 + organization: *705 sender: *19 new_property_values: type: array description: The new custom property values for the repository. - items: *273 + items: *286 old_property_values: type: array description: The old custom property values for the repository. - items: *273 + items: *286 required: - action - repository @@ -113042,18 +113423,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *696 - installation: *697 - organization: *698 - pusher_type: *712 - ref: *713 + enterprise: *703 + installation: *704 + organization: *705 + pusher_type: *719 + ref: *720 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *699 + repository: *706 sender: *19 required: - ref @@ -113137,11 +113518,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *462 - installation: *697 - organization: *698 - enterprise: *696 - repository: *699 + alert: *469 + installation: *704 + organization: *705 + enterprise: *703 + repository: *706 sender: *19 required: - action @@ -113225,11 +113606,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *462 - installation: *697 - organization: *698 - enterprise: *696 - repository: *699 + alert: *469 + installation: *704 + organization: *705 + enterprise: *703 + repository: *706 sender: *19 required: - action @@ -113313,11 +113694,11 @@ x-webhooks: type: string enum: - created - alert: *462 - installation: *697 - organization: *698 - enterprise: *696 - repository: *699 + alert: *469 + installation: *704 + organization: *705 + enterprise: *703 + repository: *706 sender: *19 required: - action @@ -113399,11 +113780,11 @@ x-webhooks: type: string enum: - dismissed - alert: *462 - installation: *697 - organization: *698 - enterprise: *696 - repository: *699 + alert: *469 + installation: *704 + organization: *705 + enterprise: *703 + repository: *706 sender: *19 required: - action @@ -113485,11 +113866,11 @@ x-webhooks: type: string enum: - fixed - alert: *462 - installation: *697 - organization: *698 - enterprise: *696 - repository: *699 + alert: *469 + installation: *704 + organization: *705 + enterprise: *703 + repository: *706 sender: *19 required: - action @@ -113572,11 +113953,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *462 - installation: *697 - organization: *698 - enterprise: *696 - repository: *699 + alert: *469 + installation: *704 + organization: *705 + enterprise: *703 + repository: *706 sender: *19 required: - action @@ -113658,11 +114039,11 @@ x-webhooks: type: string enum: - reopened - alert: *462 - installation: *697 - organization: *698 - enterprise: *696 - repository: *699 + alert: *469 + installation: *704 + organization: *705 + enterprise: *703 + repository: *706 sender: *19 required: - action @@ -113739,9 +114120,9 @@ x-webhooks: type: string enum: - created - enterprise: *696 - installation: *697 - key: &714 + enterprise: *703 + installation: *704 + key: &721 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -113777,8 +114158,8 @@ x-webhooks: - verified - created_at - read_only - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 required: - action @@ -113855,11 +114236,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *696 - installation: *697 - key: *714 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + key: *721 + organization: *705 + repository: *706 sender: *19 required: - action @@ -114420,12 +114801,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 - workflow: &718 + workflow: &725 title: Workflow type: object nullable: true @@ -115151,13 +115532,13 @@ x-webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *468 + deployment: *475 pull_requests: type: array - items: *553 - repository: *699 - organization: *698 - installation: *697 + items: *560 + repository: *706 + organization: *705 + installation: *704 sender: *19 responses: '200': @@ -115228,7 +115609,7 @@ x-webhooks: type: string enum: - approved - approver: &715 + approver: &722 type: object properties: avatar_url: @@ -115271,11 +115652,11 @@ x-webhooks: type: string comment: type: string - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 - reviewers: &716 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + reviewers: &723 type: array items: type: object @@ -115354,7 +115735,7 @@ x-webhooks: sender: *19 since: type: string - workflow_job_run: &717 + workflow_job_run: &724 type: object properties: conclusion: @@ -116085,18 +116466,18 @@ x-webhooks: type: string enum: - rejected - approver: *715 + approver: *722 comment: type: string - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 - reviewers: *716 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + reviewers: *723 sender: *19 since: type: string - workflow_job_run: *717 + workflow_job_run: *724 workflow_job_runs: type: array items: @@ -116800,13 +117181,13 @@ x-webhooks: type: string enum: - requested - enterprise: *696 + enterprise: *703 environment: type: string - installation: *697 - organization: *698 - repository: *699 - requestor: &723 + installation: *704 + organization: *705 + repository: *706 + requestor: &730 title: User type: object nullable: true @@ -118705,12 +119086,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 - workflow: *718 + workflow: *725 workflow_run: title: Deployment Workflow Run type: object @@ -119390,7 +119771,7 @@ x-webhooks: type: string enum: - answered - answer: &721 + answer: &728 type: object properties: author_association: @@ -119547,7 +119928,7 @@ x-webhooks: - created_at - updated_at - body - discussion: &719 + discussion: &726 title: Discussion description: A Discussion in a repository. type: object @@ -119833,7 +120214,7 @@ x-webhooks: - id labels: type: array - items: *515 + items: *522 required: - repository_url - category @@ -119855,10 +120236,10 @@ x-webhooks: - author_association - active_lock_reason - body - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -119985,11 +120366,11 @@ x-webhooks: - from required: - category - discussion: *719 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + discussion: *726 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -120072,11 +120453,11 @@ x-webhooks: type: string enum: - closed - discussion: *719 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + discussion: *726 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -120158,7 +120539,7 @@ x-webhooks: type: string enum: - created - comment: &720 + comment: &727 type: object properties: author_association: @@ -120315,11 +120696,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *719 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + discussion: *726 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -120402,12 +120783,12 @@ x-webhooks: type: string enum: - deleted - comment: *720 - discussion: *719 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + comment: *727 + discussion: *726 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -120502,12 +120883,12 @@ x-webhooks: - from required: - body - comment: *720 - discussion: *719 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + comment: *727 + discussion: *726 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -120591,11 +120972,11 @@ x-webhooks: type: string enum: - created - discussion: *719 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + discussion: *726 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -120677,11 +121058,11 @@ x-webhooks: type: string enum: - deleted - discussion: *719 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + discussion: *726 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -120781,11 +121162,11 @@ x-webhooks: type: string required: - from - discussion: *719 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + discussion: *726 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -120867,10 +121248,10 @@ x-webhooks: type: string enum: - labeled - discussion: *719 - enterprise: *696 - installation: *697 - label: &722 + discussion: *726 + enterprise: *703 + installation: *704 + label: &729 title: Label type: object properties: @@ -120902,8 +121283,8 @@ x-webhooks: - color - default - description - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 required: - action @@ -120986,11 +121367,11 @@ x-webhooks: type: string enum: - locked - discussion: *719 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + discussion: *726 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -121072,11 +121453,11 @@ x-webhooks: type: string enum: - pinned - discussion: *719 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + discussion: *726 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -121158,11 +121539,11 @@ x-webhooks: type: string enum: - reopened - discussion: *719 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + discussion: *726 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -121247,16 +121628,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *719 - new_repository: *699 + new_discussion: *726 + new_repository: *706 required: - new_discussion - new_repository - discussion: *719 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + discussion: *726 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -121339,10 +121720,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *719 - old_answer: *721 - organization: *698 - repository: *699 + discussion: *726 + old_answer: *728 + organization: *705 + repository: *706 sender: *19 required: - action @@ -121424,12 +121805,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *719 - enterprise: *696 - installation: *697 - label: *722 - organization: *698 - repository: *699 + discussion: *726 + enterprise: *703 + installation: *704 + label: *729 + organization: *705 + repository: *706 sender: *19 required: - action @@ -121512,11 +121893,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *719 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + discussion: *726 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -121598,11 +121979,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *719 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + discussion: *726 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -121675,7 +122056,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *696 + enterprise: *703 forkee: description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) resource. @@ -122335,9 +122716,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *697 - organization: *698 - repository: *699 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - forkee @@ -122483,9 +122864,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 pages: description: The pages that were updated. type: array @@ -122522,7 +122903,7 @@ x-webhooks: - action - sha - html_url - repository: *699 + repository: *706 sender: *19 required: - pages @@ -122598,10 +122979,10 @@ x-webhooks: type: string enum: - created - enterprise: *696 + enterprise: *703 installation: *22 - organization: *698 - repositories: &724 + organization: *705 + repositories: &731 description: An array of repository objects that the installation can access. type: array @@ -122627,8 +123008,8 @@ x-webhooks: - name - full_name - private - repository: *699 - requester: *723 + repository: *706 + requester: *730 sender: *19 required: - action @@ -122703,11 +123084,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *696 + enterprise: *703 installation: *22 - organization: *698 - repositories: *724 - repository: *699 + organization: *705 + repositories: *731 + repository: *706 requester: nullable: true sender: *19 @@ -122783,11 +123164,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *696 + enterprise: *703 installation: *22 - organization: *698 - repositories: *724 - repository: *699 + organization: *705 + repositories: *731 + repository: *706 requester: nullable: true sender: *19 @@ -122863,10 +123244,10 @@ x-webhooks: type: string enum: - added - enterprise: *696 + enterprise: *703 installation: *22 - organization: *698 - repositories_added: &725 + organization: *705 + repositories_added: &732 description: An array of repository objects, which were added to the installation. type: array @@ -122912,15 +123293,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *699 - repository_selection: &726 + repository: *706 + repository_selection: &733 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *723 + requester: *730 sender: *19 required: - action @@ -122999,10 +123380,10 @@ x-webhooks: type: string enum: - removed - enterprise: *696 + enterprise: *703 installation: *22 - organization: *698 - repositories_added: *725 + organization: *705 + repositories_added: *732 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -123029,9 +123410,9 @@ x-webhooks: - name - full_name - private - repository: *699 - repository_selection: *726 - requester: *723 + repository: *706 + repository_selection: *733 + requester: *730 sender: *19 required: - action @@ -123110,11 +123491,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *696 + enterprise: *703 installation: *22 - organization: *698 - repositories: *724 - repository: *699 + organization: *705 + repositories: *731 + repository: *706 requester: nullable: true sender: *19 @@ -123293,10 +123674,10 @@ x-webhooks: type: string required: - from - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 target_type: type: string @@ -123375,11 +123756,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *696 + enterprise: *703 installation: *22 - organization: *698 - repositories: *724 - repository: *699 + organization: *705 + repositories: *731 + repository: *706 requester: nullable: true sender: *19 @@ -123503,8 +123884,8 @@ x-webhooks: first class actors within GitHub. type: object nullable: true - properties: *107 - required: *108 + properties: *119 + required: *120 reactions: title: Reactions type: object @@ -123631,8 +124012,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -124787,8 +125168,8 @@ x-webhooks: - state - locked - assignee - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 required: - action @@ -124868,7 +125249,7 @@ x-webhooks: type: string enum: - deleted - comment: &727 + comment: &734 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself. @@ -125033,8 +125414,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -126187,8 +126568,8 @@ x-webhooks: - state - locked - assignee - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 required: - action @@ -126268,7 +126649,7 @@ x-webhooks: type: string enum: - edited - changes: &755 + changes: &762 description: The changes to the comment. type: object properties: @@ -126280,9 +126661,9 @@ x-webhooks: type: string required: - from - comment: *727 - enterprise: *696 - installation: *697 + comment: *734 + enterprise: *703 + installation: *704 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -127436,8 +127817,8 @@ x-webhooks: - state - locked - assignee - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 required: - action @@ -127519,10 +127900,10 @@ x-webhooks: type: string enum: - assigned - assignee: *723 - enterprise: *696 - installation: *697 - issue: &730 + assignee: *730 + enterprise: *703 + installation: *704 + issue: &737 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -128440,8 +128821,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 required: - action @@ -128521,8 +128902,8 @@ x-webhooks: type: string enum: - closed - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -129580,8 +129961,8 @@ x-webhooks: required: - state - closed_at - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 required: - action @@ -129660,8 +130041,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -130572,8 +130953,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 required: - action @@ -130652,8 +131033,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -131567,7 +131948,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &728 + milestone: &735 title: Milestone description: A collection of related issues and pull requests. type: object @@ -131705,8 +132086,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 required: - action @@ -131805,8 +132186,8 @@ x-webhooks: type: string required: - from - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -132724,9 +133105,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *722 - organization: *698 - repository: *699 + label: *729 + organization: *705 + repository: *706 sender: *19 required: - action @@ -132806,8 +133187,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -133724,9 +134105,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *722 - organization: *698 - repository: *699 + label: *729 + organization: *705 + repository: *706 sender: *19 required: - action @@ -133806,8 +134187,8 @@ x-webhooks: type: string enum: - locked - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -134725,8 +135106,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 required: - action @@ -134805,8 +135186,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -135718,9 +136099,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *728 - organization: *698 - repository: *699 + milestone: *735 + organization: *705 + repository: *706 sender: *19 required: - action @@ -137181,8 +137562,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -138099,8 +138480,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 required: - action @@ -138180,9 +138561,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *696 - installation: *697 - issue: &729 + enterprise: *703 + installation: *704 + issue: &736 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -139093,8 +139474,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 required: - action @@ -139173,8 +139554,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -140091,8 +140472,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 required: - action @@ -141554,11 +141935,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *696 - installation: *697 - issue: *729 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + issue: *736 + organization: *705 + repository: *706 sender: *19 required: - action @@ -141639,7 +142020,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &758 + assignee: &765 title: User type: object nullable: true @@ -141709,11 +142090,11 @@ x-webhooks: required: - login - id - enterprise: *696 - installation: *697 - issue: *730 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + issue: *737 + organization: *705 + repository: *706 sender: *19 required: - action @@ -141792,12 +142173,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *696 - installation: *697 - issue: *730 - label: *722 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + issue: *737 + label: *729 + organization: *705 + repository: *706 sender: *19 required: - action @@ -141877,8 +142258,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -142794,8 +143175,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 required: - action @@ -142875,11 +143256,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *696 - installation: *697 - issue: *729 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + issue: *736 + organization: *705 + repository: *706 sender: *19 required: - action @@ -142958,11 +143339,11 @@ x-webhooks: type: string enum: - created - enterprise: *696 - installation: *697 - label: *722 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + label: *729 + organization: *705 + repository: *706 sender: *19 required: - action @@ -143040,11 +143421,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *696 - installation: *697 - label: *722 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + label: *729 + organization: *705 + repository: *706 sender: *19 required: - action @@ -143154,11 +143535,11 @@ x-webhooks: type: string required: - from - enterprise: *696 - installation: *697 - label: *722 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + label: *729 + organization: *705 + repository: *706 sender: *19 required: - action @@ -143240,9 +143621,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *696 - installation: *697 - marketplace_purchase: &731 + enterprise: *703 + installation: *704 + marketplace_purchase: &738 title: Marketplace Purchase type: object required: @@ -143325,8 +143706,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *698 - previous_marketplace_purchase: &732 + organization: *705 + previous_marketplace_purchase: &739 title: Marketplace Purchase type: object properties: @@ -143406,7 +143787,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *699 + repository: *706 sender: *19 required: - action @@ -143486,10 +143867,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *696 - installation: *697 - marketplace_purchase: *731 - organization: *698 + enterprise: *703 + installation: *704 + marketplace_purchase: *738 + organization: *705 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -143572,7 +143953,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *699 + repository: *706 sender: *19 required: - action @@ -143654,10 +144035,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *696 - installation: *697 - marketplace_purchase: *731 - organization: *698 + enterprise: *703 + installation: *704 + marketplace_purchase: *738 + organization: *705 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -143739,7 +144120,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *699 + repository: *706 sender: *19 required: - action @@ -143820,8 +144201,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 marketplace_purchase: title: Marketplace Purchase type: object @@ -143903,9 +144284,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *698 - previous_marketplace_purchase: *732 - repository: *699 + organization: *705 + previous_marketplace_purchase: *739 + repository: *706 sender: *19 required: - action @@ -143985,12 +144366,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *696 - installation: *697 - marketplace_purchase: *731 - organization: *698 - previous_marketplace_purchase: *732 - repository: *699 + enterprise: *703 + installation: *704 + marketplace_purchase: *738 + organization: *705 + previous_marketplace_purchase: *739 + repository: *706 sender: *19 required: - action @@ -144092,11 +144473,11 @@ x-webhooks: type: string required: - to - enterprise: *696 - installation: *697 - member: *723 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + member: *730 + organization: *705 + repository: *706 sender: *19 required: - action @@ -144196,11 +144577,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *696 - installation: *697 - member: *723 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + member: *730 + organization: *705 + repository: *706 sender: *19 required: - action @@ -144279,11 +144660,11 @@ x-webhooks: type: string enum: - removed - enterprise: *696 - installation: *697 - member: *723 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + member: *730 + organization: *705 + repository: *706 sender: *19 required: - action @@ -144361,11 +144742,11 @@ x-webhooks: type: string enum: - added - enterprise: *696 - installation: *697 - member: *723 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + member: *730 + organization: *705 + repository: *706 scope: description: The scope of the membership. Currently, can only be `team`. @@ -144441,7 +144822,7 @@ x-webhooks: required: - login - id - team: &733 + team: &740 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -144631,11 +145012,11 @@ x-webhooks: type: string enum: - removed - enterprise: *696 - installation: *697 - member: *723 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + member: *730 + organization: *705 + repository: *706 scope: description: The scope of the membership. Currently, can only be `team`. @@ -144712,7 +145093,7 @@ x-webhooks: required: - login - id - team: *733 + team: *740 required: - action - scope @@ -144794,8 +145175,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *697 - merge_group: &735 + installation: *704 + merge_group: &742 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -144814,15 +145195,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *734 + head_commit: *741 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 required: - action @@ -144908,10 +145289,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *697 - merge_group: *735 - organization: *698 - repository: *699 + installation: *704 + merge_group: *742 + organization: *705 + repository: *706 sender: *19 required: - action @@ -144984,7 +145365,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *696 + enterprise: *703 hook: description: 'The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -145092,16 +145473,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *697 - organization: *698 + installation: *704 + organization: *705 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *736 - required: *737 + properties: *743 + required: *744 nullable: true sender: *19 required: @@ -145182,11 +145563,11 @@ x-webhooks: type: string enum: - closed - enterprise: *696 - installation: *697 - milestone: *728 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + milestone: *735 + organization: *705 + repository: *706 sender: *19 required: - action @@ -145265,9 +145646,9 @@ x-webhooks: type: string enum: - created - enterprise: *696 - installation: *697 - milestone: &738 + enterprise: *703 + installation: *704 + milestone: &745 title: Milestone description: A collection of related issues and pull requests. type: object @@ -145404,8 +145785,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 required: - action @@ -145484,11 +145865,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *696 - installation: *697 - milestone: *728 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + milestone: *735 + organization: *705 + repository: *706 sender: *19 required: - action @@ -145598,11 +145979,11 @@ x-webhooks: type: string required: - from - enterprise: *696 - installation: *697 - milestone: *728 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + milestone: *735 + organization: *705 + repository: *706 sender: *19 required: - action @@ -145682,11 +146063,11 @@ x-webhooks: type: string enum: - opened - enterprise: *696 - installation: *697 - milestone: *738 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + milestone: *745 + organization: *705 + repository: *706 sender: *19 required: - action @@ -145765,11 +146146,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *723 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + blocked_user: *730 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -145848,11 +146229,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *723 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + blocked_user: *730 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -145931,9 +146312,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *696 - installation: *697 - membership: &739 + enterprise: *703 + installation: *704 + membership: &746 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -146025,8 +146406,8 @@ x-webhooks: - role - organization_url - user - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 required: - action @@ -146104,11 +146485,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *696 - installation: *697 - membership: *739 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + membership: *746 + organization: *705 + repository: *706 sender: *19 required: - action @@ -146187,8 +146568,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -146304,10 +146685,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 - user: *723 + user: *730 required: - action - invitation @@ -146385,11 +146766,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *696 - installation: *697 - membership: *739 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + membership: *746 + organization: *705 + repository: *706 sender: *19 required: - action @@ -146476,11 +146857,11 @@ x-webhooks: properties: from: type: string - enterprise: *696 - installation: *697 - membership: *739 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + membership: *746 + organization: *705 + repository: *706 sender: *19 required: - action @@ -146556,9 +146937,9 @@ x-webhooks: type: string enum: - published - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 package: description: Information about the package. type: object @@ -147057,7 +147438,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &740 + items: &747 title: Ruby Gems metadata type: object properties: @@ -147152,7 +147533,7 @@ x-webhooks: - owner - package_version - registry - repository: *699 + repository: *706 sender: *19 required: - action @@ -147228,9 +147609,9 @@ x-webhooks: type: string enum: - updated - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 package: description: Information about the package. type: object @@ -147583,7 +147964,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *740 + items: *747 source_url: type: string format: uri @@ -147653,7 +148034,7 @@ x-webhooks: - owner - package_version - registry - repository: *699 + repository: *706 sender: *19 required: - action @@ -147830,12 +148211,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *696 + enterprise: *703 id: type: integer - installation: *697 - organization: *698 - repository: *699 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - id @@ -147915,7 +148296,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &741 + personal_access_token_request: &748 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -148061,10 +148442,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *696 - organization: *698 + enterprise: *703 + organization: *705 sender: *19 - installation: *697 + installation: *704 required: - action - personal_access_token_request @@ -148143,11 +148524,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *741 - enterprise: *696 - organization: *698 + personal_access_token_request: *748 + enterprise: *703 + organization: *705 sender: *19 - installation: *697 + installation: *704 required: - action - personal_access_token_request @@ -148225,11 +148606,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *741 - enterprise: *696 - organization: *698 + personal_access_token_request: *748 + enterprise: *703 + organization: *705 sender: *19 - installation: *697 + installation: *704 required: - action - personal_access_token_request @@ -148306,11 +148687,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *741 - organization: *698 - enterprise: *696 + personal_access_token_request: *748 + organization: *705 + enterprise: *703 sender: *19 - installation: *697 + installation: *704 required: - action - personal_access_token_request @@ -148414,7 +148795,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *742 + last_response: *749 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -148446,8 +148827,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 zen: description: Random string of GitHub zen. @@ -148692,10 +149073,10 @@ x-webhooks: - from required: - note - enterprise: *696 - installation: *697 - organization: *698 - project_card: &743 + enterprise: *703 + installation: *704 + organization: *705 + project_card: &750 title: Project Card type: object properties: @@ -148814,7 +149195,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *699 + repository: *706 sender: *19 required: - action @@ -148895,11 +149276,11 @@ x-webhooks: type: string enum: - created - enterprise: *696 - installation: *697 - organization: *698 - project_card: *743 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + project_card: *750 + repository: *706 sender: *19 required: - action @@ -148979,9 +149360,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 project_card: title: Project Card type: object @@ -149109,8 +149490,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *736 - required: *737 + properties: *743 + required: *744 nullable: true sender: *19 required: @@ -149204,11 +149585,11 @@ x-webhooks: - from required: - note - enterprise: *696 - installation: *697 - organization: *698 - project_card: *743 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + project_card: *750 + repository: *706 sender: *19 required: - action @@ -149302,9 +149683,9 @@ x-webhooks: - from required: - column_id - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 project_card: allOf: - title: Project Card @@ -149494,7 +149875,7 @@ x-webhooks: type: string required: - after_id - repository: *699 + repository: *706 sender: *19 required: - action @@ -149574,10 +149955,10 @@ x-webhooks: type: string enum: - closed - enterprise: *696 - installation: *697 - organization: *698 - project: &745 + enterprise: *703 + installation: *704 + organization: *705 + project: &752 title: Project type: object properties: @@ -149701,7 +150082,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *699 + repository: *706 sender: *19 required: - action @@ -149781,10 +150162,10 @@ x-webhooks: type: string enum: - created - enterprise: *696 - installation: *697 - organization: *698 - project_column: &744 + enterprise: *703 + installation: *704 + organization: *705 + project_column: &751 title: Project Column type: object properties: @@ -149823,7 +150204,7 @@ x-webhooks: - name - created_at - updated_at - repository: *699 + repository: *706 sender: *19 required: - action @@ -149902,18 +150283,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *696 - installation: *697 - organization: *698 - project_column: *744 + enterprise: *703 + installation: *704 + organization: *705 + project_column: *751 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *736 - required: *737 + properties: *743 + required: *744 nullable: true sender: *19 required: @@ -150003,11 +150384,11 @@ x-webhooks: type: string required: - from - enterprise: *696 - installation: *697 - organization: *698 - project_column: *744 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + project_column: *751 + repository: *706 sender: *19 required: - action @@ -150087,11 +150468,11 @@ x-webhooks: type: string enum: - moved - enterprise: *696 - installation: *697 - organization: *698 - project_column: *744 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + project_column: *751 + repository: *706 sender: *19 required: - action @@ -150171,11 +150552,11 @@ x-webhooks: type: string enum: - created - enterprise: *696 - installation: *697 - organization: *698 - project: *745 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + project: *752 + repository: *706 sender: *19 required: - action @@ -150255,18 +150636,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *696 - installation: *697 - organization: *698 - project: *745 + enterprise: *703 + installation: *704 + organization: *705 + project: *752 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *736 - required: *737 + properties: *743 + required: *744 nullable: true sender: *19 required: @@ -150368,11 +150749,11 @@ x-webhooks: type: string required: - from - enterprise: *696 - installation: *697 - organization: *698 - project: *745 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + project: *752 + repository: *706 sender: *19 required: - action @@ -150451,11 +150832,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *696 - installation: *697 - organization: *698 - project: *745 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + project: *752 + repository: *706 sender: *19 required: - action @@ -150536,9 +150917,9 @@ x-webhooks: type: string enum: - closed - installation: *697 - organization: *698 - projects_v2: &746 + installation: *704 + organization: *705 + projects_v2: &753 title: Projects v2 Project description: A projects v2 project type: object @@ -150681,9 +151062,9 @@ x-webhooks: type: string enum: - created - installation: *697 - organization: *698 - projects_v2: *746 + installation: *704 + organization: *705 + projects_v2: *753 sender: *19 required: - action @@ -150764,9 +151145,9 @@ x-webhooks: type: string enum: - deleted - installation: *697 - organization: *698 - projects_v2: *746 + installation: *704 + organization: *705 + projects_v2: *753 sender: *19 required: - action @@ -150883,9 +151264,9 @@ x-webhooks: type: string to: type: string - installation: *697 - organization: *698 - projects_v2: *746 + installation: *704 + organization: *705 + projects_v2: *753 sender: *19 required: - action @@ -150968,7 +151349,7 @@ x-webhooks: type: string enum: - archived - changes: &750 + changes: &757 type: object properties: archived_at: @@ -150982,9 +151363,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *697 - organization: *698 - projects_v2_item: &747 + installation: *704 + organization: *705 + projects_v2_item: &754 title: Projects v2 Item description: An item belonging to a project type: object @@ -151118,9 +151499,9 @@ x-webhooks: nullable: true to: type: string - installation: *697 - organization: *698 - projects_v2_item: *747 + installation: *704 + organization: *705 + projects_v2_item: *754 sender: *19 required: - action @@ -151202,9 +151583,9 @@ x-webhooks: type: string enum: - created - installation: *697 - organization: *698 - projects_v2_item: *747 + installation: *704 + organization: *705 + projects_v2_item: *754 sender: *19 required: - action @@ -151285,9 +151666,9 @@ x-webhooks: type: string enum: - deleted - installation: *697 - organization: *698 - projects_v2_item: *747 + installation: *704 + organization: *705 + projects_v2_item: *754 sender: *19 required: - action @@ -151393,7 +151774,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &748 + - &755 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -151411,7 +151792,7 @@ x-webhooks: required: - id - name - - &749 + - &756 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -151434,8 +151815,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *748 - - *749 + - *755 + - *756 required: - field_value - type: object @@ -151451,9 +151832,9 @@ x-webhooks: nullable: true required: - body - installation: *697 - organization: *698 - projects_v2_item: *747 + installation: *704 + organization: *705 + projects_v2_item: *754 sender: *19 required: - action @@ -151548,9 +151929,9 @@ x-webhooks: to: type: string nullable: true - installation: *697 - organization: *698 - projects_v2_item: *747 + installation: *704 + organization: *705 + projects_v2_item: *754 sender: *19 required: - action @@ -151633,10 +152014,10 @@ x-webhooks: type: string enum: - restored - changes: *750 - installation: *697 - organization: *698 - projects_v2_item: *747 + changes: *757 + installation: *704 + organization: *705 + projects_v2_item: *754 sender: *19 required: - action @@ -151718,9 +152099,9 @@ x-webhooks: type: string enum: - reopened - installation: *697 - organization: *698 - projects_v2: *746 + installation: *704 + organization: *705 + projects_v2: *753 sender: *19 required: - action @@ -151801,9 +152182,9 @@ x-webhooks: type: string enum: - created - installation: *697 - organization: *698 - projects_v2_status_update: &751 + installation: *704 + organization: *705 + projects_v2_status_update: &758 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -151930,9 +152311,9 @@ x-webhooks: type: string enum: - deleted - installation: *697 - organization: *698 - projects_v2_status_update: *751 + installation: *704 + organization: *705 + projects_v2_status_update: *758 sender: *19 required: - action @@ -152068,9 +152449,9 @@ x-webhooks: type: string format: date nullable: true - installation: *697 - organization: *698 - projects_v2_status_update: *751 + installation: *704 + organization: *705 + projects_v2_status_update: *758 sender: *19 required: - action @@ -152141,10 +152522,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - repository @@ -152221,13 +152602,13 @@ x-webhooks: type: string enum: - assigned - assignee: *723 - enterprise: *696 - installation: *697 - number: &752 + assignee: *730 + enterprise: *703 + installation: *704 + number: &759 description: The pull request number. type: integer - organization: *698 + organization: *705 pull_request: title: Pull Request type: object @@ -154510,7 +154891,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *699 + repository: *706 sender: *19 required: - action @@ -154592,11 +154973,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 number: type: integer - organization: *698 + organization: *705 pull_request: title: Pull Request type: object @@ -156874,7 +157255,7 @@ x-webhooks: - draft reason: type: string - repository: *699 + repository: *706 sender: *19 required: - action @@ -156956,11 +157337,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 number: type: integer - organization: *698 + organization: *705 pull_request: title: Pull Request type: object @@ -159238,7 +159619,7 @@ x-webhooks: - draft reason: type: string - repository: *699 + repository: *706 sender: *19 required: - action @@ -159320,13 +159701,13 @@ x-webhooks: type: string enum: - closed - enterprise: *696 - installation: *697 - number: *752 - organization: *698 - pull_request: &753 + enterprise: *703 + installation: *704 + number: *759 + organization: *705 + pull_request: &760 allOf: - - *553 + - *560 - type: object properties: allow_auto_merge: @@ -159388,7 +159769,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *699 + repository: *706 sender: *19 required: - action @@ -159469,12 +159850,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *696 - installation: *697 - number: *752 - organization: *698 - pull_request: *753 - repository: *699 + enterprise: *703 + installation: *704 + number: *759 + organization: *705 + pull_request: *760 + repository: *706 sender: *19 required: - action @@ -159554,11 +159935,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *696 - milestone: *536 - number: *752 - organization: *698 - pull_request: &754 + enterprise: *703 + milestone: *543 + number: *759 + organization: *705 + pull_request: &761 title: Pull Request type: object properties: @@ -161821,7 +162202,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *699 + repository: *706 sender: *19 required: - action @@ -161900,11 +162281,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 number: type: integer - organization: *698 + organization: *705 pull_request: title: Pull Request type: object @@ -164186,7 +164567,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *699 + repository: *706 sender: *19 required: - action @@ -164310,12 +164691,12 @@ x-webhooks: type: string required: - from - enterprise: *696 - installation: *697 - number: *752 - organization: *698 - pull_request: *753 - repository: *699 + enterprise: *703 + installation: *704 + number: *759 + organization: *705 + pull_request: *760 + repository: *706 sender: *19 required: - action @@ -164395,11 +164776,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 number: type: integer - organization: *698 + organization: *705 pull_request: title: Pull Request type: object @@ -166666,7 +167047,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *699 + repository: *706 sender: *19 required: - action @@ -166746,11 +167127,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *696 - installation: *697 - label: *722 - number: *752 - organization: *698 + enterprise: *703 + installation: *704 + label: *729 + number: *759 + organization: *705 pull_request: title: Pull Request type: object @@ -169032,7 +169413,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *699 + repository: *706 sender: *19 required: - action @@ -169113,10 +169494,10 @@ x-webhooks: type: string enum: - locked - enterprise: *696 - installation: *697 - number: *752 - organization: *698 + enterprise: *703 + installation: *704 + number: *759 + organization: *705 pull_request: title: Pull Request type: object @@ -171396,7 +171777,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *699 + repository: *706 sender: *19 required: - action @@ -171476,12 +171857,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *696 - milestone: *536 - number: *752 - organization: *698 - pull_request: *754 - repository: *699 + enterprise: *703 + milestone: *543 + number: *759 + organization: *705 + pull_request: *761 + repository: *706 sender: *19 required: - action @@ -171560,12 +171941,12 @@ x-webhooks: type: string enum: - opened - enterprise: *696 - installation: *697 - number: *752 - organization: *698 - pull_request: *753 - repository: *699 + enterprise: *703 + installation: *704 + number: *759 + organization: *705 + pull_request: *760 + repository: *706 sender: *19 required: - action @@ -171646,12 +172027,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *696 - installation: *697 - number: *752 - organization: *698 - pull_request: *753 - repository: *699 + enterprise: *703 + installation: *704 + number: *759 + organization: *705 + pull_request: *760 + repository: *706 sender: *19 required: - action @@ -171731,12 +172112,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *696 - installation: *697 - number: *752 - organization: *698 - pull_request: *753 - repository: *699 + enterprise: *703 + installation: *704 + number: *759 + organization: *705 + pull_request: *760 + repository: *706 sender: *19 required: - action @@ -172102,9 +172483,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 pull_request: type: object properties: @@ -174274,7 +174655,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *699 + repository: *706 sender: *19 required: - action @@ -174354,7 +174735,7 @@ x-webhooks: type: string enum: - deleted - comment: &756 + comment: &763 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. @@ -174639,9 +175020,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 pull_request: type: object properties: @@ -176799,7 +177180,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *699 + repository: *706 sender: *19 required: - action @@ -176879,11 +177260,11 @@ x-webhooks: type: string enum: - edited - changes: *755 - comment: *756 - enterprise: *696 - installation: *697 - organization: *698 + changes: *762 + comment: *763 + enterprise: *703 + installation: *704 + organization: *705 pull_request: type: object properties: @@ -179044,7 +179425,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *699 + repository: *706 sender: *19 required: - action @@ -179125,9 +179506,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 pull_request: title: Simple Pull Request type: object @@ -181300,7 +181681,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *699 + repository: *706 review: description: The review that was affected. type: object @@ -181543,9 +181924,9 @@ x-webhooks: type: string required: - from - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 pull_request: title: Simple Pull Request type: object @@ -183599,8 +183980,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *699 - review: &757 + repository: *706 + review: &764 description: The review that was affected. type: object properties: @@ -183829,12 +184210,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 number: description: The pull request number. type: integer - organization: *698 + organization: *705 pull_request: title: Pull Request type: object @@ -186117,7 +186498,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *699 + repository: *706 requested_reviewer: title: User type: object @@ -186201,12 +186582,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 number: description: The pull request number. type: integer - organization: *698 + organization: *705 pull_request: title: Pull Request type: object @@ -188496,7 +188877,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *699 + repository: *706 requested_team: title: Team description: Groups of organization members that gives permissions @@ -188688,12 +189069,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 number: description: The pull request number. type: integer - organization: *698 + organization: *705 pull_request: title: Pull Request type: object @@ -190978,7 +191359,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *699 + repository: *706 requested_reviewer: title: User type: object @@ -191063,12 +191444,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *696 - installation: *697 + enterprise: *703 + installation: *704 number: description: The pull request number. type: integer - organization: *698 + organization: *705 pull_request: title: Pull Request type: object @@ -193344,7 +193725,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *699 + repository: *706 requested_team: title: Team description: Groups of organization members that gives permissions @@ -193525,9 +193906,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 pull_request: title: Simple Pull Request type: object @@ -195702,8 +196083,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *699 - review: *757 + repository: *706 + review: *764 sender: *19 required: - action @@ -195783,9 +196164,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 pull_request: title: Simple Pull Request type: object @@ -197855,7 +198236,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *699 + repository: *706 sender: *19 thread: type: object @@ -198238,9 +198619,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 pull_request: title: Simple Pull Request type: object @@ -200296,7 +200677,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *699 + repository: *706 sender: *19 thread: type: object @@ -200682,10 +201063,10 @@ x-webhooks: type: string before: type: string - enterprise: *696 - installation: *697 - number: *752 - organization: *698 + enterprise: *703 + installation: *704 + number: *759 + organization: *705 pull_request: title: Pull Request type: object @@ -202956,7 +203337,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *699 + repository: *706 sender: *19 required: - action @@ -203038,11 +203419,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *758 - enterprise: *696 - installation: *697 - number: *752 - organization: *698 + assignee: *765 + enterprise: *703 + installation: *704 + number: *759 + organization: *705 pull_request: title: Pull Request type: object @@ -205325,7 +205706,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *699 + repository: *706 sender: *19 required: - action @@ -205404,11 +205785,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *696 - installation: *697 - label: *722 - number: *752 - organization: *698 + enterprise: *703 + installation: *704 + label: *729 + number: *759 + organization: *705 pull_request: title: Pull Request type: object @@ -207681,7 +208062,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *699 + repository: *706 sender: *19 required: - action @@ -207762,10 +208143,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *696 - installation: *697 - number: *752 - organization: *698 + enterprise: *703 + installation: *704 + number: *759 + organization: *705 pull_request: title: Pull Request type: object @@ -210030,7 +210411,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *699 + repository: *706 sender: *19 required: - action @@ -210230,7 +210611,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *696 + enterprise: *703 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -210322,8 +210703,8 @@ x-webhooks: - url - author - committer - installation: *697 - organization: *698 + installation: *704 + organization: *705 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -210898,9 +211279,9 @@ x-webhooks: type: string enum: - published - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 registry_package: type: object properties: @@ -211346,7 +211727,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *740 + items: *747 summary: type: string tag_name: @@ -211400,7 +211781,7 @@ x-webhooks: - owner - package_version - registry - repository: *699 + repository: *706 sender: *19 required: - action @@ -211478,9 +211859,9 @@ x-webhooks: type: string enum: - updated - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 registry_package: type: object properties: @@ -211788,7 +212169,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *740 + items: *747 summary: type: string tag_name: @@ -211837,7 +212218,7 @@ x-webhooks: - owner - package_version - registry - repository: *699 + repository: *706 sender: *19 required: - action @@ -211914,10 +212295,10 @@ x-webhooks: type: string enum: - created - enterprise: *696 - installation: *697 - organization: *698 - release: &759 + enterprise: *703 + installation: *704 + organization: *705 + release: &766 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -212222,7 +212603,7 @@ x-webhooks: - tarball_url - zipball_url - body - repository: *699 + repository: *706 sender: *19 required: - action @@ -212299,11 +212680,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *696 - installation: *697 - organization: *698 - release: *759 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + release: *766 + repository: *706 sender: *19 required: - action @@ -212411,11 +212792,11 @@ x-webhooks: type: boolean required: - to - enterprise: *696 - installation: *697 - organization: *698 - release: *759 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + release: *766 + repository: *706 sender: *19 required: - action @@ -212493,9 +212874,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 release: title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) @@ -212804,7 +213185,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *699 + repository: *706 sender: *19 required: - action @@ -212880,10 +213261,10 @@ x-webhooks: type: string enum: - published - enterprise: *696 - installation: *697 - organization: *698 - release: &760 + enterprise: *703 + installation: *704 + organization: *705 + release: &767 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -213189,7 +213570,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *699 + repository: *706 sender: *19 required: - action @@ -213265,11 +213646,11 @@ x-webhooks: type: string enum: - released - enterprise: *696 - installation: *697 - organization: *698 - release: *759 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + release: *766 + repository: *706 sender: *19 required: - action @@ -213345,11 +213726,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *696 - installation: *697 - organization: *698 - release: *760 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + release: *767 + repository: *706 sender: *19 required: - action @@ -213425,11 +213806,11 @@ x-webhooks: type: string enum: - published - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 - repository_advisory: *607 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + repository_advisory: *614 sender: *19 required: - action @@ -213505,11 +213886,11 @@ x-webhooks: type: string enum: - reported - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 - repository_advisory: *607 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + repository_advisory: *614 sender: *19 required: - action @@ -213585,10 +213966,10 @@ x-webhooks: type: string enum: - archived - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -213665,10 +214046,10 @@ x-webhooks: type: string enum: - created - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -213746,10 +214127,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -213833,10 +214214,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -213948,10 +214329,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -214023,10 +214404,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 status: type: string @@ -214107,10 +214488,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -214187,10 +214568,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -214284,10 +214665,10 @@ x-webhooks: - name required: - repository - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -214367,11 +214748,11 @@ x-webhooks: type: string enum: - created - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 - repository_ruleset: *285 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + repository_ruleset: *109 sender: *19 required: - action @@ -214449,11 +214830,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 - repository_ruleset: *285 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + repository_ruleset: *109 sender: *19 required: - action @@ -214531,11 +214912,11 @@ x-webhooks: type: string enum: - edited - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 - repository_ruleset: *285 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + repository_ruleset: *109 changes: type: object properties: @@ -214554,16 +214935,16 @@ x-webhooks: properties: added: type: array - items: *279 + items: *102 deleted: type: array - items: *279 + items: *102 updated: type: array items: type: object properties: - condition: *279 + condition: *102 changes: type: object properties: @@ -214596,16 +214977,16 @@ x-webhooks: properties: added: type: array - items: *284 + items: *108 deleted: type: array - items: *284 + items: *108 updated: type: array items: type: object properties: - rule: *284 + rule: *108 changes: type: object properties: @@ -214839,10 +215220,10 @@ x-webhooks: - from required: - owner - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -214920,10 +215301,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -215001,7 +215382,7 @@ x-webhooks: type: string enum: - create - alert: &761 + alert: &768 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -215122,10 +215503,10 @@ x-webhooks: type: string enum: - open - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -215331,10 +215712,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -215412,11 +215793,11 @@ x-webhooks: type: string enum: - reopen - alert: *761 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + alert: *768 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -215615,10 +215996,10 @@ x-webhooks: enum: - fixed - open - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -215696,7 +216077,7 @@ x-webhooks: type: string enum: - created - alert: &762 + alert: &769 type: object properties: number: *85 @@ -215783,6 +216164,11 @@ x-webhooks: properties: *4 required: *5 nullable: true + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection + bypass. + nullable: true push_protection_bypass_request_comment: type: string description: An optional comment when requesting a push protection @@ -215802,10 +216188,10 @@ x-webhooks: description: Whether the detected secret was found in multiple repositories in the same organization or business. nullable: true - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -215886,11 +216272,11 @@ x-webhooks: type: string enum: - created - alert: *762 - installation: *697 - location: *763 - organization: *698 - repository: *699 + alert: *769 + installation: *704 + location: *770 + organization: *705 + repository: *706 sender: *19 required: - location @@ -216128,11 +216514,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *762 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + alert: *769 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -216210,11 +216596,11 @@ x-webhooks: type: string enum: - reopened - alert: *762 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + alert: *769 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -216292,11 +216678,11 @@ x-webhooks: type: string enum: - resolved - alert: *762 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + alert: *769 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -216374,11 +216760,11 @@ x-webhooks: type: string enum: - validated - alert: *762 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + alert: *769 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -216454,11 +216840,11 @@ x-webhooks: type: string enum: - published - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 - security_advisory: &764 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + security_advisory: &771 description: The details of the security advisory, including summary, description, and severity. type: object @@ -216641,11 +217027,11 @@ x-webhooks: type: string enum: - updated - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 - security_advisory: *764 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 + security_advisory: *771 sender: *19 required: - action @@ -216718,10 +217104,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -216905,11 +217291,11 @@ x-webhooks: from: type: object properties: - security_and_analysis: *276 - enterprise: *696 - installation: *697 - organization: *698 - repository: *338 + security_and_analysis: *289 + enterprise: *703 + installation: *704 + organization: *705 + repository: *345 sender: *19 required: - changes @@ -216987,12 +217373,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 - sponsorship: &765 + sponsorship: &772 type: object properties: created_at: @@ -217293,12 +217679,12 @@ x-webhooks: type: string enum: - created - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 - sponsorship: *765 + sponsorship: *772 required: - action - sponsorship @@ -217386,12 +217772,12 @@ x-webhooks: type: string required: - from - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 - sponsorship: *765 + sponsorship: *772 required: - action - changes @@ -217468,17 +217854,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &766 + effective_date: &773 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: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 - sponsorship: *765 + sponsorship: *772 required: - action - sponsorship @@ -217552,7 +217938,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &767 + changes: &774 type: object properties: tier: @@ -217596,13 +217982,13 @@ x-webhooks: - from required: - tier - effective_date: *766 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + effective_date: *773 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 - sponsorship: *765 + sponsorship: *772 required: - action - changes @@ -217679,13 +218065,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *767 - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + changes: *774 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 - sponsorship: *765 + sponsorship: *772 required: - action - changes @@ -217759,10 +218145,10 @@ x-webhooks: type: string enum: - created - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 starred_at: description: 'The time the star was created. This is a timestamp @@ -217845,10 +218231,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 starred_at: description: 'The time the star was created. This is a timestamp @@ -218267,15 +218653,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *696 + enterprise: *703 id: description: The unique identifier of the status. type: integer - installation: *697 + installation: *704 name: type: string - organization: *698 - repository: *699 + organization: *705 + repository: *706 sender: *19 sha: description: The Commit SHA. @@ -218384,15 +218770,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *122 + parent_issue: *134 parent_issue_repo: *57 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *122 - installation: *697 - organization: *698 - repository: *699 + sub_issue: *134 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -218476,15 +218862,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *122 + parent_issue: *134 parent_issue_repo: *57 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *122 - installation: *697 - organization: *698 - repository: *699 + sub_issue: *134 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -218568,15 +218954,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *122 + sub_issue: *134 sub_issue_repo: *57 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *122 - installation: *697 - organization: *698 - repository: *699 + parent_issue: *134 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -218660,15 +219046,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *122 + sub_issue: *134 sub_issue_repo: *57 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *122 - installation: *697 - organization: *698 - repository: *699 + parent_issue: *134 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -218745,12 +219131,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 - team: &768 + team: &775 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -218940,9 +219326,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 repository: title: Repository description: A git repository @@ -219400,7 +219786,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *768 + team: *775 required: - action - team @@ -219476,9 +219862,9 @@ x-webhooks: type: string enum: - created - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 repository: title: Repository description: A git repository @@ -219936,7 +220322,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *768 + team: *775 required: - action - team @@ -220013,9 +220399,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 repository: title: Repository description: A git repository @@ -220473,7 +220859,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *768 + team: *775 required: - action - team @@ -220617,9 +221003,9 @@ x-webhooks: - from required: - permissions - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 repository: title: Repository description: A git repository @@ -221077,7 +221463,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *768 + team: *775 required: - action - changes @@ -221155,9 +221541,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *696 - installation: *697 - organization: *698 + enterprise: *703 + installation: *704 + organization: *705 repository: title: Repository description: A git repository @@ -221615,7 +222001,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *768 + team: *775 required: - action - team @@ -221691,10 +222077,10 @@ x-webhooks: type: string enum: - started - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 required: - action @@ -221767,16 +222153,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *696 + enterprise: *703 inputs: type: object nullable: true additionalProperties: true - installation: *697 - organization: *698 + installation: *704 + organization: *705 ref: type: string - repository: *699 + repository: *706 sender: *19 workflow: type: string @@ -221858,10 +222244,10 @@ x-webhooks: type: string enum: - completed - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 workflow_job: allOf: @@ -222098,7 +222484,7 @@ x-webhooks: type: string required: - conclusion - deployment: *468 + deployment: *475 required: - action - repository @@ -222177,10 +222563,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 workflow_job: allOf: @@ -222440,7 +222826,7 @@ x-webhooks: required: - status - steps - deployment: *468 + deployment: *475 required: - action - repository @@ -222519,10 +222905,10 @@ x-webhooks: type: string enum: - queued - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 workflow_job: type: object @@ -222657,7 +223043,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *468 + deployment: *475 required: - action - repository @@ -222736,10 +223122,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 workflow_job: type: object @@ -222875,7 +223261,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *468 + deployment: *475 required: - action - repository @@ -222955,12 +223341,12 @@ x-webhooks: type: string enum: - completed - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 - workflow: *718 + workflow: *725 workflow_run: title: Workflow Run type: object @@ -223959,12 +224345,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 - workflow: *718 + workflow: *725 workflow_run: title: Workflow Run type: object @@ -224948,12 +225334,12 @@ x-webhooks: type: string enum: - requested - enterprise: *696 - installation: *697 - organization: *698 - repository: *699 + enterprise: *703 + installation: *704 + organization: *705 + repository: *706 sender: *19 - workflow: *718 + workflow: *725 workflow_run: title: Workflow Run type: object diff --git a/descriptions/ghec/ghec.2022-11-28.json b/descriptions/ghec/ghec.2022-11-28.json index 97abbbf79..8788d8ea1 100644 --- a/descriptions/ghec/ghec.2022-11-28.json +++ b/descriptions/ghec/ghec.2022-11-28.json @@ -5041,7 +5041,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-user-management" @@ -5128,7 +5128,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-metrics" @@ -5215,7 +5215,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-usage" @@ -5585,6 +5585,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", @@ -5653,6 +5677,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", @@ -6257,7 +6645,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-metrics" @@ -6347,7 +6735,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-usage" @@ -13152,6 +13540,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -23032,57 +23423,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "value_type": { - "type": "string", - "example": "single_select", - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property" - }, - "required": { - "type": "boolean", - "description": "Whether the property is required." - }, - "default_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "nullable": true, - "description": "Default value of the property" - }, - "description": { - "type": "string", - "nullable": true, - "description": "Short description of the property" - }, - "allowed_values": { - "type": "array", - "items": { - "type": "string", - "maxLength": 75 - }, - "maxItems": 200, - "nullable": true, - "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": { @@ -23938,7 +24279,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ], "default": "branch" }, @@ -24267,7 +24609,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "enforcement": { @@ -34247,6 +34590,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -73212,6 +73558,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -106099,728 +106448,2177 @@ "value_type" ] }, - "nullable-alert-updated-at": { - "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, - "nullable": true - }, - "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", - "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", - "nullable": true, - "enum": [ - "false_positive", - "wont_fix", - "revoked", - "used_in_tests" - ] - }, - "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": { - "$ref": "#/components/schemas/nullable-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", - "format": "date-time", - "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true - }, - "resolved_by": { - "$ref": "#/components/schemas/nullable-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": { + "value_type": { "type": "string", - "description": "The secret that was detected." - }, - "repository": { - "$ref": "#/components/schemas/simple-repository" + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" }, - "push_protection_bypassed": { + "required": { "type": "boolean", - "description": "Whether push protection was bypassed for the detected secret.", - "nullable": true - }, - "push_protection_bypassed_by": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "push_protection_bypassed_at": { - "type": "string", - "format": "date-time", - "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true + "description": "Whether the property is required." }, - "push_protection_bypass_request_reviewer": { - "$ref": "#/components/schemas/nullable-simple-user" + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" }, - "push_protection_bypass_request_comment": { + "description": { "type": "string", - "description": "An optional comment when requesting a push protection bypass.", - "nullable": true + "nullable": true, + "description": "Short description of the property" }, - "push_protection_bypass_request_html_url": { - "type": "string", - "format": "uri", - "description": "The URL to a push protection bypass request.", - "nullable": true + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "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": "integer", + "nullable": true, + "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." }, - "resolution_comment": { + "actor_type": { "type": "string", - "description": "The comment that was optionally added when this alert was closed", - "nullable": true + "enum": [ + "Integration", + "OrganizationAdmin", + "RepositoryRole", + "Team", + "DeployKey", + "EnterpriseOwner" + ], + "description": "The type of actor that can bypass a ruleset" }, - "validity": { + "bypass_mode": { "type": "string", - "description": "The token status as of the latest validity check.", + "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": [ - "active", - "inactive", - "unknown" - ] - }, - "publicly_leaked": { - "type": "boolean", - "description": "Whether the secret was publicly leaked.", - "nullable": true - }, - "multi_repo": { - "type": "boolean", - "description": "Whether the detected secret was found in multiple repositories in the same organization or enterprise.", - "nullable": true + "always", + "pull_request" + ], + "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", - "example": "2021-11-03" - }, - "last_pushed_email": { - "type": "string", - "example": "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", - "example": "octocat/Hello-World" - }, - "advanced_security_committers": { - "type": "integer", - "example": 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", - "example": 25 - }, - "total_count": { - "type": "integer", - "example": 2 - }, - "maximum_advanced_security_committers": { - "type": "integer", - "example": 4, - "description": "The total number of GitHub Advanced Security licences required if all repositories were to enable GitHub Advanced Security" - }, - "purchased_advanced_security_committers": { - "type": "integer", - "example": 4, - "description": "The total number of GitHub Advanced Security licences purchased" - }, - "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", - "nullable": true - }, - "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" - ] + } }, - "nullable-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", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World/milestones/v1.0" - }, - "labels_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "example": 42 - }, - "state": { - "description": "The state of the milestone.", - "example": "open", + "type": { "type": "string", "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "example": "v1.0", - "type": "string" - }, - "description": { - "type": "string", - "example": "Tracking milestone for version 1.0", - "nullable": true - }, - "creator": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "open_issues": { - "type": "integer", - "example": 4 - }, - "closed_issues": { - "type": "integer", - "example": 8 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2014-03-03T18:58:10Z" - }, - "closed_at": { - "type": "string", - "format": "date-time", - "example": "2013-02-12T13:22:01Z", - "nullable": true - }, - "due_on": { - "type": "string", - "format": "date-time", - "example": "2012-10-09T23:39:01Z", - "nullable": true + "deletion" + ] } - }, + } + }, + "repository-rule-required-linear-history": { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" + "type" ], - "nullable": true + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } + } }, - "nullable-integration": { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "repository-rule-merge-queue": { + "title": "merge_queue", + "description": "Merges must be performed via a merge queue.", "type": "object", - "nullable": true, + "required": [ + "type" + ], "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "example": 37, - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "example": "probot-owners", - "type": "string" - }, - "node_id": { - "type": "string", - "example": "MDExOkludGVncmF0aW9uMQ==" - }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, - "owner": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", - "type": "string" - }, - "description": { - "type": "string", - "example": "The description of the app.", - "nullable": true - }, - "external_url": { - "type": "string", - "format": "uri", - "example": "https://example.com" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/apps/super-ci" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "updated_at": { + "type": { "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" + "enum": [ + "merge_queue" + ] }, - "permissions": { - "description": "The set of permissions for the GitHub app", + "parameters": { "type": "object", "properties": { - "issues": { - "type": "string" + "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 }, - "checks": { - "type": "string" + "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" + ] }, - "metadata": { - "type": "string" + "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 }, - "contents": { - "type": "string" + "max_entries_to_merge": { + "type": "integer", + "description": "The maximum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 }, - "deployments": { - "type": "string" + "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 } }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app", - "example": 5, - "type": "integer" - }, - "client_secret": { - "type": "string", - "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" - }, - "webhook_secret": { - "type": "string", - "example": "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"", - "nullable": true - }, - "pem": { - "type": "string", - "example": "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + "required": [ + "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": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", + "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.\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", + "nullable": true, + "properties": { + "href": { + "type": "string", + "description": "The html URL of the ruleset" + } + } + } + } + }, + "conditions": { + "nullable": true, + "anyOf": [ + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + }, + { + "$ref": "#/components/schemas/org-ruleset-conditions" + } + ] + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-rule" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "nullable-alert-updated-at": { + "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, + "nullable": true + }, + "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", + "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", + "nullable": true, + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests" + ] + }, + "organization-secret-scanning-alert": { + "type": "object", + "properties": { + "number": { + "$ref": "#/components/schemas/alert-number" + }, + "created_at": { + "$ref": "#/components/schemas/alert-created-at" + }, + "updated_at": { + "$ref": "#/components/schemas/nullable-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", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "$ref": "#/components/schemas/nullable-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", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_comment": { + "type": "string", + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true + }, + "resolution_comment": { + "type": "string", + "description": "The comment that was optionally added when this alert was closed", + "nullable": true + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "publicly_leaked": { + "type": "boolean", + "description": "Whether the secret was publicly leaked.", + "nullable": true + }, + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or enterprise.", + "nullable": true + } + } + }, + "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", + "example": "2021-11-03" + }, + "last_pushed_email": { + "type": "string", + "example": "monalisa@github.com" + } + }, + "required": [ + "user_login", + "last_pushed_date", + "last_pushed_email" + ] + }, + "advanced-security-active-committers-repository": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "advanced_security_committers": { + "type": "integer", + "example": 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", + "example": 25 + }, + "total_count": { + "type": "integer", + "example": 2 + }, + "maximum_advanced_security_committers": { + "type": "integer", + "example": 4, + "description": "The total number of GitHub Advanced Security licences required if all repositories were to enable GitHub Advanced Security" + }, + "purchased_advanced_security_committers": { + "type": "integer", + "example": 4, + "description": "The total number of GitHub Advanced Security licences purchased" + }, + "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", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "login", + "gravatar_id", + "url", + "avatar_url" + ] + }, + "nullable-milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + }, + "labels_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + }, + "id": { + "type": "integer", + "example": 1002604 + }, + "node_id": { + "type": "string", + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 + }, + "state": { + "description": "The state of the milestone.", + "example": "open", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" + }, + "description": { + "type": "string", + "example": "Tracking milestone for version 1.0", + "nullable": true + }, + "creator": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "open_issues": { + "type": "integer", + "example": 4 + }, + "closed_issues": { + "type": "integer", + "example": 8 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true + }, + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "nullable-integration": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "example": 5, + "type": "integer" + }, + "client_secret": { + "type": "string", + "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + }, + "webhook_secret": { + "type": "string", + "example": "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"", + "nullable": true + }, + "pem": { + "type": "string", + "example": "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", "created_at", "updated_at", "permissions", @@ -113089,699 +114887,144 @@ } }, "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", - "nullable": true - } - }, - "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", - "example": 1296269 - }, - "repository_name": { - "type": "string", - "example": "Hello-World" - }, - "repository_full_name": { - "type": "string", - "example": "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" - ] - }, - "nullable-repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "$ref": "#/components/schemas/nullable-license-simple" - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "$ref": "#/components/schemas/simple-user" - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 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", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true, - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": true - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": false - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "example": false - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "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)." - }, - "squash_merge_commit_message": { - "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." - }, - "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)." - }, - "merge_commit_message": { - "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." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:42Z\"" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - } - }, - "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_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", + "id", + "node_id", + "number", + "name", + "body", + "state", + "url", + "html_url", + "owner_url", + "creator", + "columns_url", "created_at", "updated_at" - ], - "nullable": true + ] }, - "code-of-conduct-simple": { - "title": "Code Of Conduct Simple", - "description": "Code of Conduct Simple", + "custom-property-value": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", "type": "object", "properties": { - "url": { + "property_name": { "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/github/docs/community/code_of_conduct" + "description": "The name of the property" }, - "key": { - "type": "string", - "example": "citizen_code_of_conduct" + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The value assigned to the property", + "nullable": true + } + }, + "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", + "example": 1296269 }, - "name": { + "repository_name": { "type": "string", - "example": "Citizen Code of Conduct" + "example": "Hello-World" }, - "html_url": { + "repository_full_name": { "type": "string", - "nullable": true, - "format": "uri", - "example": "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" + "example": "octocat/Hello-World" + }, + "properties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-property-value" + }, + "description": "List of custom property names and associated values" } }, "required": [ - "url", - "key", - "name", - "html_url" + "repository_id", + "repository_name", + "repository_full_name", + "properties" ] }, - "full-repository": { - "title": "Full Repository", - "description": "Full Repository", + "nullable-repository": { + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { "id": { + "description": "Unique identifier of the repository", + "example": 42, "type": "integer", - "format": "int64", - "example": 1296269 + "format": "int64" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { + "description": "The name of the repository.", "type": "string", - "example": "Hello-World" + "example": "Team Environment" }, "full_name": { "type": "string", "example": "octocat/Hello-World" }, + "license": { + "$ref": "#/components/schemas/nullable-license-simple" + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, "owner": { "$ref": "#/components/schemas/simple-user" }, "private": { + "description": "Whether the repository is private or public.", + "default": false, "type": "boolean" }, "html_url": { @@ -114010,6 +115253,7 @@ "example": 108 }, "default_branch": { + "description": "The default branch of the repository.", "type": "string", "example": "master" }, @@ -114018,6 +115262,8 @@ "example": 0 }, "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, "type": "boolean", "example": true }, @@ -114025,23 +115271,23 @@ "type": "array", "items": { "type": "string" - }, - "example": [ - "octocat", - "atom", - "electron", - "API" - ] + } }, "has_issues": { + "description": "Whether issues are enabled.", + "default": true, "type": "boolean", "example": true }, "has_projects": { + "description": "Whether projects are enabled.", + "default": true, "type": "boolean", "example": true }, "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, "type": "boolean", "example": true }, @@ -114049,14 +115295,21 @@ "type": "boolean" }, "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, "type": "boolean", - "example": true + "example": true, + "deprecated": true }, "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, "type": "boolean", "example": true }, "archived": { + "description": "Whether the repository is archived.", + "default": false, "type": "boolean" }, "disabled": { @@ -114065,87 +115318,68 @@ }, "visibility": { "description": "The repository visibility: public, private, or internal.", - "type": "string", - "example": "public" + "default": "public", + "type": "string" }, "pushed_at": { "type": "string", "format": "date-time", - "example": "2011-01-26T19:06:43Z" + "example": "2011-01-26T19:06:43Z", + "nullable": true }, "created_at": { "type": "string", "format": "date-time", - "example": "2011-01-26T19:01:12Z" + "example": "2011-01-26T19:01:12Z", + "nullable": true }, "updated_at": { "type": "string", "format": "date-time", - "example": "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" - ] + "example": "2011-01-26T19:14:43Z", + "nullable": true }, "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, "type": "boolean", "example": true }, - "template_repository": { - "$ref": "#/components/schemas/nullable-repository" - }, "temp_clone_token": { - "type": "string", - "nullable": true + "type": "string" }, "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, "type": "boolean", "example": true }, "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, "type": "boolean", "example": false }, "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, "type": "boolean", "example": false }, - "allow_merge_commit": { - "type": "boolean", - "example": true - }, "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, "type": "boolean", - "example": true + "example": false }, "use_squash_pr_title_as_default": { "type": "boolean", - "example": false + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true }, "squash_merge_commit_title": { "type": "string", - "example": "PR_TITLE", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" @@ -114154,7 +115388,6 @@ }, "squash_merge_commit_message": { "type": "string", - "example": "PR_BODY", "enum": [ "PR_BODY", "COMMIT_MESSAGES", @@ -114164,16 +115397,14 @@ }, "merge_commit_title": { "type": "string", - "example": "PR_TITLE", "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)." + "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)." }, "merge_commit_message": { "type": "string", - "example": "PR_BODY", "enum": [ "PR_BODY", "PR_TITLE", @@ -114181,39 +115412,20 @@ ], "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." }, - "allow_forking": { + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, "type": "boolean", "example": true }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "subscribers_count": { - "type": "integer", - "example": 42 - }, - "network_count": { - "type": "integer", - "example": 0 - }, - "license": { - "$ref": "#/components/schemas/nullable-license-simple" - }, - "organization": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "parent": { - "$ref": "#/components/schemas/repository" - }, - "source": { - "$ref": "#/components/schemas/repository" - }, - "forks": { - "type": "integer" + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" }, - "master_branch": { - "type": "string" + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" }, "open_issues": { "type": "integer" @@ -114221,21 +115433,16 @@ "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" + "master_branch": { + "type": "string" }, - "security_and_analysis": { - "$ref": "#/components/schemas/security-and-analysis" + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" }, - "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 + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -114290,1289 +115497,622 @@ "forks", "forks_count", "git_url", + "has_downloads", "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" - ] - }, - "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", - "nullable": true, - "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.\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" - } - ] - }, - { - "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" - ] - } - } + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ], + "nullable": true }, - "repository-rule-branch-name-pattern": { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", + "code-of-conduct-simple": { + "title": "Code Of Conduct Simple", + "description": "Code of Conduct Simple", "type": "object", - "required": [ - "type" - ], "properties": { - "type": { + "url": { "type": "string", - "enum": [ - "branch_name_pattern" - ] + "format": "uri", + "example": "https://api.github.com/repos/github/docs/community/code_of_conduct" }, - "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": { + "key": { "type": "string", - "enum": [ - "tag_name_pattern" - ] + "example": "citizen_code_of_conduct" }, - "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": { + "name": { "type": "string", - "description": "Full or abbreviated commit hash to reject" + "example": "Citizen Code of Conduct" }, - "reason": { + "html_url": { "type": "string", - "description": "Reason for restriction" + "nullable": true, + "format": "uri", + "example": "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" } }, "required": [ - "oid" + "url", + "key", + "name", + "html_url" ] }, - "repository-rule-params-workflow-file-reference": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", + "full-repository": { + "title": "Full Repository", + "description": "Full Repository", "type": "object", "properties": { - "path": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269 + }, + "node_id": { "type": "string", - "description": "The path to the workflow file" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "ref": { + "name": { "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" + "example": "Hello-World" }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" + "full_name": { + "type": "string", + "example": "octocat/Hello-World" }, - "sha": { + "owner": { + "$ref": "#/components/schemas/simple-user" + }, + "private": { + "type": "boolean" + }, + "html_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": { + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { "type": "string", - "enum": [ - "workflows" - ] + "example": "This your first repo!", + "nullable": true }, - "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": { + "fork": { + "type": "boolean" + }, + "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", + "example": "https://api.github.com/repos/octocat/Hello-World" }, - "security_alerts_threshold": { + "archive_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" - ] + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, - "tool": { + "assignees_url": { "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": { + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { "type": "string", - "enum": [ - "code_scanning" - ] + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, - "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" + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, - { - "$ref": "#/components/schemas/repository-rule-update" + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, - { - "$ref": "#/components/schemas/repository-rule-deletion" + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, - { - "$ref": "#/components/schemas/repository-rule-required-linear-history" + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, - { - "$ref": "#/components/schemas/repository-rule-merge-queue" + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, - { - "$ref": "#/components/schemas/repository-rule-required-deployments" + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, - { - "$ref": "#/components/schemas/repository-rule-required-signatures" + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, - { - "$ref": "#/components/schemas/repository-rule-pull-request" + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, - { - "$ref": "#/components/schemas/repository-rule-required-status-checks" + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, - { - "$ref": "#/components/schemas/repository-rule-non-fast-forward" + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" }, - { - "$ref": "#/components/schemas/repository-rule-commit-message-pattern" + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, - { - "$ref": "#/components/schemas/repository-rule-commit-author-email-pattern" + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, - { - "$ref": "#/components/schemas/repository-rule-committer-email-pattern" + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, - { - "$ref": "#/components/schemas/repository-rule-branch-name-pattern" + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, - { - "$ref": "#/components/schemas/repository-rule-tag-name-pattern" + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" }, - { - "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" - ] - } - } + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, - { - "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" - ] - } - } + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, - { - "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" - ] - } - } + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, - { - "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" - ] - } - } + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, - { - "$ref": "#/components/schemas/repository-rule-workflows" + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, - { - "$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" + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, - "name": { + "merges_url": { "type": "string", - "description": "The name of the ruleset" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, - "target": { + "milestones_url": { "type": "string", - "description": "The target of the ruleset", - "enum": [ - "branch", - "tag", - "push" - ] + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, - "source_type": { + "notifications_url": { "type": "string", - "description": "The type of the source of the ruleset", - "enum": [ - "Repository", - "Organization" - ] + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, - "source": { + "pulls_url": { "type": "string", - "description": "The name of the source" + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, - "enforcement": { - "$ref": "#/components/schemas/repository-rule-enforcement" + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, - "bypass_actors": { + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 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", + "example": 108 + }, + "default_branch": { + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "type": "boolean", + "example": true + }, + "topics": { "type": "array", - "description": "The actors that can bypass the rules in this ruleset", "items": { - "$ref": "#/components/schemas/repository-ruleset-bypass-actor" - } + "type": "string" + }, + "example": [ + "octocat", + "atom", + "electron", + "API" + ] }, - "current_user_can_bypass": { + "has_issues": { + "type": "boolean", + "example": true + }, + "has_projects": { + "type": "boolean", + "example": true + }, + "has_wiki": { + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean", + "example": true + }, + "has_discussions": { + "type": "boolean", + "example": 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", - "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" - ] + "example": "public" }, - "node_id": { - "type": "string" + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z" }, - "_links": { + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z" + }, + "permissions": { "type": "object", "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The URL of the ruleset" - } - } + "admin": { + "type": "boolean" }, - "html": { - "type": "object", - "nullable": true, - "properties": { - "href": { - "type": "string", - "description": "The html URL of the ruleset" - } - } - } - } - }, - "conditions": { - "nullable": true, - "anyOf": [ - { - "$ref": "#/components/schemas/repository-ruleset-conditions" + "maintain": { + "type": "boolean" }, - { - "$ref": "#/components/schemas/org-ruleset-conditions" + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" } + }, + "required": [ + "admin", + "pull", + "push" ] }, - "rules": { - "type": "array", - "items": { - "$ref": "#/components/schemas/repository-rule" - } + "allow_rebase_merge": { + "type": "boolean", + "example": true }, - "created_at": { + "template_repository": { + "$ref": "#/components/schemas/nullable-repository" + }, + "temp_clone_token": { "type": "string", - "format": "date-time" + "nullable": true }, - "updated_at": { + "allow_squash_merge": { + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "type": "boolean", + "example": true + }, + "allow_update_branch": { + "type": "boolean", + "example": true + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "example": false + }, + "squash_merge_commit_title": { "type": "string", - "format": "date-time" + "example": "PR_TITLE", + "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)." + }, + "squash_merge_commit_message": { + "type": "string", + "example": "PR_BODY", + "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." + }, + "merge_commit_title": { + "type": "string", + "example": "PR_TITLE", + "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)." + }, + "merge_commit_message": { + "type": "string", + "example": "PR_BODY", + "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." + }, + "allow_forking": { + "type": "boolean", + "example": true + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "subscribers_count": { + "type": "integer", + "example": 42 + }, + "network_count": { + "type": "integer", + "example": 0 + }, + "license": { + "$ref": "#/components/schemas/nullable-license-simple" + }, + "organization": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "parent": { + "$ref": "#/components/schemas/repository" + }, + "source": { + "$ref": "#/components/schemas/repository" + }, + "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", @@ -117655,6 +118195,9 @@ }, "dependency_snapshots": { "$ref": "#/components/schemas/rate-limit" + }, + "code_scanning_autofix": { + "$ref": "#/components/schemas/rate-limit" } }, "required": [ @@ -130256,6 +130799,11 @@ "push_protection_bypass_request_reviewer": { "$ref": "#/components/schemas/nullable-simple-user" }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -136173,6 +136721,11 @@ "dismissed" ] }, + "reviewer_comment": { + "type": "string", + "description": "The comment the reviewer provided when responding to the exemption request.", + "nullable": true + }, "created_at": { "type": "string", "format": "date-time", @@ -147907,6 +148460,11 @@ "push_protection_bypass_request_reviewer": { "$ref": "#/components/schemas/nullable-simple-user" }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -278686,6 +279244,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": [ { @@ -278829,6 +279425,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", @@ -278920,6 +279517,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, @@ -286337,6 +286935,12 @@ "used": 0, "remaining": 10, "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 } }, "rate": { @@ -299102,6 +299706,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", @@ -299126,6 +299731,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, @@ -299153,6 +299759,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, @@ -299198,6 +299805,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/ghec/ghec.2022-11-28.yaml b/descriptions/ghec/ghec.2022-11-28.yaml index 591a09428..fdb6e886a 100644 --- a/descriptions/ghec/ghec.2022-11-28.yaml +++ b/descriptions/ghec/ghec.2022-11-28.yaml @@ -3565,7 +3565,7 @@ paths: '404': "$ref": "#/components/responses/not_found" x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-user-management @@ -3636,7 +3636,7 @@ paths: '422': "$ref": "#/components/responses/usage_metrics_api_disabled" x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-metrics @@ -3713,7 +3713,7 @@ paths: '404': "$ref": "#/components/responses/not_found" x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-usage @@ -3972,6 +3972,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 @@ -4021,6 +4037,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 @@ -4448,7 +4707,7 @@ paths: '422': "$ref": "#/components/responses/usage_metrics_api_disabled" x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-metrics @@ -4527,7 +4786,7 @@ paths: '404': "$ref": "#/components/responses/not_found" x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-usage @@ -9551,6 +9810,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" @@ -16736,44 +16997,7 @@ paths: content: application/json: schema: - type: object - properties: - value_type: - type: string - example: single_select - enum: - - string - - single_select - - multi_select - - true_false - description: The type of the value for the property - required: - type: boolean - description: Whether the property is required. - default_value: - oneOf: - - type: string - - type: array - items: - type: string - nullable: true - description: Default value of the property - description: - type: string - nullable: true - description: Short description of the property - allowed_values: - type: array - items: - type: string - maxLength: 75 - maxItems: 200 - nullable: true - 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: @@ -17444,6 +17668,7 @@ paths: - branch - tag - push + - repository default: branch enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" @@ -17660,6 +17885,7 @@ paths: - branch - tag - push + - repository enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" bypass_actors: @@ -24817,6 +25043,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" @@ -53149,6 +53377,8 @@ paths: "$ref": "#/components/schemas/sigstore-bundle-0" repository_id: type: integer + bundle_url: + type: string examples: default: value: @@ -77279,6 +77509,1073 @@ 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 + example: single_select + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + nullable: true + description: Default value of the property + description: + type: string + nullable: true + description: Short description of the property + allowed_values: + type: array + items: + type: string + maxLength: 75 + maxItems: 200 + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + href: + type: string + description: The html URL of the ruleset + conditions: + nullable: true + anyOf: + - "$ref": "#/components/schemas/repository-ruleset-conditions" + - "$ref": "#/components/schemas/org-ruleset-conditions" + rules: + type: array + items: + "$ref": "#/components/schemas/repository-rule" + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time nullable-alert-updated-at: type: string description: 'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -77357,6 +78654,10 @@ components: nullable: true push_protection_bypass_request_reviewer: "$ref": "#/components/schemas/nullable-simple-user" + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection bypass. + nullable: true push_protection_bypass_request_comment: type: string description: An optional comment when requesting a push protection bypass. @@ -83785,945 +85086,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 - nullable: true - 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 - nullable: true - properties: - href: - type: string - description: The html URL of the ruleset - conditions: - nullable: true - anyOf: - - "$ref": "#/components/schemas/repository-ruleset-conditions" - - "$ref": "#/components/schemas/org-ruleset-conditions" - 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 @@ -86376,6 +86738,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 @@ -95929,6 +96293,10 @@ components: nullable: true push_protection_bypass_request_reviewer: "$ref": "#/components/schemas/nullable-simple-user" + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection bypass. + nullable: true push_protection_bypass_request_comment: type: string description: An optional comment when requesting a push protection bypass. @@ -100465,6 +100833,11 @@ components: - approved - rejected - dismissed + reviewer_comment: + type: string + description: The comment the reviewer provided when responding to the exemption + request. + nullable: true created_at: type: string format: date-time @@ -109409,6 +109782,10 @@ components: nullable: true push_protection_bypass_request_reviewer: "$ref": "#/components/schemas/nullable-simple-user" + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection bypass. + nullable: true push_protection_bypass_request_comment: type: string description: An optional comment when requesting a push protection bypass. @@ -208474,6 +208851,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 @@ -208611,6 +209013,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 @@ -208698,6 +209101,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: @@ -215119,6 +215523,11 @@ components: used: 0 remaining: 10 reset: 1691591091 + code_scanning_autofix: + limit: 10 + used: 0 + remaining: 10 + reset: 1691591091 rate: limit: 5000 used: 1 @@ -226069,6 +226478,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 @@ -226091,6 +226501,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: @@ -226115,6 +226526,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: @@ -226157,6 +226569,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/ghec/ghec.json b/descriptions/ghec/ghec.json index 97abbbf79..8788d8ea1 100644 --- a/descriptions/ghec/ghec.json +++ b/descriptions/ghec/ghec.json @@ -5041,7 +5041,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-user-management" @@ -5128,7 +5128,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-metrics" @@ -5215,7 +5215,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-usage" @@ -5585,6 +5585,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", @@ -5653,6 +5677,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", @@ -6257,7 +6645,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-metrics" @@ -6347,7 +6735,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-usage" @@ -13152,6 +13540,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -23032,57 +23423,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "value_type": { - "type": "string", - "example": "single_select", - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property" - }, - "required": { - "type": "boolean", - "description": "Whether the property is required." - }, - "default_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "nullable": true, - "description": "Default value of the property" - }, - "description": { - "type": "string", - "nullable": true, - "description": "Short description of the property" - }, - "allowed_values": { - "type": "array", - "items": { - "type": "string", - "maxLength": 75 - }, - "maxItems": 200, - "nullable": true, - "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": { @@ -23938,7 +24279,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ], "default": "branch" }, @@ -24267,7 +24609,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "enforcement": { @@ -34247,6 +34590,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -73212,6 +73558,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -106099,728 +106448,2177 @@ "value_type" ] }, - "nullable-alert-updated-at": { - "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, - "nullable": true - }, - "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", - "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", - "nullable": true, - "enum": [ - "false_positive", - "wont_fix", - "revoked", - "used_in_tests" - ] - }, - "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": { - "$ref": "#/components/schemas/nullable-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", - "format": "date-time", - "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true - }, - "resolved_by": { - "$ref": "#/components/schemas/nullable-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": { + "value_type": { "type": "string", - "description": "The secret that was detected." - }, - "repository": { - "$ref": "#/components/schemas/simple-repository" + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" }, - "push_protection_bypassed": { + "required": { "type": "boolean", - "description": "Whether push protection was bypassed for the detected secret.", - "nullable": true - }, - "push_protection_bypassed_by": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "push_protection_bypassed_at": { - "type": "string", - "format": "date-time", - "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true + "description": "Whether the property is required." }, - "push_protection_bypass_request_reviewer": { - "$ref": "#/components/schemas/nullable-simple-user" + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" }, - "push_protection_bypass_request_comment": { + "description": { "type": "string", - "description": "An optional comment when requesting a push protection bypass.", - "nullable": true + "nullable": true, + "description": "Short description of the property" }, - "push_protection_bypass_request_html_url": { - "type": "string", - "format": "uri", - "description": "The URL to a push protection bypass request.", - "nullable": true + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "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": "integer", + "nullable": true, + "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." }, - "resolution_comment": { + "actor_type": { "type": "string", - "description": "The comment that was optionally added when this alert was closed", - "nullable": true + "enum": [ + "Integration", + "OrganizationAdmin", + "RepositoryRole", + "Team", + "DeployKey", + "EnterpriseOwner" + ], + "description": "The type of actor that can bypass a ruleset" }, - "validity": { + "bypass_mode": { "type": "string", - "description": "The token status as of the latest validity check.", + "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": [ - "active", - "inactive", - "unknown" - ] - }, - "publicly_leaked": { - "type": "boolean", - "description": "Whether the secret was publicly leaked.", - "nullable": true - }, - "multi_repo": { - "type": "boolean", - "description": "Whether the detected secret was found in multiple repositories in the same organization or enterprise.", - "nullable": true + "always", + "pull_request" + ], + "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", - "example": "2021-11-03" - }, - "last_pushed_email": { - "type": "string", - "example": "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", - "example": "octocat/Hello-World" - }, - "advanced_security_committers": { - "type": "integer", - "example": 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", - "example": 25 - }, - "total_count": { - "type": "integer", - "example": 2 - }, - "maximum_advanced_security_committers": { - "type": "integer", - "example": 4, - "description": "The total number of GitHub Advanced Security licences required if all repositories were to enable GitHub Advanced Security" - }, - "purchased_advanced_security_committers": { - "type": "integer", - "example": 4, - "description": "The total number of GitHub Advanced Security licences purchased" - }, - "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", - "nullable": true - }, - "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" - ] + } }, - "nullable-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", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World/milestones/v1.0" - }, - "labels_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "example": 42 - }, - "state": { - "description": "The state of the milestone.", - "example": "open", + "type": { "type": "string", "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "example": "v1.0", - "type": "string" - }, - "description": { - "type": "string", - "example": "Tracking milestone for version 1.0", - "nullable": true - }, - "creator": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "open_issues": { - "type": "integer", - "example": 4 - }, - "closed_issues": { - "type": "integer", - "example": 8 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2014-03-03T18:58:10Z" - }, - "closed_at": { - "type": "string", - "format": "date-time", - "example": "2013-02-12T13:22:01Z", - "nullable": true - }, - "due_on": { - "type": "string", - "format": "date-time", - "example": "2012-10-09T23:39:01Z", - "nullable": true + "deletion" + ] } - }, + } + }, + "repository-rule-required-linear-history": { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" + "type" ], - "nullable": true + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } + } }, - "nullable-integration": { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "repository-rule-merge-queue": { + "title": "merge_queue", + "description": "Merges must be performed via a merge queue.", "type": "object", - "nullable": true, + "required": [ + "type" + ], "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "example": 37, - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "example": "probot-owners", - "type": "string" - }, - "node_id": { - "type": "string", - "example": "MDExOkludGVncmF0aW9uMQ==" - }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, - "owner": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", - "type": "string" - }, - "description": { - "type": "string", - "example": "The description of the app.", - "nullable": true - }, - "external_url": { - "type": "string", - "format": "uri", - "example": "https://example.com" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/apps/super-ci" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "updated_at": { + "type": { "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" + "enum": [ + "merge_queue" + ] }, - "permissions": { - "description": "The set of permissions for the GitHub app", + "parameters": { "type": "object", "properties": { - "issues": { - "type": "string" + "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 }, - "checks": { - "type": "string" + "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" + ] }, - "metadata": { - "type": "string" + "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 }, - "contents": { - "type": "string" + "max_entries_to_merge": { + "type": "integer", + "description": "The maximum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 }, - "deployments": { - "type": "string" + "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 } }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app", - "example": 5, - "type": "integer" - }, - "client_secret": { - "type": "string", - "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" - }, - "webhook_secret": { - "type": "string", - "example": "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"", - "nullable": true - }, - "pem": { - "type": "string", - "example": "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + "required": [ + "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": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", + "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.\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", + "nullable": true, + "properties": { + "href": { + "type": "string", + "description": "The html URL of the ruleset" + } + } + } + } + }, + "conditions": { + "nullable": true, + "anyOf": [ + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + }, + { + "$ref": "#/components/schemas/org-ruleset-conditions" + } + ] + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-rule" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "nullable-alert-updated-at": { + "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, + "nullable": true + }, + "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", + "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", + "nullable": true, + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests" + ] + }, + "organization-secret-scanning-alert": { + "type": "object", + "properties": { + "number": { + "$ref": "#/components/schemas/alert-number" + }, + "created_at": { + "$ref": "#/components/schemas/alert-created-at" + }, + "updated_at": { + "$ref": "#/components/schemas/nullable-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", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "$ref": "#/components/schemas/nullable-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", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_comment": { + "type": "string", + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true + }, + "resolution_comment": { + "type": "string", + "description": "The comment that was optionally added when this alert was closed", + "nullable": true + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "publicly_leaked": { + "type": "boolean", + "description": "Whether the secret was publicly leaked.", + "nullable": true + }, + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or enterprise.", + "nullable": true + } + } + }, + "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", + "example": "2021-11-03" + }, + "last_pushed_email": { + "type": "string", + "example": "monalisa@github.com" + } + }, + "required": [ + "user_login", + "last_pushed_date", + "last_pushed_email" + ] + }, + "advanced-security-active-committers-repository": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "advanced_security_committers": { + "type": "integer", + "example": 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", + "example": 25 + }, + "total_count": { + "type": "integer", + "example": 2 + }, + "maximum_advanced_security_committers": { + "type": "integer", + "example": 4, + "description": "The total number of GitHub Advanced Security licences required if all repositories were to enable GitHub Advanced Security" + }, + "purchased_advanced_security_committers": { + "type": "integer", + "example": 4, + "description": "The total number of GitHub Advanced Security licences purchased" + }, + "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", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "login", + "gravatar_id", + "url", + "avatar_url" + ] + }, + "nullable-milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + }, + "labels_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + }, + "id": { + "type": "integer", + "example": 1002604 + }, + "node_id": { + "type": "string", + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 + }, + "state": { + "description": "The state of the milestone.", + "example": "open", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" + }, + "description": { + "type": "string", + "example": "Tracking milestone for version 1.0", + "nullable": true + }, + "creator": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "open_issues": { + "type": "integer", + "example": 4 + }, + "closed_issues": { + "type": "integer", + "example": 8 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true + }, + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "nullable-integration": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "example": 5, + "type": "integer" + }, + "client_secret": { + "type": "string", + "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + }, + "webhook_secret": { + "type": "string", + "example": "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"", + "nullable": true + }, + "pem": { + "type": "string", + "example": "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", "created_at", "updated_at", "permissions", @@ -113089,699 +114887,144 @@ } }, "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", - "nullable": true - } - }, - "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", - "example": 1296269 - }, - "repository_name": { - "type": "string", - "example": "Hello-World" - }, - "repository_full_name": { - "type": "string", - "example": "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" - ] - }, - "nullable-repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "$ref": "#/components/schemas/nullable-license-simple" - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "$ref": "#/components/schemas/simple-user" - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 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", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true, - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": true - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": false - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "example": false - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "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)." - }, - "squash_merge_commit_message": { - "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." - }, - "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)." - }, - "merge_commit_message": { - "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." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:42Z\"" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - } - }, - "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_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", + "id", + "node_id", + "number", + "name", + "body", + "state", + "url", + "html_url", + "owner_url", + "creator", + "columns_url", "created_at", "updated_at" - ], - "nullable": true + ] }, - "code-of-conduct-simple": { - "title": "Code Of Conduct Simple", - "description": "Code of Conduct Simple", + "custom-property-value": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", "type": "object", "properties": { - "url": { + "property_name": { "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/github/docs/community/code_of_conduct" + "description": "The name of the property" }, - "key": { - "type": "string", - "example": "citizen_code_of_conduct" + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The value assigned to the property", + "nullable": true + } + }, + "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", + "example": 1296269 }, - "name": { + "repository_name": { "type": "string", - "example": "Citizen Code of Conduct" + "example": "Hello-World" }, - "html_url": { + "repository_full_name": { "type": "string", - "nullable": true, - "format": "uri", - "example": "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" + "example": "octocat/Hello-World" + }, + "properties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-property-value" + }, + "description": "List of custom property names and associated values" } }, "required": [ - "url", - "key", - "name", - "html_url" + "repository_id", + "repository_name", + "repository_full_name", + "properties" ] }, - "full-repository": { - "title": "Full Repository", - "description": "Full Repository", + "nullable-repository": { + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { "id": { + "description": "Unique identifier of the repository", + "example": 42, "type": "integer", - "format": "int64", - "example": 1296269 + "format": "int64" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { + "description": "The name of the repository.", "type": "string", - "example": "Hello-World" + "example": "Team Environment" }, "full_name": { "type": "string", "example": "octocat/Hello-World" }, + "license": { + "$ref": "#/components/schemas/nullable-license-simple" + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, "owner": { "$ref": "#/components/schemas/simple-user" }, "private": { + "description": "Whether the repository is private or public.", + "default": false, "type": "boolean" }, "html_url": { @@ -114010,6 +115253,7 @@ "example": 108 }, "default_branch": { + "description": "The default branch of the repository.", "type": "string", "example": "master" }, @@ -114018,6 +115262,8 @@ "example": 0 }, "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, "type": "boolean", "example": true }, @@ -114025,23 +115271,23 @@ "type": "array", "items": { "type": "string" - }, - "example": [ - "octocat", - "atom", - "electron", - "API" - ] + } }, "has_issues": { + "description": "Whether issues are enabled.", + "default": true, "type": "boolean", "example": true }, "has_projects": { + "description": "Whether projects are enabled.", + "default": true, "type": "boolean", "example": true }, "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, "type": "boolean", "example": true }, @@ -114049,14 +115295,21 @@ "type": "boolean" }, "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, "type": "boolean", - "example": true + "example": true, + "deprecated": true }, "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, "type": "boolean", "example": true }, "archived": { + "description": "Whether the repository is archived.", + "default": false, "type": "boolean" }, "disabled": { @@ -114065,87 +115318,68 @@ }, "visibility": { "description": "The repository visibility: public, private, or internal.", - "type": "string", - "example": "public" + "default": "public", + "type": "string" }, "pushed_at": { "type": "string", "format": "date-time", - "example": "2011-01-26T19:06:43Z" + "example": "2011-01-26T19:06:43Z", + "nullable": true }, "created_at": { "type": "string", "format": "date-time", - "example": "2011-01-26T19:01:12Z" + "example": "2011-01-26T19:01:12Z", + "nullable": true }, "updated_at": { "type": "string", "format": "date-time", - "example": "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" - ] + "example": "2011-01-26T19:14:43Z", + "nullable": true }, "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, "type": "boolean", "example": true }, - "template_repository": { - "$ref": "#/components/schemas/nullable-repository" - }, "temp_clone_token": { - "type": "string", - "nullable": true + "type": "string" }, "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, "type": "boolean", "example": true }, "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, "type": "boolean", "example": false }, "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, "type": "boolean", "example": false }, - "allow_merge_commit": { - "type": "boolean", - "example": true - }, "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, "type": "boolean", - "example": true + "example": false }, "use_squash_pr_title_as_default": { "type": "boolean", - "example": false + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true }, "squash_merge_commit_title": { "type": "string", - "example": "PR_TITLE", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" @@ -114154,7 +115388,6 @@ }, "squash_merge_commit_message": { "type": "string", - "example": "PR_BODY", "enum": [ "PR_BODY", "COMMIT_MESSAGES", @@ -114164,16 +115397,14 @@ }, "merge_commit_title": { "type": "string", - "example": "PR_TITLE", "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)." + "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)." }, "merge_commit_message": { "type": "string", - "example": "PR_BODY", "enum": [ "PR_BODY", "PR_TITLE", @@ -114181,39 +115412,20 @@ ], "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." }, - "allow_forking": { + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, "type": "boolean", "example": true }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "subscribers_count": { - "type": "integer", - "example": 42 - }, - "network_count": { - "type": "integer", - "example": 0 - }, - "license": { - "$ref": "#/components/schemas/nullable-license-simple" - }, - "organization": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "parent": { - "$ref": "#/components/schemas/repository" - }, - "source": { - "$ref": "#/components/schemas/repository" - }, - "forks": { - "type": "integer" + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" }, - "master_branch": { - "type": "string" + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" }, "open_issues": { "type": "integer" @@ -114221,21 +115433,16 @@ "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" + "master_branch": { + "type": "string" }, - "security_and_analysis": { - "$ref": "#/components/schemas/security-and-analysis" + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" }, - "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 + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -114290,1289 +115497,622 @@ "forks", "forks_count", "git_url", + "has_downloads", "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" - ] - }, - "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", - "nullable": true, - "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.\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" - } - ] - }, - { - "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" - ] - } - } + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ], + "nullable": true }, - "repository-rule-branch-name-pattern": { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", + "code-of-conduct-simple": { + "title": "Code Of Conduct Simple", + "description": "Code of Conduct Simple", "type": "object", - "required": [ - "type" - ], "properties": { - "type": { + "url": { "type": "string", - "enum": [ - "branch_name_pattern" - ] + "format": "uri", + "example": "https://api.github.com/repos/github/docs/community/code_of_conduct" }, - "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": { + "key": { "type": "string", - "enum": [ - "tag_name_pattern" - ] + "example": "citizen_code_of_conduct" }, - "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": { + "name": { "type": "string", - "description": "Full or abbreviated commit hash to reject" + "example": "Citizen Code of Conduct" }, - "reason": { + "html_url": { "type": "string", - "description": "Reason for restriction" + "nullable": true, + "format": "uri", + "example": "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" } }, "required": [ - "oid" + "url", + "key", + "name", + "html_url" ] }, - "repository-rule-params-workflow-file-reference": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", + "full-repository": { + "title": "Full Repository", + "description": "Full Repository", "type": "object", "properties": { - "path": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269 + }, + "node_id": { "type": "string", - "description": "The path to the workflow file" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "ref": { + "name": { "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" + "example": "Hello-World" }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" + "full_name": { + "type": "string", + "example": "octocat/Hello-World" }, - "sha": { + "owner": { + "$ref": "#/components/schemas/simple-user" + }, + "private": { + "type": "boolean" + }, + "html_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": { + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { "type": "string", - "enum": [ - "workflows" - ] + "example": "This your first repo!", + "nullable": true }, - "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": { + "fork": { + "type": "boolean" + }, + "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", + "example": "https://api.github.com/repos/octocat/Hello-World" }, - "security_alerts_threshold": { + "archive_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" - ] + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, - "tool": { + "assignees_url": { "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": { + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { "type": "string", - "enum": [ - "code_scanning" - ] + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, - "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" + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, - { - "$ref": "#/components/schemas/repository-rule-update" + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, - { - "$ref": "#/components/schemas/repository-rule-deletion" + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, - { - "$ref": "#/components/schemas/repository-rule-required-linear-history" + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, - { - "$ref": "#/components/schemas/repository-rule-merge-queue" + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, - { - "$ref": "#/components/schemas/repository-rule-required-deployments" + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, - { - "$ref": "#/components/schemas/repository-rule-required-signatures" + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, - { - "$ref": "#/components/schemas/repository-rule-pull-request" + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, - { - "$ref": "#/components/schemas/repository-rule-required-status-checks" + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, - { - "$ref": "#/components/schemas/repository-rule-non-fast-forward" + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" }, - { - "$ref": "#/components/schemas/repository-rule-commit-message-pattern" + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, - { - "$ref": "#/components/schemas/repository-rule-commit-author-email-pattern" + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, - { - "$ref": "#/components/schemas/repository-rule-committer-email-pattern" + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, - { - "$ref": "#/components/schemas/repository-rule-branch-name-pattern" + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, - { - "$ref": "#/components/schemas/repository-rule-tag-name-pattern" + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" }, - { - "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" - ] - } - } + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, - { - "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" - ] - } - } + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, - { - "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" - ] - } - } + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, - { - "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" - ] - } - } + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, - { - "$ref": "#/components/schemas/repository-rule-workflows" + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, - { - "$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" + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, - "name": { + "merges_url": { "type": "string", - "description": "The name of the ruleset" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, - "target": { + "milestones_url": { "type": "string", - "description": "The target of the ruleset", - "enum": [ - "branch", - "tag", - "push" - ] + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, - "source_type": { + "notifications_url": { "type": "string", - "description": "The type of the source of the ruleset", - "enum": [ - "Repository", - "Organization" - ] + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, - "source": { + "pulls_url": { "type": "string", - "description": "The name of the source" + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, - "enforcement": { - "$ref": "#/components/schemas/repository-rule-enforcement" + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, - "bypass_actors": { + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 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", + "example": 108 + }, + "default_branch": { + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "type": "boolean", + "example": true + }, + "topics": { "type": "array", - "description": "The actors that can bypass the rules in this ruleset", "items": { - "$ref": "#/components/schemas/repository-ruleset-bypass-actor" - } + "type": "string" + }, + "example": [ + "octocat", + "atom", + "electron", + "API" + ] }, - "current_user_can_bypass": { + "has_issues": { + "type": "boolean", + "example": true + }, + "has_projects": { + "type": "boolean", + "example": true + }, + "has_wiki": { + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean", + "example": true + }, + "has_discussions": { + "type": "boolean", + "example": 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", - "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" - ] + "example": "public" }, - "node_id": { - "type": "string" + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z" }, - "_links": { + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z" + }, + "permissions": { "type": "object", "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The URL of the ruleset" - } - } + "admin": { + "type": "boolean" }, - "html": { - "type": "object", - "nullable": true, - "properties": { - "href": { - "type": "string", - "description": "The html URL of the ruleset" - } - } - } - } - }, - "conditions": { - "nullable": true, - "anyOf": [ - { - "$ref": "#/components/schemas/repository-ruleset-conditions" + "maintain": { + "type": "boolean" }, - { - "$ref": "#/components/schemas/org-ruleset-conditions" + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" } + }, + "required": [ + "admin", + "pull", + "push" ] }, - "rules": { - "type": "array", - "items": { - "$ref": "#/components/schemas/repository-rule" - } + "allow_rebase_merge": { + "type": "boolean", + "example": true }, - "created_at": { + "template_repository": { + "$ref": "#/components/schemas/nullable-repository" + }, + "temp_clone_token": { "type": "string", - "format": "date-time" + "nullable": true }, - "updated_at": { + "allow_squash_merge": { + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "type": "boolean", + "example": true + }, + "allow_update_branch": { + "type": "boolean", + "example": true + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "example": false + }, + "squash_merge_commit_title": { "type": "string", - "format": "date-time" + "example": "PR_TITLE", + "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)." + }, + "squash_merge_commit_message": { + "type": "string", + "example": "PR_BODY", + "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." + }, + "merge_commit_title": { + "type": "string", + "example": "PR_TITLE", + "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)." + }, + "merge_commit_message": { + "type": "string", + "example": "PR_BODY", + "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." + }, + "allow_forking": { + "type": "boolean", + "example": true + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "subscribers_count": { + "type": "integer", + "example": 42 + }, + "network_count": { + "type": "integer", + "example": 0 + }, + "license": { + "$ref": "#/components/schemas/nullable-license-simple" + }, + "organization": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "parent": { + "$ref": "#/components/schemas/repository" + }, + "source": { + "$ref": "#/components/schemas/repository" + }, + "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", @@ -117655,6 +118195,9 @@ }, "dependency_snapshots": { "$ref": "#/components/schemas/rate-limit" + }, + "code_scanning_autofix": { + "$ref": "#/components/schemas/rate-limit" } }, "required": [ @@ -130256,6 +130799,11 @@ "push_protection_bypass_request_reviewer": { "$ref": "#/components/schemas/nullable-simple-user" }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -136173,6 +136721,11 @@ "dismissed" ] }, + "reviewer_comment": { + "type": "string", + "description": "The comment the reviewer provided when responding to the exemption request.", + "nullable": true + }, "created_at": { "type": "string", "format": "date-time", @@ -147907,6 +148460,11 @@ "push_protection_bypass_request_reviewer": { "$ref": "#/components/schemas/nullable-simple-user" }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, "push_protection_bypass_request_comment": { "type": "string", "description": "An optional comment when requesting a push protection bypass.", @@ -278686,6 +279244,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": [ { @@ -278829,6 +279425,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", @@ -278920,6 +279517,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, @@ -286337,6 +286935,12 @@ "used": 0, "remaining": 10, "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 } }, "rate": { @@ -299102,6 +299706,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", @@ -299126,6 +299731,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, @@ -299153,6 +299759,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, @@ -299198,6 +299805,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/ghec/ghec.yaml b/descriptions/ghec/ghec.yaml index 591a09428..fdb6e886a 100644 --- a/descriptions/ghec/ghec.yaml +++ b/descriptions/ghec/ghec.yaml @@ -3565,7 +3565,7 @@ paths: '404': "$ref": "#/components/responses/not_found" x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-user-management @@ -3636,7 +3636,7 @@ paths: '422': "$ref": "#/components/responses/usage_metrics_api_disabled" x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-metrics @@ -3713,7 +3713,7 @@ paths: '404': "$ref": "#/components/responses/not_found" x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-usage @@ -3972,6 +3972,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 @@ -4021,6 +4037,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 @@ -4448,7 +4707,7 @@ paths: '422': "$ref": "#/components/responses/usage_metrics_api_disabled" x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-metrics @@ -4527,7 +4786,7 @@ paths: '404': "$ref": "#/components/responses/not_found" x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-usage @@ -9551,6 +9810,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" @@ -16736,44 +16997,7 @@ paths: content: application/json: schema: - type: object - properties: - value_type: - type: string - example: single_select - enum: - - string - - single_select - - multi_select - - true_false - description: The type of the value for the property - required: - type: boolean - description: Whether the property is required. - default_value: - oneOf: - - type: string - - type: array - items: - type: string - nullable: true - description: Default value of the property - description: - type: string - nullable: true - description: Short description of the property - allowed_values: - type: array - items: - type: string - maxLength: 75 - maxItems: 200 - nullable: true - 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: @@ -17444,6 +17668,7 @@ paths: - branch - tag - push + - repository default: branch enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" @@ -17660,6 +17885,7 @@ paths: - branch - tag - push + - repository enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" bypass_actors: @@ -24817,6 +25043,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" @@ -53149,6 +53377,8 @@ paths: "$ref": "#/components/schemas/sigstore-bundle-0" repository_id: type: integer + bundle_url: + type: string examples: default: value: @@ -77279,6 +77509,1073 @@ 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 + example: single_select + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + nullable: true + description: Default value of the property + description: + type: string + nullable: true + description: Short description of the property + allowed_values: + type: array + items: + type: string + maxLength: 75 + maxItems: 200 + nullable: true + 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 + nullable: true + 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 + nullable: true + properties: + href: + type: string + description: The html URL of the ruleset + conditions: + nullable: true + anyOf: + - "$ref": "#/components/schemas/repository-ruleset-conditions" + - "$ref": "#/components/schemas/org-ruleset-conditions" + rules: + type: array + items: + "$ref": "#/components/schemas/repository-rule" + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time nullable-alert-updated-at: type: string description: 'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -77357,6 +78654,10 @@ components: nullable: true push_protection_bypass_request_reviewer: "$ref": "#/components/schemas/nullable-simple-user" + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection bypass. + nullable: true push_protection_bypass_request_comment: type: string description: An optional comment when requesting a push protection bypass. @@ -83785,945 +85086,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 - nullable: true - 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 - nullable: true - properties: - href: - type: string - description: The html URL of the ruleset - conditions: - nullable: true - anyOf: - - "$ref": "#/components/schemas/repository-ruleset-conditions" - - "$ref": "#/components/schemas/org-ruleset-conditions" - 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 @@ -86376,6 +86738,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 @@ -95929,6 +96293,10 @@ components: nullable: true push_protection_bypass_request_reviewer: "$ref": "#/components/schemas/nullable-simple-user" + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection bypass. + nullable: true push_protection_bypass_request_comment: type: string description: An optional comment when requesting a push protection bypass. @@ -100465,6 +100833,11 @@ components: - approved - rejected - dismissed + reviewer_comment: + type: string + description: The comment the reviewer provided when responding to the exemption + request. + nullable: true created_at: type: string format: date-time @@ -109409,6 +109782,10 @@ components: nullable: true push_protection_bypass_request_reviewer: "$ref": "#/components/schemas/nullable-simple-user" + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection bypass. + nullable: true push_protection_bypass_request_comment: type: string description: An optional comment when requesting a push protection bypass. @@ -208474,6 +208851,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 @@ -208611,6 +209013,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 @@ -208698,6 +209101,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: @@ -215119,6 +215523,11 @@ components: used: 0 remaining: 10 reset: 1691591091 + code_scanning_autofix: + limit: 10 + used: 0 + remaining: 10 + reset: 1691591091 rate: limit: 5000 used: 1 @@ -226069,6 +226478,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 @@ -226091,6 +226501,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: @@ -226115,6 +226526,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: @@ -226157,6 +226569,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/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.json b/descriptions/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.json index f36decf76..15cc76d6f 100644 --- a/descriptions/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.json +++ b/descriptions/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.json @@ -132161,6 +132161,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": [ @@ -132261,6 +132285,12 @@ "used": 0, "remaining": 10, "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 } }, "rate": { diff --git a/descriptions/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.yaml b/descriptions/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.yaml index affb7ebaf..a7069dfac 100644 --- a/descriptions/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.yaml +++ b/descriptions/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.yaml @@ -34469,6 +34469,7 @@ paths: code_scanning_upload: *270 actions_runner_registration: *270 scim: *270 + code_scanning_autofix: *270 required: - core - search @@ -34530,6 +34531,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/ghes-3.10/dereferenced/ghes-3.10.deref.json b/descriptions/ghes-3.10/dereferenced/ghes-3.10.deref.json index f36decf76..15cc76d6f 100644 --- a/descriptions/ghes-3.10/dereferenced/ghes-3.10.deref.json +++ b/descriptions/ghes-3.10/dereferenced/ghes-3.10.deref.json @@ -132161,6 +132161,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": [ @@ -132261,6 +132285,12 @@ "used": 0, "remaining": 10, "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 } }, "rate": { diff --git a/descriptions/ghes-3.10/dereferenced/ghes-3.10.deref.yaml b/descriptions/ghes-3.10/dereferenced/ghes-3.10.deref.yaml index affb7ebaf..a7069dfac 100644 --- a/descriptions/ghes-3.10/dereferenced/ghes-3.10.deref.yaml +++ b/descriptions/ghes-3.10/dereferenced/ghes-3.10.deref.yaml @@ -34469,6 +34469,7 @@ paths: code_scanning_upload: *270 actions_runner_registration: *270 scim: *270 + code_scanning_autofix: *270 required: - core - search @@ -34530,6 +34531,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/ghes-3.10/ghes-3.10.2022-11-28.json b/descriptions/ghes-3.10/ghes-3.10.2022-11-28.json index 3de446e6b..77d8ff9bf 100644 --- a/descriptions/ghes-3.10/ghes-3.10.2022-11-28.json +++ b/descriptions/ghes-3.10/ghes-3.10.2022-11-28.json @@ -99384,6 +99384,9 @@ }, "scim": { "$ref": "#/components/schemas/rate-limit" + }, + "code_scanning_autofix": { + "$ref": "#/components/schemas/rate-limit" } }, "required": [ @@ -254649,6 +254652,12 @@ "used": 0, "remaining": 10, "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 } }, "rate": { diff --git a/descriptions/ghes-3.10/ghes-3.10.2022-11-28.yaml b/descriptions/ghes-3.10/ghes-3.10.2022-11-28.yaml index 0b1e7d18f..7eeeab9d0 100644 --- a/descriptions/ghes-3.10/ghes-3.10.2022-11-28.yaml +++ b/descriptions/ghes-3.10/ghes-3.10.2022-11-28.yaml @@ -72220,6 +72220,8 @@ components: "$ref": "#/components/schemas/rate-limit" scim: "$ref": "#/components/schemas/rate-limit" + code_scanning_autofix: + "$ref": "#/components/schemas/rate-limit" required: - core - search @@ -190725,6 +190727,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/ghes-3.10/ghes-3.10.json b/descriptions/ghes-3.10/ghes-3.10.json index 3de446e6b..77d8ff9bf 100644 --- a/descriptions/ghes-3.10/ghes-3.10.json +++ b/descriptions/ghes-3.10/ghes-3.10.json @@ -99384,6 +99384,9 @@ }, "scim": { "$ref": "#/components/schemas/rate-limit" + }, + "code_scanning_autofix": { + "$ref": "#/components/schemas/rate-limit" } }, "required": [ @@ -254649,6 +254652,12 @@ "used": 0, "remaining": 10, "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 } }, "rate": { diff --git a/descriptions/ghes-3.10/ghes-3.10.yaml b/descriptions/ghes-3.10/ghes-3.10.yaml index 0b1e7d18f..7eeeab9d0 100644 --- a/descriptions/ghes-3.10/ghes-3.10.yaml +++ b/descriptions/ghes-3.10/ghes-3.10.yaml @@ -72220,6 +72220,8 @@ components: "$ref": "#/components/schemas/rate-limit" scim: "$ref": "#/components/schemas/rate-limit" + code_scanning_autofix: + "$ref": "#/components/schemas/rate-limit" required: - core - search @@ -190725,6 +190727,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/ghes-3.11/dereferenced/ghes-3.11.2022-11-28.deref.json b/descriptions/ghes-3.11/dereferenced/ghes-3.11.2022-11-28.deref.json index e277f55e9..07a45de2d 100644 --- a/descriptions/ghes-3.11/dereferenced/ghes-3.11.2022-11-28.deref.json +++ b/descriptions/ghes-3.11/dereferenced/ghes-3.11.2022-11-28.deref.json @@ -115139,7 +115139,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", @@ -115254,7 +115254,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", @@ -115528,6 +115528,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." @@ -116090,7 +116097,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", @@ -116140,7 +116147,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", @@ -116413,6 +116420,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." @@ -116813,6 +116827,14 @@ } ] } + }, + "source_type": { + "type": "string", + "description": "The type of the source of the ruleset", + "enum": [ + "Repository", + "Organization" + ] } }, "required": [ @@ -116915,7 +116937,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", @@ -117030,7 +117052,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", @@ -117304,6 +117326,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." @@ -117917,7 +117946,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", @@ -118032,7 +118061,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", @@ -118306,6 +118335,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." @@ -118893,7 +118929,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", @@ -118943,7 +118979,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", @@ -119216,6 +119252,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." @@ -119714,7 +119757,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", @@ -119829,7 +119872,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", @@ -120103,6 +120146,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." @@ -139686,6 +139736,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": [ @@ -139786,6 +139860,12 @@ "used": 0, "remaining": 10, "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 } }, "rate": { @@ -351830,6 +351910,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." @@ -352625,7 +352712,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", @@ -352740,7 +352827,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", @@ -353014,6 +353101,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." @@ -353585,7 +353679,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", @@ -353806,6 +353900,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." @@ -354298,7 +354399,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", @@ -354413,7 +354514,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", @@ -354687,6 +354788,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." @@ -355309,7 +355417,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", @@ -355424,7 +355532,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", @@ -355698,6 +355806,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." @@ -356284,7 +356399,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", @@ -356505,6 +356620,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." @@ -356993,7 +357115,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", @@ -357108,7 +357230,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", @@ -357382,6 +357504,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." @@ -914334,7 +914463,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", @@ -914449,7 +914578,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", @@ -914723,6 +914852,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." @@ -916780,7 +916916,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", @@ -916895,7 +917031,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", @@ -917169,6 +917305,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." @@ -919226,7 +919369,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", @@ -919341,7 +919484,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", @@ -919615,6 +919758,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." @@ -920335,6 +920485,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." @@ -920883,6 +921040,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." @@ -921434,6 +921598,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/ghes-3.11/dereferenced/ghes-3.11.2022-11-28.deref.yaml b/descriptions/ghes-3.11/dereferenced/ghes-3.11.2022-11-28.deref.yaml index 69ec8e4f4..753ee365c 100644 --- a/descriptions/ghes-3.11/dereferenced/ghes-3.11.2022-11-28.deref.yam{"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}