diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json index af951a65f8..8de1226693 100644 --- a/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json @@ -25,6 +25,17 @@ "server-to-server": false, "additional-permissions": false }, + { + "category": "copilot", + "slug": "get-a-summary-of-copilot-usage-for-an-enterprise-team", + "subcategory": "copilot-usage", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/team/{team_slug}/copilot/usage", + "access": "read", + "user-to-server": false, + "server-to-server": false, + "additional-permissions": false + }, { "category": "copilot", "slug": "get-a-summary-of-copilot-usage-for-organization-members", diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json index 4e6244b977..cc39fba6bc 100644 --- a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json @@ -179,6 +179,17 @@ "server-to-server": false, "additional-permissions": false }, + { + "category": "copilot", + "slug": "get-a-summary-of-copilot-usage-for-an-enterprise-team", + "subcategory": "copilot-usage", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/team/{team_slug}/copilot/usage", + "access": "read", + "user-to-server": false, + "server-to-server": false, + "additional-permissions": false + }, { "category": "copilot", "slug": "get-a-summary-of-copilot-usage-for-organization-members", diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index 5b1d01aef5..5803b41153 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "7bd3d57638a0363a2d4ebf03dfcf50aacdb0d8da" + "sha": "0bb1cf439a7445ce2ad2375b82c47e7ac84dbfc3" } \ No newline at end of file diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json index da79898f5e..1f57294212 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -154282,6 +154282,7 @@ "secret_scanning_push_protection": "enabled", "secret_scanning_validity_checks": "enabled", "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", "created_at": "2023-12-04T15:58:07Z", @@ -154301,6 +154302,7 @@ "secret_scanning_push_protection": "enabled", "secret_scanning_validity_checks": "disabled", "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1326", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1326", "created_at": "2024-05-10T00:00:00Z", @@ -154871,6 +154873,7 @@ "secret_scanning_push_protection": "enabled", "secret_scanning_validity_checks": "enabled", "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", "created_at": "2024-05-01T00:00:00Z", @@ -154893,6 +154896,7 @@ "secret_scanning_push_protection": "enabled", "secret_scanning_validity_checks": "disabled", "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", "created_at": "2023-12-04T15:58:07Z", @@ -155580,6 +155584,7 @@ "secret_scanning_push_protection": "disabled", "secret_scanning_validity_checks": "disabled", "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", "created_at": "2024-05-01T00:00:00Z", @@ -216619,7 +216624,300 @@ } ], "previews": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in beta and is subject to change.

\n
\n

You 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

The response contains metrics for the prior 28 days. 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

Only owners and billing managers can view Copilot usage metrics for the enterprise.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in beta and is subject to change.

\n
\n

You 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

The 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

Only owners and billing managers can view Copilot usage metrics for the enterprise.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "500", + "description": "

Internal Error

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/team/{team_slug}/copilot/usage", + "title": "Get a summary of Copilot usage for an enterprise team", + "category": "copilot", + "subcategory": "copilot-usage", + "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 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 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.\"

", + "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.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 28 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [ + { + "\"Enterprise administration\" business permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE", + "team_slug": "TEAM_SLUG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + { + "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 + } + ] + } + ], + "schema": { + "type": "array", + "items": { + "title": "Copilot Usage Metrics", + "description": "Summary of Copilot usage.", + "type": "object", + "properties": { + "day": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are reported, in `YYYY-MM-DD` format." + }, + "total_suggestions_count": { + "type": "integer", + "description": "The total number of Copilot code completion suggestions shown to users." + }, + "total_acceptances_count": { + "type": "integer", + "description": "The total number of Copilot code completion suggestions accepted by users." + }, + "total_lines_suggested": { + "type": "integer", + "description": "The total number of lines of code completions suggested by Copilot." + }, + "total_lines_accepted": { + "type": "integer", + "description": "The total number of lines of code completions accepted by users." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of users who were shown Copilot code completion suggestions during the day specified." + }, + "total_chat_acceptances": { + "type": "integer", + "description": "The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline)." + }, + "total_chat_turns": { + "type": "integer", + "description": "The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE." + }, + "total_active_chat_users": { + "type": "integer", + "description": "The total number of users who interacted with Copilot Chat in the IDE during the day specified." + }, + "breakdown": { + "type": [ + "array", + "null" + ], + "description": "Breakdown of Copilot code completions usage by language and editor", + "items": { + "type": "object", + "description": "Breakdown of Copilot usage by editor for this language", + "additionalProperties": true, + "properties": { + "language": { + "type": "string", + "description": "The language in which Copilot suggestions were shown to users in the specified editor." + }, + "editor": { + "type": "string", + "description": "The editor in which Copilot suggestions were shown to users for the specified language." + }, + "suggestions_count": { + "type": "integer", + "description": "The number of Copilot suggestions shown to users in the editor specified during the day specified." + }, + "acceptances_count": { + "type": "integer", + "description": "The number of Copilot suggestions accepted by users in the editor specified during the day specified." + }, + "lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot in the editor specified during the day specified." + }, + "lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted by users in the editor specified during the day specified." + }, + "active_users": { + "type": "integer", + "description": "The number of users who were shown Copilot completion suggestions in the editor specified during the day specified." + } + } + } + } + }, + "required": [ + "day", + "breakdown" + ], + "additionalProperties": false + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Note

