Update to newer Github API

[Hackwar]

Summary of Changes

Begins aligning the library's HTTP layer with GitHub's current REST API conventions, and flags the two package classes that target endpoints GitHub has since removed. This is phase 0 of a larger modernization pass (see update.md) — purely additive/documentation changes, no public method signatures changed.

• AbstractGithubObject::fetchUrl() now sends a default Accept: application/vnd.github+json header and pins X-GitHub-Api-Version: 2022-11-28 on every request, so responses don't silently change shape as GitHub advances its default API version. Both are only applied if the consumer hasn't already set that header themselves, and the version string is overridable via a new api.version option.
• Added a gh.token.scheme option (default token, unchanged) so callers can opt into the Bearer scheme for fine-grained PATs or GitHub App installation tokens without affecting existing classic-PAT consumers.
• Documented that the Basic Authentication (username/password) fallback in fetchUrl() no longer works against github.com — GitHub removed it in November 2020 — and is retained only for GitHub Enterprise Server compatibility.
• Expanded the @deprecated docblocks on Package\Authorization and Package\Repositories\Downloads to explain that GitHub has removed the underlying endpoints entirely (OAuth Authorizations API and Basic Auth in Nov 2020; the Downloads API years earlier), that every method in these classes now fails against live GitHub, and that they're kept only so existing $github->authorization / $github->repositories->downloads call sites don't fatal. Points callers at the replacements (GitHub Apps/OAuth device flow, and Repositories\Releases).

Testing Instructions

Rely on the unittests

Documentation Changes Required

See v3-to-v4-update.md

[Hackwar]

Summary of Changes

Begins aligning the library's HTTP layer with GitHub's current REST API conventions, and flags the two package classes that target endpoints GitHub has since removed. This is phase 0 of a larger modernization pass (see update.md) — purely additive/documentation changes, no public method signatures changed.

• AbstractGithubObject::fetchUrl() now sends a default Accept: application/vnd.github+json header and pins X-GitHub-Api-Version: 2022-11-28 on every request, so responses don't silently change shape as GitHub advances its default API version. Both are only applied if the consumer hasn't already set that header themselves, and the version string is overridable via a new api.version option.
• Added a gh.token.scheme option (default token, unchanged) so callers can opt into the Bearer scheme for fine-grained PATs or GitHub App installation tokens without affecting existing classic-PAT consumers.
• Documented that the Basic Authentication (username/password) fallback in fetchUrl() no longer works against github.com — GitHub removed it in November 2020 — and is retained only for GitHub Enterprise Server compatibility.
• Expanded the @deprecated docblocks on Package\Authorization and Package\Repositories\Downloads to explain that GitHub has removed the underlying endpoints entirely (OAuth Authorizations API and Basic Auth in Nov 2020; the Downloads API years earlier), that every method in these classes now fails against live GitHub, and that they're kept only so existing $github->authorization / $github->repositories->downloads call sites don't fatal. Points callers at the replacements (GitHub Apps/OAuth device flow, and Repositories\Releases).

Testing Instructions

Rely on the unittests

Documentation Changes Required

See v3-to-v4-update.md

[Hackwar]

Summary of Changes

Begins aligning the library's HTTP layer with GitHub's current REST API conventions, and flags the two package classes that target endpoints GitHub has since removed. This is phase 0 of a larger modernization pass (see update.md) — purely additive/documentation changes, no public method signatures changed.

• AbstractGithubObject::fetchUrl() now sends a default Accept: application/vnd.github+json header and pins X-GitHub-Api-Version: 2022-11-28 on every request, so responses don't silently change shape as GitHub advances its default API version. Both are only applied if the consumer hasn't already set that header themselves, and the version string is overridable via a new api.version option.
• Added a gh.token.scheme option (default token, unchanged) so callers can opt into the Bearer scheme for fine-grained PATs or GitHub App installation tokens without affecting existing classic-PAT consumers.
• Documented that the Basic Authentication (username/password) fallback in fetchUrl() no longer works against github.com — GitHub removed it in November 2020 — and is retained only for GitHub Enterprise Server compatibility.
• Expanded the @deprecated docblocks on Package\Authorization and Package\Repositories\Downloads to explain that GitHub has removed the underlying endpoints entirely (OAuth Authorizations API and Basic Auth in Nov 2020; the Downloads API years earlier), that every method in these classes now fails against live GitHub, and that they're kept only so existing $github->authorization / $github->repositories->downloads call sites don't fatal. Points callers at the replacements (GitHub Apps/OAuth device flow, and Repositories\Releases).

