Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/activity.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
[Back to the navigation](README.md)

Access to Starring and Watching a Repository for [non] authenticated users.
Wrap [GitHub Activity API](https://developer.github.com/v3/activity/).
Wrap [GitHub Activity API](https://docs.github.com/rest/activity).

> *** No authentication required. ***

Expand Down
2 changes: 1 addition & 1 deletion doc/apps.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Applications API
[Back to the navigation](README.md)

Wraps [GitHub Applications API](http://developer.github.com/v3/apps/).
Wraps [GitHub Applications API](https://docs.github.com/rest/apps/apps).

### Create a new installation token
For the installation id 123 use the following:
Expand Down
2 changes: 1 addition & 1 deletion doc/authorizations.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Authorizations API
[Back to the navigation](README.md)

Creating, deleting and listing authorizations. Wraps [GitHub Authorizations API](http://developer.github.com/v3/oauth_authorizations/).
Creating, deleting and listing authorizations. Wraps [GitHub Authorizations API](https://docs.github.com/rest/apps/oauth-applications).

#### List all authorizations.

Expand Down
2 changes: 1 addition & 1 deletion doc/caching.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,5 @@ $client->removeCache();
```

Using cache, the client will get cached responses if resources haven't changed since last time,
**without** reaching the `X-Rate-Limit` [imposed by GitHub](http://developer.github.com/v3/#rate-limiting).
**without** reaching the `X-Rate-Limit` [imposed by GitHub](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api).

2 changes: 1 addition & 1 deletion doc/commits.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
[Back to the navigation](README.md)

Getting information on specific commits, the diffs they introduce, the files they've changed.
Wrap [GitHub Commit API](http://developer.github.com/v3/git/commits/).
Wrap [GitHub Commit API](https://docs.github.com/rest/commits/commits).

### List commits in a branch

Expand Down
2 changes: 1 addition & 1 deletion doc/copilot/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

The Copilot Usage API provides endpoints to retrieve usage summaries for organizations and enterprises.

**Note**: This endpoint is in beta and is subject to change.
**Note**: This endpoint has been deprecated by GitHub in favor of the [Copilot usage metrics API](https://docs.github.com/rest/copilot/copilot-usage-metrics).

## Endpoints

Expand Down
2 changes: 1 addition & 1 deletion doc/currentuser/emails.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Current user / Emails API
[Back to the navigation](../README.md)

Wraps [GitHub User Emails API](https://developer.github.com/v3/users/emails/#emails).
Wraps [GitHub User Emails API](https://docs.github.com/rest/users/emails).

> Requires [authentication](../security.md).

Expand Down
2 changes: 1 addition & 1 deletion doc/currentuser/memberships.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Current user / Memberships API
[Back to the navigation](../README.md)

Wraps [GitHub Issue Comments API](https://developer.github.com/v3/orgs/members/#get-your-organization-membership).
Wraps [GitHub Organization Memberships API](https://docs.github.com/rest/orgs/members).

### List your memberships

Expand Down
2 changes: 1 addition & 1 deletion doc/currentuser/publickeys.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Current user / Public Keys API
[Back to the navigation](../README.md)

Wraps [GitHub User Public Keys API](https://developer.github.com/v3/users/keys/#public-keys).
Wraps [GitHub User Public Keys API](https://docs.github.com/rest/users/keys).

### List your public keys

Expand Down
2 changes: 1 addition & 1 deletion doc/currentuser/repositories.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ There are three values that can be passed into the `repositories` method: `type`
| sort | `full_name` | `created`, `updated`, `pushed`, `full_name`
| direction | `asc` | `asc`, `desc`

> See https://developer.github.com/v3/repos/#list-your-repositories for possible values and additional information
> See https://docs.github.com/rest/repos/repos#list-repositories-for-the-authenticated-user for possible values and additional information

#### Code Example:

Expand Down
2 changes: 1 addition & 1 deletion doc/enterprise.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Enterprise API
[Back to the navigation](README.md)

Provides information about a GitHub Enterprise installation. Wraps [GitHub Enterprise API](http://developer.github.com/v3/enterprise/).
Provides information about a GitHub Enterprise installation. Wraps [GitHub Enterprise API](https://docs.github.com/rest/enterprise-admin).

### Configuration
In order to configure the client to point to a GitHub Enterprise installation, do the following:
Expand Down
2 changes: 1 addition & 1 deletion doc/enterprise/secret-scanning.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# List secret-scanning alerts for an Enterprise

https://docs.github.com/en/enterprise-server@3.5/rest/secret-scanning#list-secret-scanning-alerts-for-an-enterprise
https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise

```php
$alerts = $client->api('enterprise')->secretScanning()->alerts('KnpLabs');
Expand Down
2 changes: 1 addition & 1 deletion doc/gists.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
[Back to the navigation](README.md)

Creating, editing, deleting and listing gists.
Wraps [GitHub Gists API](http://developer.github.com/v3/gists/).
Wraps [GitHub Gists API](https://docs.github.com/rest/gists/gists).

Additional APIs:
* [Comments](gists/comments.md)
Expand Down
2 changes: 1 addition & 1 deletion doc/gists/comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[Back to the "Gists API"](../gists.md) | [Back to the navigation](../README.md)

Wraps [GitHub Issue Comments API](http://developer.github.com/v3/gists/comments/).
Wraps [GitHub Gist Comments API](https://docs.github.com/rest/gists/comments).

### List a gist comments

Expand Down
2 changes: 2 additions & 0 deletions doc/gitdata/blobs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
## Blobs API
[Back to the navigation](../README.md)

Wraps [GitHub Git Blobs API](https://docs.github.com/rest/git/blobs).

### Show a blob

```php
Expand Down
2 changes: 2 additions & 0 deletions doc/gitdata/commits.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
## Commits API
[Back to the navigation](../README.md)

Wraps [GitHub Git Commits API](https://docs.github.com/rest/git/commits).

### Show a commit

```php
Expand Down
1 change: 1 addition & 0 deletions doc/gitdata/references.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
## References API
[Back to the navigation](../README.md)

Wraps [GitHub Git References API](https://docs.github.com/rest/git/refs).

### List all references
```php
Expand Down
2 changes: 2 additions & 0 deletions doc/gitdata/tags.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
## Tags API
[Back to the navigation](../README.md)

Wraps [GitHub Git Tags API](https://docs.github.com/rest/git/tags).

### Show all tags

```php
Expand Down
2 changes: 2 additions & 0 deletions doc/gitdata/trees.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
## Trees API
[Back to the navigation](../README.md)

Wraps [GitHub Git Trees API](https://docs.github.com/rest/git/trees).

### Show a tree

```php
Expand Down
10 changes: 5 additions & 5 deletions doc/graphql.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## GraphQL API
[Back to the navigation](README.md)

Wraps [GitHub v4 API (GraphQL API)](http://developer.github.com/v4/).
Wraps [GitHub GraphQL API](https://docs.github.com/graphql).

#### Execute a query

Expand All @@ -11,7 +11,7 @@ $rateLimits = $client->api('graphql')->execute($query);

#### Authentication

To use [GitHub v4 API (GraphQL API)](http://developer.github.com/v4/) requests must [authenticate](security.md).
To use [GitHub GraphQL API](https://docs.github.com/graphql) requests must [authenticate](security.md).

```php
$client->authenticate($token, null, Github\AuthMethod::ACCESS_TOKEN);
Expand All @@ -21,9 +21,9 @@ $result = $client->api('graphql')->execute($query);

#### Use different `Accept` Headers
You can preview upcoming features and changes to the GitHub GraphQL schema before they are added to the GitHub GraphQL API.
To access a schema preview, you'll need to provide a custom media type in the Accept header for your requests. Feature documentation for each preview specifies which custom media type to provide. More info about [Schema Previews](https://docs.github.com/en/graphql/overview/schema-previews).
To access a schema preview, you'll need to provide a custom media type in the Accept header for your requests. Feature documentation for each preview specifies which custom media type to provide. More info about [Schema Previews](https://docs.github.com/graphql/overview/schema-previews).

To use [GitHub v4 API (GraphQL API)](http://developer.github.com/v4/) with different `Accept` header you can pass third argument to execute method.
To use [GitHub GraphQL API](https://docs.github.com/graphql) with different `Accept` header you can pass third argument to execute method.

```php
$result = $client->api('graphql')->execute($query, [], 'application/vnd.github.starfox-preview+json')
Expand All @@ -34,7 +34,7 @@ $result = $client->api('graphql')->execute($query, [], 'application/vnd.github.s

#### Use variables

[Variables](https://developer.github.com/v4/guides/forming-calls/#working-with-variables) allow specifying of requested data without dynamical change of a query on a client side.
[Variables](https://docs.github.com/graphql/guides/forming-calls-with-graphql#working-with-variables) allow specifying of requested data without dynamical change of a query on a client side.

```php
$query = <<<'QUERY'
Expand Down
2 changes: 1 addition & 1 deletion doc/issue/assignees.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Issues / Assignees API
[Back to the "Issues API"](../issues.md) | [Back to the navigation](../README.md)

Wraps [GitHub Issue Assignees API](https://developer.github.com/v3/issues/assignees/).
Wraps [GitHub Issue Assignees API](https://docs.github.com/rest/issues/assignees).

### List all available assignees

Expand Down
2 changes: 1 addition & 1 deletion doc/issue/comments.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Issues / Comments API
[Back to the "Issues API"](../issues.md) | [Back to the navigation](../README.md)

Wraps [GitHub Issue Comments API](http://developer.github.com/v3/issues/comments/).
Wraps [GitHub Issue Comments API](https://docs.github.com/rest/issues/comments).

### List an issue comments

Expand Down
2 changes: 1 addition & 1 deletion doc/issue/labels.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Issues / Labels API
[Back to the "Issues API"](../issues.md) | [Back to the navigation](../README.md)

Wraps [GitHub Issue Labels API](http://developer.github.com/v3/issues/labels/).
Wraps [GitHub Issue Labels API](https://docs.github.com/rest/issues/labels).

### List project labels

Expand Down
2 changes: 1 addition & 1 deletion doc/issue/milestones.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Issues / Milestones API
[Back to the "Issues API"](../issues.md) | [Back to the navigation](../README.md)

Wraps [GitHub Issue Milestones API](http://developer.github.com/v3/issues/milestones/).
Wraps [GitHub Issue Milestones API](https://docs.github.com/rest/issues/milestones).

### List milestones for a repository

Expand Down
2 changes: 1 addition & 1 deletion doc/issue/timeline.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Issues / Timeline API
[Back to the "Issues API"](../issues.md) | [Back to the navigation](../README.md)

Wraps [GitHub Issue Timeline API](http://developer.github.com/v3/issues/timeline/).
Wraps [GitHub Issue Timeline API](https://docs.github.com/rest/issues/timeline).

This api is currently only available to developers in Early Access. To access the API during the Early Access period,
you must provide a custom media type in the Accept header.
Expand Down
2 changes: 1 addition & 1 deletion doc/issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
[Back to the navigation](README.md)

Listing issues, searching, editing and closing your projects issues.
Wraps [GitHub Issue API](http://developer.github.com/v3/issues/).
Wraps [GitHub Issue API](https://docs.github.com/rest/issues/issues).

Additional APIs:
* [Comments](issue/comments.md)
Expand Down
2 changes: 1 addition & 1 deletion doc/meta.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
[Back to the navigation](README.md)


Wrap [GitHub Meta API](http://developer.github.com/v3/meta/).
Wrap [GitHub Meta API](https://docs.github.com/rest/meta/meta).

### Get information about GitHub services

Expand Down
2 changes: 2 additions & 0 deletions doc/miscellaneous/codeofconduct.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
## CodeOfConduct API
[Back to the navigation](../README.md)

Wraps [GitHub Codes of conduct API](https://docs.github.com/rest/codes-of-conduct/codes-of-conduct).

### Lists all code of conducts.

```php
Expand Down
2 changes: 2 additions & 0 deletions doc/miscellaneous/emojis.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
## Emojis API
[Back to the navigation](../README.md)

Wraps [GitHub Emojis API](https://docs.github.com/rest/emojis/emojis).

### Lists all available emojis on GitHub.

```php
Expand Down
2 changes: 2 additions & 0 deletions doc/miscellaneous/gitignore.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
## Gitignore API
[Back to the navigation](../README.md)

Wraps [GitHub Gitignore API](https://docs.github.com/rest/gitignore/gitignore).

### Lists all available gitignore templates

```php
Expand Down
2 changes: 2 additions & 0 deletions doc/miscellaneous/licenses.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
## Licenses API
[Back to the navigation](../README.md)

Wraps [GitHub Licenses API](https://docs.github.com/rest/licenses/licenses).

### Lists all licenses.

```php
Expand Down
2 changes: 2 additions & 0 deletions doc/miscellaneous/markdown.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
## Markdown API
[Back to the navigation](../README.md)

Wraps [GitHub Markdown API](https://docs.github.com/rest/markdown/markdown).

### Render an arbitrary Markdown document

```php
Expand Down
2 changes: 1 addition & 1 deletion doc/notification.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
[Back to the navigation](README.md)

Listing notifications and marking them as read.
Wraps [GitHub Notification API](https://developer.github.com/v3/activity/notifications/).
Wraps [GitHub Notification API](https://docs.github.com/rest/activity/notifications).

### List notifications

Expand Down
4 changes: 2 additions & 2 deletions doc/organization.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
## Organization API
[Back to the navigation](README.md)

Wraps [GitHub Organization API](http://developer.github.com/v3/orgs/).
Wraps [GitHub Organization API](https://docs.github.com/rest/orgs/orgs).

Additional APIs:
* [Members API](organization/members.md)
* [Teams API](organization/teams.md)

### List issues in an organization
[GitHub Issues API](https://developer.github.com/v3/issues/).
[GitHub Issues API](https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user).

```php
$issues = $client->api('organizations')->issues('KnpLabs', 'php-github-api', array('state' => 'open'));
Expand Down
Loading
Loading