\n

\nThis endpoint is in beta and is subject to change.

\n
\n

You 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

The 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

Note

\n

\nThis 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
\n

Owners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -216904,7 +217202,7 @@ } ], "previews": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in beta and is subject to change.

\n
\n

You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nacross an organization, 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

The response contains metrics for the prior 28 days. 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

Organization owners, and owners and billing managers of the parent enterprise, can view Copilot usage metrics.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot, read:org, or read:enterprise scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in beta and is subject to change.

\n
\n

You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nacross an organization, 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

The 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

Organization owners, and owners and billing managers of the parent enterprise, can view Copilot usage metrics.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot, read:org, or read:enterprise scopes to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -217245,392 +217543,6 @@ "type", "url" ] - }, - { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - }, - { - "title": "Organization", - "description": "GitHub account for managing multiple users, teams, and repositories", - "type": "object", - "properties": { - "login": { - "description": "Unique login name of the organization", - "type": "string", - "examples": [ - "new-org" - ] - }, - "url": { - "description": "URL for the organization", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "public_members_url": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "blog": { - "description": "Display blog url for the organization", - "type": "string", - "format": "uri", - "examples": [ - "blog.example-org.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "name": { - "description": "Display name for the organization", - "type": "string", - "examples": [ - "New Org" - ] - }, - "company": { - "description": "Display company name for the organization", - "type": "string", - "examples": [ - "Acme corporation" - ] - }, - "location": { - "description": "Display location for the organization", - "type": "string", - "examples": [ - "Berlin, Germany" - ] - }, - "email": { - "description": "Display email for the organization", - "type": "string", - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "has_organization_projects": { - "description": "Specifies if organization projects are enabled for this org", - "type": "boolean" - }, - "has_repository_projects": { - "description": "Specifies if repository projects are enabled for repositories that belong to this org", - "type": "boolean" - }, - "is_verified": { - "type": "boolean" - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "type": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - } - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at" - ] } ] }, @@ -218592,392 +218504,6 @@ "type", "url" ] - }, - { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - }, - { - "title": "Organization", - "description": "GitHub account for managing multiple users, teams, and repositories", - "type": "object", - "properties": { - "login": { - "description": "Unique login name of the organization", - "type": "string", - "examples": [ - "new-org" - ] - }, - "url": { - "description": "URL for the organization", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "public_members_url": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "blog": { - "description": "Display blog url for the organization", - "type": "string", - "format": "uri", - "examples": [ - "blog.example-org.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "name": { - "description": "Display name for the organization", - "type": "string", - "examples": [ - "New Org" - ] - }, - "company": { - "description": "Display company name for the organization", - "type": "string", - "examples": [ - "Acme corporation" - ] - }, - "location": { - "description": "Display location for the organization", - "type": "string", - "examples": [ - "Berlin, Germany" - ] - }, - "email": { - "description": "Display email for the organization", - "type": "string", - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "has_organization_projects": { - "description": "Specifies if organization projects are enabled for this org", - "type": "boolean" - }, - "has_repository_projects": { - "description": "Specifies if repository projects are enabled for repositories that belong to this org", - "type": "boolean" - }, - "is_verified": { - "type": "boolean" - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "type": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - } - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at" - ] } ] }, @@ -220139,392 +219665,6 @@ "type", "url" ] - }, - { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - }, - { - "title": "Organization", - "description": "GitHub account for managing multiple users, teams, and repositories", - "type": "object", - "properties": { - "login": { - "description": "Unique login name of the organization", - "type": "string", - "examples": [ - "new-org" - ] - }, - "url": { - "description": "URL for the organization", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "public_members_url": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "blog": { - "description": "Display blog url for the organization", - "type": "string", - "format": "uri", - "examples": [ - "blog.example-org.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "name": { - "description": "Display name for the organization", - "type": "string", - "examples": [ - "New Org" - ] - }, - "company": { - "description": "Display company name for the organization", - "type": "string", - "examples": [ - "Acme corporation" - ] - }, - "location": { - "description": "Display location for the organization", - "type": "string", - "examples": [ - "Berlin, Germany" - ] - }, - "email": { - "description": "Display email for the organization", - "type": "string", - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "has_organization_projects": { - "description": "Specifies if organization projects are enabled for this org", - "type": "boolean" - }, - "has_repository_projects": { - "description": "Specifies if repository projects are enabled for repositories that belong to this org", - "type": "boolean" - }, - "is_verified": { - "type": "boolean" - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "type": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - } - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at" - ] } ] }, @@ -330433,6 +329573,9 @@ "dependabot": [ "192.0.2.1" ], + "copilot": [ + "192.0.2.1" + ], "domains": { "website": [ "*.example.com" @@ -330584,6 +329727,15 @@ "192.0.2.1" ] }, + "copilot": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "192.0.2.1" + ] + }, "domains": { "type": "object", "properties": { @@ -367016,7 +366168,7 @@ } ], "previews": [], - "descriptionHTML": "