Testing Instructions

Rely on the unittests

Documentation Changes Required

See v3-to-v4-update.md

[Hackwar]

Summary of Changes

Begins aligning the library's HTTP layer with GitHub's current REST API conventions, and flags the two package classes that target endpoints GitHub has since removed. This is phase 0 of a larger modernization pass (see update.md) — purely additive/documentation changes, no public method signatures changed.

• AbstractGithubObject::fetchUrl() now sends a default Accept: application/vnd.github+json header and pins X-GitHub-Api-Version: 2022-11-28 on every request, so responses don't silently change shape as GitHub advances its default API version. Both are only applied if the consumer hasn't already set that header themselves, and the version string is overridable via a new api.version option.
• Added a gh.token.scheme option (default token, unchanged) so callers can opt into the Bearer scheme for fine-grained PATs or GitHub App installation tokens without affecting existing classic-PAT consumers.
• Documented that the Basic Authentication (username/password) fallback in fetchUrl() no longer works against github.com — GitHub removed it in November 2020 — and is retained only for GitHub Enterprise Server compatibility.
• Expanded the @deprecated docblocks on Package\Authorization and Package\Repositories\Downloads to explain that GitHub has removed the underlying endpoints entirely (OAuth Authorizations API and Basic Auth in Nov 2020; the Downloads API years earlier), that every method in these classes now fails against live GitHub, and that they're kept only so existing $github->authorization / $github->repositories->downloads call sites don't fatal. Points callers at the replacements (GitHub Apps/OAuth device flow, and Repositories\Releases).

Testing Instructions

Rely on the unittests

Documentation Changes Required

See v3-to-v4-update.md

[Hackwar]

Summary of Changes

Begins aligning the library's HTTP layer with GitHub's current REST API conventions, and flags the two package classes that target endpoints GitHub has since removed. This is phase 0 of a larger modernization pass (see update.md) — purely additive/documentation changes, no public method signatures changed.

• AbstractGithubObject::fetchUrl() now sends a default Accept: application/vnd.github+json header and pins X-GitHub-Api-Version: 2022-11-28 on every request, so responses don't silently change shape as GitHub advances its default API version. Both are only applied if the consumer hasn't already set that header themselves, and the version string is overridable via a new api.version option.
• Added a gh.token.scheme option (default token, unchanged) so callers can opt into the Bearer scheme for fine-grained PATs or GitHub App installation tokens without affecting existing classic-PAT consumers.
• Documented that the Basic Authentication (username/password) fallback in fetchUrl() no longer works against github.com — GitHub removed it in November 2020 — and is retained only for GitHub Enterprise Server compatibility.
• Expanded the @deprecated docblocks on Package\Authorization and Package\Repositories\Downloads to explain that GitHub has removed the underlying endpoints entirely (OAuth Authorizations API and Basic Auth in Nov 2020; the Downloads API years earlier), that every method in these classes now fails against live GitHub, and that they're kept only so existing $github->authorization / $github->repositories->downloads call sites don't fatal. Points callers at the replacements (GitHub Apps/OAuth device flow, and Repositories\Releases).

Testing Instructions

Rely on the unittests

Documentation Changes Required

See v3-to-v4-update.md

[Hackwar]

Summary of Changes

Begins aligning the library's HTTP layer with GitHub's current REST API conventions, and flags the two package classes that target endpoints GitHub has since removed. This is phase 0 of a larger modernization pass (see update.md) — purely additive/documentation changes, no public method signatures changed.

