feat: Remove the beta endpoint for Copilot usage

[henriklundstrom]

Note: This is a breaking change only in the sense that it removes the endpoints added by 5e806b6, but that commit has not yet made it to any release, so in that sense it is not breaking with any previous release.

Removes support for the beta endpoint for Copilot usage metrics, which is scheduled for removal by GitHub by the end of the year, see https://github.blog/changelog/2024-10-30-github-copilot-metrics-api-ga-release-now-available/. Support for the GA endpoint was implemented by 717e93f.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.30%. Comparing base (2b8c7fa) to head (42f8af8).
Report is 176 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #3354      +/-   ##
==========================================
- Coverage   97.72%   92.30%   -5.42%     
==========================================
  Files         153      176      +23     
  Lines       13390    15031    +1641     
==========================================
+ Hits        13085    13874     +789     
- Misses        215     1064     +849     
- Partials       90       93       +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

---

🚨 Try these New Features:

• Flaky Tests Detection - Detect and resolve failed and flaky tests

[gmlewis]

@henriklundstrom - I'm confused - wasn't GitHub's OpenAPI spec updated to include your new endpoints?
Should I be updating the OpenAPI spec again? (I think I updated it two days ago maybe in #3352.)

[henriklundstrom]

@henriklundstrom - I'm confused - wasn't GitHub's OpenAPI spec updated to include your new endpoints? Should I be updating the OpenAPI spec again? (I think I updated it two days ago maybe in #3352.)

@gmlewis There are two sets of endpoints for Copilot metrics. They do largely the same things and both of them were launched very recently. First there was a beta launch, and then shortly thereafter a GA version to replace it.

Beta:
The usage endpoints, see https://docs.github.com/en/rest/copilot/copilot-usage?apiVersion=2022-11-28. They are in public preview, and as far as I understand it from this announcement https://github.blog/changelog/2024-10-30-github-copilot-metrics-api-ga-release-now-available/, will be discontinued by the end of the year. This PR removes support for those endpoints, which was originally added about a month ago with 5e806b6.

GA:
The metrics endpoints, see https://docs.github.com/en/rest/copilot/copilot-metrics?apiVersion=2022-11-28. They are in GA, were introduced very recently, after the usage endpoints, and as far as I understand it, are intended to replace them. These are the endpoints I implemented support for a few days ago with 717e93f, and they will remain after this PR.

[henriklundstrom]

@gmlewis I should clarify as well that yes this is a breaking change in the sense that it removes the endpoints added by 5e806b6, but that commit has not yet made it to any release, so in that sense it is not breaking with any previous release.

[gmlewis]

@henriklundstrom - thank you for the excellent explanation. That makes perfect sense.

[gmlewis]

Thank you, @henriklundstrom !
LGTM.

Awaiting second LGTM+Approval from any other contributor to this repo before merging.

[alexandear]

Maybe it's better to mark these functions as Deprecated: use ... instead and not removing them? We can always remove them later.

[gmlewis]

I'm fine with deleting since the removed code has not been officially released in this repo with any tagged release.

That's why I removed the Breaking Change label.

[alexandear]

Maybe it's better to remove "BREAKING CHANGE" from the PR's description. This will avoid any confusion in for the future PR's readers.

[henriklundstrom]

I updated the description, hopefully it's more clear now.

[gmlewis]

Thank you, @alexandear !
Merging.