Get a repository ruleset for an organization.

", + "descriptionHTML": "

Get a repository ruleset for an organization.

\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.

", "statusCodes": [ { "httpStatusCode": "200", @@ -447470,7 +446622,7 @@ "type": "string", "name": "squash_merge_commit_title", "in": "body", - "description": "

The default value for a squash merge commit title:

\n", + "description": "

Required when using squash_merge_commit_message.

\n

The default value for a squash merge commit title:

\n", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" @@ -447491,7 +446643,7 @@ "type": "string", "name": "merge_commit_title", "in": "body", - "description": "

The default value for a merge commit title.

\n", + "description": "

Required when using merge_commit_message.

\n

The default value for a merge commit title.

\n", "enum": [ "PR_TITLE", "MERGE_MESSAGE" @@ -456906,7 +456058,7 @@ "type": "string", "name": "squash_merge_commit_title", "in": "body", - "description": "

The default value for a squash merge commit title:

\n", + "description": "

Required when using squash_merge_commit_message.

\n

The default value for a squash merge commit title:

\n", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" @@ -456927,7 +456079,7 @@ "type": "string", "name": "merge_commit_title", "in": "body", - "description": "

The default value for a merge commit title.

\n", + "description": "

Required when using merge_commit_message.

\n

The default value for a merge commit title.

\n", "enum": [ "PR_TITLE", "MERGE_MESSAGE" @@ -472480,7 +471632,7 @@ "type": "string", "name": "squash_merge_commit_title", "in": "body", - "description": "

The default value for a squash merge commit title:

\n", + "description": "

Required when using squash_merge_commit_message.

\n

The default value for a squash merge commit title:

\n", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" @@ -472501,7 +471653,7 @@ "type": "string", "name": "merge_commit_title", "in": "body", - "description": "

The default value for a merge commit title.

\n", + "description": "

Required when using merge_commit_message.

\n

The default value for a merge commit title.

\n", "enum": [ "PR_TITLE", "MERGE_MESSAGE" @@ -495223,7 +494375,7 @@ } ], "previews": [], - "descriptionHTML": "

Get a ruleset for a repository.

", + "descriptionHTML": "

Get a ruleset for a repository.

\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.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index d7672b5f96..39b6a2d8bf 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -165584,6 +165584,7 @@ "secret_scanning_push_protection": "enabled", "secret_scanning_validity_checks": "enabled", "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", "created_at": "2023-12-04T15:58:07Z", @@ -165603,6 +165604,7 @@ "secret_scanning_push_protection": "enabled", "secret_scanning_validity_checks": "disabled", "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1326", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1326", "created_at": "2024-05-10T00:00:00Z", @@ -166173,6 +166175,7 @@ "secret_scanning_push_protection": "enabled", "secret_scanning_validity_checks": "enabled", "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", "created_at": "2024-05-01T00:00:00Z", @@ -166195,6 +166198,7 @@ "secret_scanning_push_protection": "enabled", "secret_scanning_validity_checks": "disabled", "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", "created_at": "2023-12-04T15:58:07Z", @@ -166882,6 +166886,7 @@ "secret_scanning_push_protection": "disabled", "secret_scanning_validity_checks": "disabled", "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", "created_at": "2024-05-01T00:00:00Z", @@ -228197,7 +228202,300 @@ } ], "previews": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in beta and is subject to change.

\n
\n

You 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

The response contains metrics for the prior 28 days. 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

Only owners and billing managers can view Copilot usage metrics for the enterprise.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in beta and is subject to change.

\n
\n

You 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

The 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

Only owners and billing managers can view Copilot usage metrics for the enterprise.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "500", + "description": "

Internal Error

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/team/{team_slug}/copilot/usage", + "title": "Get a summary of Copilot usage for an enterprise team", + "category": "copilot", + "subcategory": "copilot-usage", + "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 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 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.\"

