Skip to content

Commit 95bfaaa

Browse files
Update OpenAPI 3.0 Descriptions
1 parent 2b4f068 commit 95bfaaa

16 files changed

+48
-48
lines changed

descriptions/api.github.com/api.github.com.2022-11-28.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13291,7 +13291,7 @@
1329113291
"/orgs/{org}/copilot/usage": {
1329213292
"get": {
1329313293
"summary": "Get a summary of Copilot usage for organization members",
13294-
"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.",
13294+
"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.",
1329513295
"tags": [
1329613296
"copilot"
1329713297
],
@@ -21865,7 +21865,7 @@
2186521865
"/orgs/{org}/team/{team_slug}/copilot/usage": {
2186621866
"get": {
2186721867
"summary": "Get a summary of Copilot usage for a team",
21868-
"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.",
21868+
"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.",
2186921869
"tags": [
2187021870
"copilot"
2187121871
],

descriptions/api.github.com/api.github.com.2022-11-28.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9699,7 +9699,7 @@ paths:
96999699
summary: Get a summary of Copilot usage for organization members
97009700
description: |-
97019701
> [!NOTE]
9702-
> This endpoint is in public preview and is subject to change.
9702+
> This endpoint is closing down. It will be accessible throughout February 2025, but will not return any new data after February 1st.
97039703

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

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

descriptions/api.github.com/api.github.com.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13291,7 +13291,7 @@
1329113291
"/orgs/{org}/copilot/usage": {
1329213292
"get": {
1329313293
"summary": "Get a summary of Copilot usage for organization members",
13294-
"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.",
13294+
"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.",
1329513295
"tags": [
1329613296
"copilot"
1329713297
],
@@ -21865,7 +21865,7 @@
2186521865
"/orgs/{org}/team/{team_slug}/copilot/usage": {
2186621866
"get": {
2186721867
"summary": "Get a summary of Copilot usage for a team",
21868-
"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.",
21868+
"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.",
2186921869
"tags": [
2187021870
"copilot"
2187121871
],

descriptions/api.github.com/api.github.com.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9699,7 +9699,7 @@ paths:
96999699
summary: Get a summary of Copilot usage for organization members
97009700
description: |-
97019701
> [!NOTE]
9702-
> This endpoint is in public preview and is subject to change.
9702+
> This endpoint is closing down. It will be accessible throughout February 2025, but will not return any new data after February 1st.
97039703

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

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

0 commit comments

Comments
 (0)