• AbstractGithubObject::fetchUrl() now sends a default Accept: application/vnd.github+json header and pins X-GitHub-Api-Version: 2022-11-28 on every request, so responses don't silently change shape as GitHub advances its default API version. Both are only applied if the consumer hasn't already set that header themselves, and the version string is overridable via a new api.version option.
• Added a gh.token.scheme option (default token, unchanged) so callers can opt into the Bearer scheme for fine-grained PATs or GitHub App installation tokens without affecting existing classic-PAT consumers.
• Documented that the Basic Authentication (username/password) fallback in fetchUrl() no longer works against github.com — GitHub removed it in November 2020 — and is retained only for GitHub Enterprise Server compatibility.
• Expanded the @deprecated docblocks on Package\Authorization and Package\Repositories\Downloads to explain that GitHub has removed the underlying endpoints entirely (OAuth Authorizations API and Basic Auth in Nov 2020; the Downloads API years earlier), that every method in these classes now fails against live GitHub, and that they're kept only so existing $github->authorization / $github->repositories->downloads call sites don't fatal. Points callers at the replacements (GitHub Apps/OAuth device flow, and Repositories\Releases).

Testing Instructions

Rely on the unittests

Documentation Changes Required

See v3-to-v4-update.md

[Hackwar]

Summary of Changes

Begins aligning the library's HTTP layer with GitHub's current REST API conventions, and flags the two package classes that target endpoints GitHub has since removed. This is phase 0 of a larger modernization pass (see update.md) — purely additive/documentation changes, no public method signatures changed.

• AbstractGithubObject::fetchUrl() now sends a default Accept: application/vnd.github+json header and pins X-GitHub-Api-Version: 2022-11-28 on every request, so responses don't silently change shape as GitHub advances its default API version. Both are only applied if the consumer hasn't already set that header themselves, and the version string is overridable via a new api.version option.
• Added a gh.token.scheme option (default token, unchanged) so callers can opt into the Bearer scheme for fine-grained PATs or GitHub App installation tokens without affecting existing classic-PAT consumers.
• Documented that the Basic Authentication (username/password) fallback in fetchUrl() no longer works against github.com — GitHub removed it in November 2020 — and is retained only for GitHub Enterprise Server compatibility.
• Expanded the @deprecated docblocks on Package\Authorization and Package\Repositories\Downloads to explain that GitHub has removed the underlying endpoints entirely (OAuth Authorizations API and Basic Auth in Nov 2020; the Downloads API years earlier), that every method in these classes now fails against live GitHub, and that they're kept only so existing $github->authorization / $github->repositories->downloads call sites don't fatal. Points callers at the replacements (GitHub Apps/OAuth device flow, and Repositories\Releases).

Testing Instructions

Rely on the unittests

Documentation Changes Required

See v3-to-v4-update.md

[Hackwar]

Summary of Changes

Begins aligning the library's HTTP layer with GitHub's current REST API conventions, and flags the two package classes that target endpoints GitHub has since removed. This is phase 0 of a larger modernization pass (see update.md) — purely additive/documentation changes, no public method signatures changed.

• AbstractGithubObject::fetchUrl() now sends a default Accept: application/vnd.github+json header and pins X-GitHub-Api-Version: 2022-11-28 on every request, so responses don't silently change shape as GitHub advances its default API version. Both are only applied if the consumer hasn't already set that header themselves, and the version string is overridable via a new api.version option.
• Added a gh.token.scheme option (default token, unchanged) so callers can opt into the Bearer scheme for fine-grained PATs or GitHub App installation tokens without affecting existing classic-PAT consumers.
• Documented that the Basic Authentication (username/password) fallback in fetchUrl() no longer works against github.com — GitHub removed it in November 2020 — and is retained only for GitHub Enterprise Server compatibility.
• Expanded the @deprecated docblocks on Package\Authorization and Package\Repositories\Downloads to explain that GitHub has removed the underlying endpoints entirely (OAuth Authorizations API and Basic Auth in Nov 2020; the Downloads API years earlier), that every method in these classes now fails against live GitHub, and that they're kept only so existing $github->authorization / $github->repositories->downloads call sites don't fatal. Points callers at the replacements (GitHub Apps/OAuth device flow, and Repositories\Releases).

Testing Instructions

Rely on the unittests

Documentation Changes Required

See v3-to-v4-update.md