", + "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.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 28 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [ + { + "\"Enterprise administration\" business permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE", + "team_slug": "TEAM_SLUG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + { + "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 + } + ] + } + ], + "schema": { + "type": "array", + "items": { + "title": "Copilot Usage Metrics", + "description": "Summary of Copilot usage.", + "type": "object", + "properties": { + "day": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are reported, in `YYYY-MM-DD` format." + }, + "total_suggestions_count": { + "type": "integer", + "description": "The total number of Copilot code completion suggestions shown to users." + }, + "total_acceptances_count": { + "type": "integer", + "description": "The total number of Copilot code completion suggestions accepted by users." + }, + "total_lines_suggested": { + "type": "integer", + "description": "The total number of lines of code completions suggested by Copilot." + }, + "total_lines_accepted": { + "type": "integer", + "description": "The total number of lines of code completions accepted by users." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of users who were shown Copilot code completion suggestions during the day specified." + }, + "total_chat_acceptances": { + "type": "integer", + "description": "The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline)." + }, + "total_chat_turns": { + "type": "integer", + "description": "The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE." + }, + "total_active_chat_users": { + "type": "integer", + "description": "The total number of users who interacted with Copilot Chat in the IDE during the day specified." + }, + "breakdown": { + "type": [ + "array", + "null" + ], + "description": "Breakdown of Copilot code completions usage by language and editor", + "items": { + "type": "object", + "description": "Breakdown of Copilot usage by editor for this language", + "additionalProperties": true, + "properties": { + "language": { + "type": "string", + "description": "The language in which Copilot suggestions were shown to users in the specified editor." + }, + "editor": { + "type": "string", + "description": "The editor in which Copilot suggestions were shown to users for the specified language." + }, + "suggestions_count": { + "type": "integer", + "description": "The number of Copilot suggestions shown to users in the editor specified during the day specified." + }, + "acceptances_count": { + "type": "integer", + "description": "The number of Copilot suggestions accepted by users in the editor specified during the day specified." + }, + "lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot in the editor specified during the day specified." + }, + "lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted by users in the editor specified during the day specified." + }, + "active_users": { + "type": "integer", + "description": "The number of users who were shown Copilot completion suggestions in the editor specified during the day specified." + } + } + } + } + }, + "required": [ + "day", + "breakdown" + ], + "additionalProperties": false + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Note

\n

\nThis endpoint is in beta and is subject to change.

\n
\n

You 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

The 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

Note

\n

\nThis 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
\n

Owners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -228482,7 +228780,7 @@ } ], "previews": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in beta and is subject to change.

\n
\n

You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nacross an organization, 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

The response contains metrics for the prior 28 days. 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

Organization owners, and owners and billing managers of the parent enterprise, can view Copilot usage metrics.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot, read:org, or read:enterprise scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in beta and is subject to change.

\n
\n

You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nacross an organization, 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

The 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

