Skip to content

Commit

Permalink
Update OpenAPI 3.0 Descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
github-openapi-bot committed Feb 5, 2025
1 parent 2b4f068 commit 95bfaaa
Show file tree
Hide file tree
Showing 16 changed files with 48 additions and 48 deletions.
4 changes: 2 additions & 2 deletions descriptions/api.github.com/api.github.com.2022-11-28.json
Original file line number Diff line number Diff line change
Expand Up @@ -13291,7 +13291,7 @@
"/orgs/{org}/copilot/usage": {
"get": {
"summary": "Get a summary of Copilot usage for organization members",
"description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\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\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nOrganization owners, and owners and billing managers of the parent enterprise, can view Copilot usage metrics.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.",
"description": "> [!NOTE]\n> This endpoint is closing down. It will be accessible throughout February 2025, but will not return any new data after February 1st.\n\nYou 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\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nOrganization owners, and owners and billing managers of the parent enterprise, can view Copilot usage metrics.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.",
"tags": [
"copilot"
],
Expand Down Expand Up @@ -21865,7 +21865,7 @@
"/orgs/{org}/team/{team_slug}/copilot/usage": {
"get": {
"summary": "Get a summary of Copilot usage for a team",
"description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the team had five or more members with active Copilot licenses, as evaluated at the end of that day.\n\nOrganization owners for the organization that contains this team, and owners and billing managers of the parent enterprise can view Copilot usage metrics for a team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.",
"description": "> [!NOTE]\n> This endpoint is closing down. It will be accessible throughout February 2025, but will not return any new data after February 1st.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the team had five or more members with active Copilot licenses, as evaluated at the end of that day.\n\nOrganization owners for the organization that contains this team, and owners and billing managers of the parent enterprise can view Copilot usage metrics for a team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.",
"tags": [
"copilot"
],
Expand Down
4 changes: 2 additions & 2 deletions descriptions/api.github.com/api.github.com.2022-11-28.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9699,7 +9699,7 @@ paths:
summary: Get a summary of Copilot usage for organization members
description: |-
> [!NOTE]
> This endpoint is in public preview and is subject to change.
> This endpoint is closing down. It will be accessible throughout February 2025, but will not return any new data after February 1st.

You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE
across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.
Expand Down Expand Up @@ -15855,7 +15855,7 @@ paths:
summary: Get a summary of Copilot usage for a team
description: |-
> [!NOTE]
> This endpoint is in public preview and is subject to change.
> This endpoint is closing down. It will be accessible throughout February 2025, but will not return any new data after February 1st.

You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE
for users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.
Expand Down
4 changes: 2 additions & 2 deletions descriptions/api.github.com/api.github.com.json
Original file line number Diff line number Diff line change
Expand Up @@ -13291,7 +13291,7 @@
"/orgs/{org}/copilot/usage": {
"get": {
"summary": "Get a summary of Copilot usage for organization members",
"description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\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\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nOrganization owners, and owners and billing managers of the parent enterprise, can view Copilot usage metrics.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.",
"description": "> [!NOTE]\n> This endpoint is closing down. It will be accessible throughout February 2025, but will not return any new data after February 1st.\n\nYou 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\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nOrganization owners, and owners and billing managers of the parent enterprise, can view Copilot usage metrics.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.",
"tags": [
"copilot"
],
Expand Down Expand Up @@ -21865,7 +21865,7 @@
"/orgs/{org}/team/{team_slug}/copilot/usage": {
"get": {
"summary": "Get a summary of Copilot usage for a team",
"description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the team had five or more members with active Copilot licenses, as evaluated at the end of that day.\n\nOrganization owners for the organization that contains this team, and owners and billing managers of the parent enterprise can view Copilot usage metrics for a team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.",
"description": "> [!NOTE]\n> This endpoint is closing down. It will be accessible throughout February 2025, but will not return any new data after February 1st.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the team had five or more members with active Copilot licenses, as evaluated at the end of that day.\n\nOrganization owners for the organization that contains this team, and owners and billing managers of the parent enterprise can view Copilot usage metrics for a team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.",
"tags": [
"copilot"
],
Expand Down
4 changes: 2 additions & 2 deletions descriptions/api.github.com/api.github.com.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9699,7 +9699,7 @@ paths:
summary: Get a summary of Copilot usage for organization members
description: |-
> [!NOTE]
> This endpoint is in public preview and is subject to change.
> This endpoint is closing down. It will be accessible throughout February 2025, but will not return any new data after February 1st.

You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE
across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.
Expand Down Expand Up @@ -15855,7 +15855,7 @@ paths:
summary: Get a summary of Copilot usage for a team
description: |-
> [!NOTE]
> This endpoint is in public preview and is subject to change.
> This endpoint is closing down. It will be accessible throughout February 2025, but will not return any new data after February 1st.

You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE
for users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.
Expand Down
Loading

0 comments on commit 95bfaaa

Please sign in to comment.