Organization owners, and owners and billing managers of the parent enterprise, can view Copilot usage metrics.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot, read:org, or read:enterprise scopes to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -228823,392 +229121,6 @@ "type", "url" ] - }, - { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - }, - { - "title": "Organization", - "description": "GitHub account for managing multiple users, teams, and repositories", - "type": "object", - "properties": { - "login": { - "description": "Unique login name of the organization", - "type": "string", - "examples": [ - "new-org" - ] - }, - "url": { - "description": "URL for the organization", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "public_members_url": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "blog": { - "description": "Display blog url for the organization", - "type": "string", - "format": "uri", - "examples": [ - "blog.example-org.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "name": { - "description": "Display name for the organization", - "type": "string", - "examples": [ - "New Org" - ] - }, - "company": { - "description": "Display company name for the organization", - "type": "string", - "examples": [ - "Acme corporation" - ] - }, - "location": { - "description": "Display location for the organization", - "type": "string", - "examples": [ - "Berlin, Germany" - ] - }, - "email": { - "description": "Display email for the organization", - "type": "string", - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "has_organization_projects": { - "description": "Specifies if organization projects are enabled for this org", - "type": "boolean" - }, - "has_repository_projects": { - "description": "Specifies if repository projects are enabled for repositories that belong to this org", - "type": "boolean" - }, - "is_verified": { - "type": "boolean" - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "type": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - } - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at" - ] } ] }, @@ -230170,392 +230082,6 @@ "type", "url" ] - }, - { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - }, - { - "title": "Organization", - "description": "GitHub account for managing multiple users, teams, and repositories", - "type": "object", - "properties": { - "login": { - "description": "Unique login name of the organization", - "type": "string", - "examples": [ - "new-org" - ] - }, - "url": { - "description": "URL for the organization", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "public_members_url": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "blog": { - "description": "Display blog url for the organization", - "type": "string", - "format": "uri", - "examples": [ - "blog.example-org.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "name": { - "description": "Display name for the organization", - "type": "string", - "examples": [ - "New Org" - ] - }, - "company": { - "description": "Display company name for the organization", - "type": "string", - "examples": [ - "Acme corporation" - ] - }, - "location": { - "description": "Display location for the organization", - "type": "string", - "examples": [ - "Berlin, Germany" - ] - }, - "email": { - "description": "Display email for the organization", - "type": "string", - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "has_organization_projects": { - "description": "Specifies if organization projects are enabled for this org", - "type": "boolean" - }, - "has_repository_projects": { - "description": "Specifies if repository projects are enabled for repositories that belong to this org", - "type": "boolean" - }, - "is_verified": { - "type": "boolean" - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "type": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - } - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at" - ] } ] }, @@ -231717,392 +231243,6 @@ "type", "url" ] - }, - { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - }, - { - "title": "Organization", - "description": "GitHub account for managing multiple users, teams, and repositories", - "type": "object", - "properties": { - "login": { - "description": "Unique login name of the organization", - "type": "string", - "examples": [ - "new-org" - ] - }, - "url": { - "description": "URL for the organization", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "public_members_url": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "blog": { - "description": "Display blog url for the organization", - "type": "string", - "format": "uri", - "examples": [ - "blog.example-org.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "name": { - "description": "Display name for the organization", - "type": "string", - "examples": [ - "New Org" - ] - }, - "company": { - "description": "Display company name for the organization", - "type": "string", - "examples": [ - "Acme corporation" - ] - }, - "location": { - "description": "Display location for the organization", - "type": "string", - "examples": [ - "Berlin, Germany" - ] - }, - "email": { - "description": "Display email for the organization", - "type": "string", - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "has_organization_projects": { - "description": "Specifies if organization projects are enabled for this org", - "type": "boolean" - }, - "has_repository_projects": { - "description": "Specifies if repository projects are enabled for repositories that belong to this org", - "type": "boolean" - }, - "is_verified": { - "type": "boolean" - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "type": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - } - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at" - ] } ] }, @@ -254925,6 +254065,10 @@ "httpStatusCode": "403", "description": "

Forbidden

" }, + { + "httpStatusCode": "409", + "description": "

Conflict

" + }, { "httpStatusCode": "500", "description": "

Internal Error

" @@ -350048,6 +349192,9 @@ "dependabot": [ "192.0.2.1" ], + "copilot": [ + "192.0.2.1" + ], "domains": { "website": [ "*.example.com" @@ -350199,6 +349346,15 @@ "192.0.2.1" ] }, + "copilot": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "192.0.2.1" + ] + }, "domains": { "type": "object", "properties": { @@ -391195,7 +390351,7 @@ } ], "previews": [], - "descriptionHTML": "

Get a repository ruleset for an organization.

", + "descriptionHTML": "

Get a repository ruleset for an organization.

\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.

", "statusCodes": [ { "httpStatusCode": "200", @@ -471775,7 +470931,7 @@ "type": "string", "name": "squash_merge_commit_title", "in": "body", - "description": "

The default value for a squash merge commit title:

\n", + "description": "

Required when using squash_merge_commit_message.

\n

The default value for a squash merge commit title:

\n", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" @@ -471796,7 +470952,7 @@ "type": "string", "name": "merge_commit_title", "in": "body", - "description": "

The default value for a merge commit title.

\n", + "description": "

Required when using merge_commit_message.

\n

The default value for a merge commit title.

\n", "enum": [ "PR_TITLE", "MERGE_MESSAGE" @@ -481253,7 +480409,7 @@ "type": "string", "name": "squash_merge_commit_title", "in": "body", - "description": "

The default value for a squash merge commit title:

\n", + "description": "

Required when using squash_merge_commit_message.

\n

The default value for a squash merge commit title:

\n", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" @@ -481274,7 +480430,7 @@ "type": "string", "name": "merge_commit_title", "in": "body", - "description": "

The default value for a merge commit title.

\n", + "description": "

Required when using merge_commit_message.

\n

The default value for a merge commit title.

\n", "enum": [ "PR_TITLE", "MERGE_MESSAGE" @@ -496875,7 +496031,7 @@ "type": "string", "name": "squash_merge_commit_title", "in": "body", - "description": "

The default value for a squash merge commit title:

\n", + "description": "

Required when using squash_merge_commit_message.

\n

The default value for a squash merge commit title:

\n", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" @@ -496896,7 +496052,7 @@ "type": "string", "name": "merge_commit_title", "in": "body", - "description": "

The default value for a merge commit title.

\n", + "description": "

Required when using merge_commit_message.

\n

The default value for a merge commit title.

\n", "enum": [ "PR_TITLE", "MERGE_MESSAGE" @@ -519797,7 +518953,7 @@ } ], "previews": [], - "descriptionHTML": "

Get a ruleset for a repository.

", + "descriptionHTML": "

Get a ruleset for a repository.

\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.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.10-2022-11-28/schema.json b/src/rest/data/ghes-3.10-2022-11-28/schema.json index 574e3c3ee1..c49f8ef11f 100644 --- a/src/rest/data/ghes-3.10-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.10-2022-11-28/schema.json @@ -296925,12 +296925,6 @@ "packages": [ "192.0.2.1" ], - "actions_macos": [ - "192.0.2.1" - ], - "dependabot": [ - "192.0.2.1" - ], "domains": { "website": [ "*.example.com" @@ -296967,24 +296961,6 @@ "192.0.2.1" ] }, - "actions_macos": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "192.0.2.1" - ] - }, - "dependabot": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "192.0.2.1" - ] - }, "domains": { "type": "object", "properties": { @@ -405640,7 +405616,7 @@ "type": "string", "name": "squash_merge_commit_title", "in": "body", - "description": "

The default value for a squash merge commit title:

\n", + "description": "

Required when using squash_merge_commit_message.

\n

The default value for a squash merge commit title:

\n", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" @@ -405661,7 +405637,7 @@ "type": "string", "name": "merge_commit_title", "in": "body", - "description": "

The default value for a merge commit title.

\n", + "description": "

Required when using merge_commit_message.

\n

The default value for a merge commit title.

\n", "enum": [ "PR_TITLE", "MERGE_MESSAGE" @@ -415015,7 +414991,7 @@ "type": "string", "name": "squash_merge_commit_title", "in": "body", - "description": "

The default value for a squash merge commit title:

\n", + "description": "

Required when using squash_merge_commit_message.

\n

The default value for a squash merge commit title:

\n", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" @@ -415036,7 +415012,7 @@ "type": "string", "name": "merge_commit_title", "in": "body", - "description": "

The default value for a merge commit title.

\n", + "description": "

Required when using merge_commit_message.

\n

The default value for a merge commit title.

\n", "enum": [ "PR_TITLE", "MERGE_MESSAGE" @@ -429487,7 +429463,7 @@ "type": "string", "name": "squash_merge_commit_title", "in": "body", - "description": "

The default value for a squash merge commit title:

\n", + "description": "

Required when using squash_merge_commit_message.

\n

The default value for a squash merge commit title:

\n", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" @@ -429508,7 +429484,7 @@ "type": "string", "name": "merge_commit_title", "in": "body", - "description": "

The default value for a merge commit title.

\n", + "description": "

Required when using merge_commit_message.

\n

The default value for a merge commit title.

\n", "enum": [ "PR_TITLE", "MERGE_MESSAGE" diff --git a/src/rest/data/ghes-3.11-2022-11-28/schema.json b/src/rest/data/ghes-3.11-2022-11-28/schema.json index c741bc65b2..87e417309e 100644 --- a/src/rest/data/ghes-3.11-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.11-2022-11-28/schema.json @@ -296990,12 +296990,6 @@ "packages": [ "192.0.2.1" ], - "actions_macos": [ - "192.0.2.1" - ], - "dependabot": [ - "192.0.2.1" - ], "domains": { "website": [ "*.example.com" @@ -297032,24 +297026,6 @@ "192.0.2.1" ] }, - "actions_macos": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "192.0.2.1" - ] - }, - "dependabot": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "192.0.2.1" - ] - }, "domains": { "type": "object", "properties": { @@ -332445,7 +332421,7 @@ } ], "previews": [], - "descriptionHTML": "

Get a repository ruleset for an organization.

", + "descriptionHTML": "

Get a repository ruleset for an organization.

\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.

", "statusCodes": [ { "httpStatusCode": "200", @@ -411305,7 +411281,7 @@ "type": "string", "name": "squash_merge_commit_title", "in": "body", - "description": "

The default value for a squash merge commit title:

\n", + "description": "

Required when using squash_merge_commit_message.

\n

The default value for a squash merge commit title:

\n", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" @@ -411326,7 +411302,7 @@ "type": "string", "name": "merge_commit_title", "in": "body", - "description": "

The default value for a merge commit title.

\n", + "description": "

Required when using merge_commit_message.

\n

The default value for a merge commit title.

\n", "enum": [ "PR_TITLE", "MERGE_MESSAGE" @@ -420686,7 +420662,7 @@ "type": "string", "name": "squash_merge_commit_title", "in": "body", - "description": "

The default value for a squash merge commit title:

\n", + "description": "

Required when using squash_merge_commit_message.

\n

The default value for a squash merge commit title:

\n", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" @@ -420707,7 +420683,7 @@ "type": "string", "name": "merge_commit_title", "in": "body", - "description": "

The default value for a merge commit title.

\n", + "description": "

Required when using merge_commit_message.

\n

The default value for a merge commit title.

\n", "enum": [ "PR_TITLE", "MERGE_MESSAGE" @@ -435596,7 +435572,7 @@ "type": "string", "name": "squash_merge_commit_title", "in": "body", - "description": "

The default value for a squash merge commit title:

\n", + "description": "

Required when using squash_merge_commit_message.

\n

The default value for a squash merge commit title:

\n", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" @@ -435617,7 +435593,7 @@ "type": "string", "name": "merge_commit_title", "in": "body", - "description": "

The default value for a merge commit title.

\n", + "description": "

Required when using merge_commit_message.

\n

The default value for a merge commit title.

\n", "enum": [ "PR_TITLE", "MERGE_MESSAGE" @@ -456063,7 +456039,7 @@ } ], "previews": [], - "descriptionHTML": "

Get a ruleset for a repository.

", + "descriptionHTML": "

Get a ruleset for a repository.

\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.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.12-2022-11-28/schema.json b/src/rest/data/ghes-3.12-2022-11-28/schema.json index 7afe4559ea..0d7630f8f4 100644 --- a/src/rest/data/ghes-3.12-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.12-2022-11-28/schema.json @@ -299227,12 +299227,6 @@ "packages": [ "192.0.2.1" ], - "actions_macos": [ - "192.0.2.1" - ], - "dependabot": [ - "192.0.2.1" - ], "domains": { "website": [ "*.example.com" @@ -299269,24 +299263,6 @@ "192.0.2.1" ] }, - "actions_macos": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "192.0.2.1" - ] - }, - "dependabot": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "192.0.2.1" - ] - }, "domains": { "type": "object", "properties": { @@ -335310,7 +335286,7 @@ } ], "previews": [], - "descriptionHTML": "

Get a repository ruleset for an organization.

", + "descriptionHTML": "

Get a repository ruleset for an organization.

\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.

", "statusCodes": [ { "httpStatusCode": "200", @@ -414170,7 +414146,7 @@ "type": "string", "name": "squash_merge_commit_title", "in": "body", - "description": "

The default value for a squash merge commit title:

\n", + "description": "

Required when using squash_merge_commit_message.

\n

The default value for a squash merge commit title:

\n", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" @@ -414191,7 +414167,7 @@ "type": "string", "name": "merge_commit_title", "in": "body", - "description": "

The default value for a merge commit title.

\n", + "description": "

Required when using merge_commit_message.

\n

The default value for a merge commit title.

\n", "enum": [ "PR_TITLE", "MERGE_MESSAGE" @@ -423561,7 +423537,7 @@ "type": "string", "name": "squash_merge_commit_title", "in": "body", - "description": "

The default value for a squash merge commit title:

\n", + "description": "

Required when using squash_merge_commit_message.

\n

The default value for a squash merge commit title:

\n", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" @@ -423582,7 +423558,7 @@ "type": "string", "name": "merge_commit_title", "in": "body", - "description": "

The default value for a merge commit title.

\n", + "description": "

Required when using merge_commit_message.

\n

The default value for a merge commit title.

\n", "enum": [ "PR_TITLE", "MERGE_MESSAGE" @@ -438481,7 +438457,7 @@ "type": "string", "name": "squash_merge_commit_title", "in": "body", - "description": "

The default value for a squash merge commit title:

\n", + "description": "

Required when using squash_merge_commit_message.

\n

The default value for a squash merge commit title:

\n", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" @@ -438502,7 +438478,7 @@ "type": "string", "name": "merge_commit_title", "in": "body", - "description": "

The default value for a merge commit title.

\n", + "description": "

Required when using merge_commit_message.

\n

The default value for a merge commit title.

\n", "enum": [ "PR_TITLE", "MERGE_MESSAGE" @@ -459445,7 +459421,7 @@ } ], "previews": [], - "descriptionHTML": "

Get a ruleset for a repository.

", + "descriptionHTML": "

Get a ruleset for a repository.

\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.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.13-2022-11-28/schema.json b/src/rest/data/ghes-3.13-2022-11-28/schema.json index ad34439f31..04217d622b 100644 --- a/src/rest/data/ghes-3.13-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.13-2022-11-28/schema.json @@ -299437,12 +299437,6 @@ "packages": [ "192.0.2.1" ], - "actions_macos": [ - "192.0.2.1" - ], - "dependabot": [ - "192.0.2.1" - ], "domains": { "website": [ "*.example.com" @@ -299479,24 +299473,6 @@ "192.0.2.1" ] }, - "actions_macos": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "192.0.2.1" - ] - }, - "dependabot": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "192.0.2.1" - ] - }, "domains": { "type": "object", "properties": { @@ -337227,7 +337203,7 @@ } ], "previews": [], - "descriptionHTML": "

Get a repository ruleset for an organization.

", + "descriptionHTML": "

Get a repository ruleset for an organization.

\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.

", "statusCodes": [ { "httpStatusCode": "200", @@ -416507,7 +416483,7 @@ "type": "string", "name": "squash_merge_commit_title", "in": "body", - "description": "

The default value for a squash merge commit title:

\n", + "description": "

Required when using squash_merge_commit_message.

\n

The default value for a squash merge commit title:

\n", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" @@ -416528,7 +416504,7 @@ "type": "string", "name": "merge_commit_title", "in": "body", - "description": "

The default value for a merge commit title.

\n", + "description": "

Required when using merge_commit_message.

\n

The default value for a merge commit title.

\n", "enum": [ "PR_TITLE", "MERGE_MESSAGE" @@ -425898,7 +425874,7 @@ "type": "string", "name": "squash_merge_commit_title", "in": "body", - "description": "

The default value for a squash merge commit title:

\n", + "description": "

Required when using squash_merge_commit_message.

\n

The default value for a squash merge commit title:

\n", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" @@ -425919,7 +425895,7 @@ "type": "string", "name": "merge_commit_title", "in": "body", - "description": "

The default value for a merge commit title.

\n", + "description": "

Required when using merge_commit_message.

\n

The default value for a merge commit title.

\n", "enum": [ "PR_TITLE", "MERGE_MESSAGE" @@ -440818,7 +440794,7 @@ "type": "string", "name": "squash_merge_commit_title", "in": "body", - "description": "

The default value for a squash merge commit title:

\n", + "description": "

Required when using squash_merge_commit_message.

\n

The default value for a squash merge commit title:

\n", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" @@ -440839,7 +440815,7 @@ "type": "string", "name": "merge_commit_title", "in": "body", - "description": "

The default value for a merge commit title.

\n", + "description": "

Required when using merge_commit_message.

\n

The default value for a merge commit title.

\n", "enum": [ "PR_TITLE", "MERGE_MESSAGE" @@ -462376,7 +462352,7 @@ } ], "previews": [], - "descriptionHTML": "

Get a ruleset for a repository.

", + "descriptionHTML": "

Get a ruleset for a repository.

\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.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.14-2022-11-28/schema.json b/src/rest/data/ghes-3.14-2022-11-28/schema.json index bde4925d6a..501045676d 100644 --- a/src/rest/data/ghes-3.14-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.14-2022-11-28/schema.json @@ -299437,12 +299437,6 @@ "packages": [ "192.0.2.1" ], - "actions_macos": [ - "192.0.2.1" - ], - "dependabot": [ - "192.0.2.1" - ], "domains": { "website": [ "*.example.com" @@ -299479,24 +299473,6 @@ "192.0.2.1" ] }, - "actions_macos": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "192.0.2.1" - ] - }, - "dependabot": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "192.0.2.1" - ] - }, "domains": { "type": "object", "properties": { @@ -340566,7 +340542,7 @@ } ], "previews": [], - "descriptionHTML": "

Get a repository ruleset for an organization.

", + "descriptionHTML": "

Get a repository ruleset for an organization.

\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.

", "statusCodes": [ { "httpStatusCode": "200", @@ -420225,7 +420201,7 @@ "type": "string", "name": "squash_merge_commit_title", "in": "body", - "description": "

The default value for a squash merge commit title:

\n", + "description": "

Required when using squash_merge_commit_message.

\n

The default value for a squash merge commit title:

\n", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" @@ -420246,7 +420222,7 @@ "type": "string", "name": "merge_commit_title", "in": "body", - "description": "

The default value for a merge commit title.

\n", + "description": "

Required when using merge_commit_message.

\n

The default value for a merge commit title.

\n", "enum": [ "PR_TITLE", "MERGE_MESSAGE" @@ -429616,7 +429592,7 @@ "type": "string", "name": "squash_merge_commit_title", "in": "body", - "description": "

The default value for a squash merge commit title:

\n", + "description": "

Required when using squash_merge_commit_message.

\n

The default value for a squash merge commit title:

\n", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" @@ -429637,7 +429613,7 @@ "type": "string", "name": "merge_commit_title", "in": "body", - "description": "

The default value for a merge commit title.

\n", + "description": "

Required when using merge_commit_message.

\n

The default value for a merge commit title.

\n", "enum": [ "PR_TITLE", "MERGE_MESSAGE" @@ -444536,7 +444512,7 @@ "type": "string", "name": "squash_merge_commit_title", "in": "body", - "description": "

The default value for a squash merge commit title:

\n", + "description": "

Required when using squash_merge_commit_message.

\n

The default value for a squash merge commit title:

\n", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" @@ -444557,7 +444533,7 @@ "type": "string", "name": "merge_commit_title", "in": "body", - "description": "

The default value for a merge commit title.

\n", + "description": "

Required when using merge_commit_message.

\n

The default value for a merge commit title.

\n", "enum": [ "PR_TITLE", "MERGE_MESSAGE" @@ -466948,7 +466924,7 @@ } ], "previews": [], - "descriptionHTML": "

Get a ruleset for a repository.

", + "descriptionHTML": "

Get a ruleset for a repository.

\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.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 86615e735d..f7406255d9 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -47,5 +47,5 @@ ] } }, - "sha": "7bd3d57638a0363a2d4ebf03dfcf50aacdb0d8da" + "sha": "0bb1cf439a7445ce2ad2375b82c47e7ac84dbfc3" } \ No newline at end of file diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 8dd3ff17b5..3af8c1e479 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "7bd3d57638a0363a2d4ebf03dfcf50aacdb0d8da" + "sha": "0bb1cf439a7445ce2ad2375b82c47e7ac84dbfc3" } \ No newline at end of file