You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/actions/deployment/targeting-different-environments/using-environments-for-deployment.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -129,7 +129,7 @@ You can also delete environments through the REST API. For more information, see
129
129
130
130
{% data reusables.actions.environment-deployment-event %}
131
131
132
-
You can access these objects through the REST API or GraphQL API. You can also subscribe to these webhook events. For more information, see "[Repositories](/rest/reference/repos#deployments)" (REST API), "[Objects]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql/reference/objects#deployment)" (GraphQL API), or "[Webhook events and payloads](/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment)."
132
+
You can access these objects through the REST API or GraphQL API. You can also subscribe to these webhook events. For more information, see "[Repositories](/rest/reference/repos#deployments)" (REST API), "[Objects](/graphql/reference/objects#deployment)" (GraphQL API), or "[Webhook events and payloads](/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment)."
Copy file name to clipboardExpand all lines: content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -158,7 +158,7 @@ Because user-level permissions are granted on an individual user basis, you can
158
158
159
159
## User-to-server requests
160
160
161
-
While most of your API interaction should occur using your server-to-server installation access tokens, certain endpoints allow you to perform actions via the API using a user access token. Your app can make the following requests using [GraphQL]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql) or [REST](/rest) endpoints.
161
+
While most of your API interaction should occur using your server-to-server installation access tokens, certain endpoints allow you to perform actions via the API using a user access token. Your app can make the following requests using [GraphQL](/graphql) or [REST](/rest) endpoints.
Copy file name to clipboardExpand all lines: content/developers/apps/building-github-apps/rate-limits-for-github-apps.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -82,4 +82,4 @@ The rate limits for user-to-server requests made by {% data variables.product.pr
82
82
## Further reading
83
83
84
84
- "[Rate limiting](/rest/overview/resources-in-the-rest-api#rate-limiting)" in the REST API documentation
85
-
- "[Resource limitations]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql/overview/resource-limitations)" in the GraphQL API documentation
85
+
- "[Resource limitations](/graphql/overview/resource-limitations)" in the GraphQL API documentation
Copy file name to clipboardExpand all lines: content/developers/apps/getting-started-with-apps/migrating-oauth-apps-to-github-apps.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -46,13 +46,13 @@ These guidelines assume that you have a registered OAuth App{% ifversion fpt or
46
46
47
47
### Review the available API endpoints for GitHub Apps
48
48
49
-
While the majority of [REST API](/rest) endpoints and [GraphQL]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql) queries are available to GitHub Apps today, we are still in the process of enabling some endpoints. Review the [available REST endpoints](/rest/overview/endpoints-available-for-github-apps) to ensure that the endpoints you need are compatible with GitHub Apps. Note that some of the API endpoints enabled for GitHub Apps allow the app to act on behalf of the user. See "[User-to-server requests](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#user-to-server-requests)" for a list of endpoints that allow a GitHub App to authenticate as a user.
49
+
While the majority of [REST API](/rest) endpoints and [GraphQL](/graphql) queries are available to GitHub Apps today, we are still in the process of enabling some endpoints. Review the [available REST endpoints](/rest/overview/endpoints-available-for-github-apps) to ensure that the endpoints you need are compatible with GitHub Apps. Note that some of the API endpoints enabled for GitHub Apps allow the app to act on behalf of the user. See "[User-to-server requests](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#user-to-server-requests)" for a list of endpoints that allow a GitHub App to authenticate as a user.
50
50
51
51
We recommend reviewing the list of API endpoints you need as early as possible. Please let Support know if there is an endpoint you require that is not yet enabled for {% data variables.product.prodname_github_apps %}.
52
52
53
53
### Design to stay within API rate limits
54
54
55
-
GitHub Apps use [sliding rules for rate limits](/apps/building-github-apps/understanding-rate-limits-for-github-apps/), which can increase based on the number of repositories and users in the organization. A GitHub App can also make use of [conditional requests](/rest/overview/resources-in-the-rest-api#conditional-requests) or consolidate requests by using the [GraphQL API]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql).
55
+
GitHub Apps use [sliding rules for rate limits](/apps/building-github-apps/understanding-rate-limits-for-github-apps/), which can increase based on the number of repositories and users in the organization. A GitHub App can also make use of [conditional requests](/rest/overview/resources-in-the-rest-api#conditional-requests) or consolidate requests by using the [GraphQL API](/graphql).
Copy file name to clipboardExpand all lines: content/developers/apps/guides/creating-ci-tests-with-the-checks-api.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -52,7 +52,7 @@ To get an idea of what your Checks API CI server will do when you've completed t
52
52
53
53
## Prerequisites
54
54
55
-
Before you get started, you may want to familiarize yourself with [GitHub Apps](/apps/), [Webhooks](/webhooks), and the [Checks API](/rest/reference/checks), if you're not already. You'll find more APIs in the [REST API docs](/rest). The Checks API is also available to use in [GraphQL]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql), but this quickstart focuses on REST. See the GraphQL [Checks Suite]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql/reference/objects#checksuite) and [Check Run]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql/reference/objects#checkrun) objects for more details.
55
+
Before you get started, you may want to familiarize yourself with [GitHub Apps](/apps/), [Webhooks](/webhooks), and the [Checks API](/rest/reference/checks), if you're not already. You'll find more APIs in the [REST API docs](/rest). The Checks API is also available to use in [GraphQL](/graphql), but this quickstart focuses on REST. See the GraphQL [Checks Suite](/graphql/reference/objects#checksuite) and [Check Run](/graphql/reference/objects#checkrun) objects for more details.
56
56
57
57
You'll use the [Ruby programming language](https://www.ruby-lang.org/en/), the [Smee](https://smee.io/) webhook payload delivery service, the [Octokit.rb Ruby library](http://octokit.github.io/octokit.rb/) for the GitHub REST API, and the [Sinatra web framework](http://sinatrarb.com/) to create your Checks API CI server app.
For more information on `node_id`, see "[Using Global Node IDs]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql/guides/using-global-node-ids)."
121
+
For more information on `node_id`, see "[Using Global Node IDs](/graphql/guides/using-global-node-ids)."
Copy file name to clipboardExpand all lines: content/developers/overview/about-githubs-apis.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ topics:
14
14
- API
15
15
---
16
16
17
-
There are two stable versions of the GitHub API: the [REST API](/rest) and the [GraphQL API]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql).
17
+
There are two stable versions of the GitHub API: the [REST API](/rest) and the [GraphQL API](/graphql).
Copy file name to clipboardExpand all lines: content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -399,7 +399,7 @@ Key | Type | Description
399
399
400
400
{% data reusables.webhooks.discussions-webhooks-beta %}
401
401
402
-
Activity related to a discussion. For more information, see the "[Using the GraphQL API for discussions]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql/guides/using-the-graphql-api-for-discussions)."
402
+
Activity related to a discussion. For more information, see the "[Using the GraphQL API for discussions](/graphql/guides/using-the-graphql-api-for-discussions)."
403
403
### Availability
404
404
405
405
- Repository webhooks
@@ -424,7 +424,7 @@ Key | Type | Description
424
424
425
425
{% data reusables.webhooks.discussions-webhooks-beta %}
426
426
427
-
Activity related to a comment in a discussion. For more information, see "[Using the GraphQL API for discussions]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql/guides/using-the-graphql-api-for-discussions)."
427
+
Activity related to a comment in a discussion. For more information, see "[Using the GraphQL API for discussions](/graphql/guides/using-the-graphql-api-for-discussions)."
428
428
429
429
### Availability
430
430
@@ -437,7 +437,7 @@ Activity related to a comment in a discussion. For more information, see "[Using
437
437
Key | Type | Description
438
438
----|------|-------------
439
439
`action`|`string`| The action performed. Can be `created`, `edited`, or `deleted`.
440
-
`comment`|`object`| The [`discussion comment`]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql/guides/using-the-graphql-api-for-discussions#discussioncomment) resource.
440
+
`comment`|`object`| The [`discussion comment`](/graphql/guides/using-the-graphql-api-for-discussions#discussioncomment) resource.
Copy file name to clipboardExpand all lines: content/issues/trying-out-the-new-projects-experience/using-the-api-to-manage-projects.md
+12-4
Original file line number
Diff line number
Diff line change
@@ -52,13 +52,13 @@ gh api graphql -f query='
52
52
}' -f organization=$my_org -F number=$my_num
53
53
```
54
54
55
-
For more information, see "[Forming calls with GraphQL]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/guides/forming-calls-with-graphql#working-with-variables)."
55
+
For more information, see "[Forming calls with GraphQL](/graphql/guides/forming-calls-with-graphql#working-with-variables)."
56
56
57
57
{% endcli %}
58
58
59
59
## Finding information about projects
60
60
61
-
Use queries to get data about projects. For more information, see "[About queries]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/guides/forming-calls-with-graphql#about-queries)."
61
+
Use queries to get data about projects. For more information, see "[About queries](/graphql/guides/forming-calls-with-graphql#about-queries)."
62
62
63
63
### Finding the node ID of an organization project
64
64
@@ -430,7 +430,7 @@ A project may contain items that a user does not have permission to view. In thi
430
430
431
431
## Updating projects
432
432
433
-
Use mutations to update projects. For more information, see "[About mutations]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql/guides/forming-calls-with-graphql#about-mutations)."
433
+
Use mutations to update projects. For more information, see "[About mutations](/graphql/guides/forming-calls-with-graphql#about-mutations)."
434
434
435
435
{% note %}
436
436
@@ -594,7 +594,15 @@ gh api graphql -f query='
594
594
595
595
{% note %}
596
596
597
-
**Note:** You cannot use `updateProjectV2ItemFieldValue` to change `Assignees`, `Labels`, `Milestone`, or `Repository` because these fields are properties of pull requests and issues, not of project items. Instead, you must use the [addAssigneesToAssignable]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/reference/mutations#addassigneestoassignable), [removeAssigneesFromAssignable]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/reference/mutations#removeassigneesfromassignable), [addLabelsToLabelable]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/reference/mutations#addlabelstolabelable), [removeLabelsFromLabelable]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/reference/mutations#removelabelsfromlabelable), [updateIssue]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/reference/mutations#updateissue), [updatePullRequest]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/reference/mutations#updatepullrequest), or [transferIssue]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/reference/mutations#transferissue) mutations.
597
+
**Note:** You cannot use `updateProjectV2ItemFieldValue` to change `Assignees`, `Labels`, `Milestone`, or `Repository` because these fields are properties of pull requests and issues, not of project items. Instead, you may use the following mutations:
Copy file name to clipboardExpand all lines: content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -164,7 +164,7 @@ Note that you can't retrieve Git events using the GraphQL API. To retrieve Git e
164
164
165
165
The GraphQL response can include data for up to 90 to 120 days.
166
166
167
-
For example, you can make a GraphQL request to see all the new organization members added to your organization. For more information, see the "[GraphQL API Audit Log]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/reference/interfaces#auditentry/)."
167
+
For example, you can make a GraphQL request to see all the new organization members added to your organization. For more information, see the "[GraphQL API Audit Log](/graphql/reference/interfaces#auditentry/)."
Copy file name to clipboardExpand all lines: content/packages/learn-github-packages/deleting-and-restoring-a-package.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -105,9 +105,9 @@ curl -X POST \
105
105
HOSTNAME/graphql
106
106
```
107
107
108
-
To find all of the private packages you have published to {% data variables.product.prodname_registry %}, along with the version IDs for the packages, you can use the `packages` connection through the `repository` object. You will need a token with the `read:packages` and `repo` scopes. For more information, see the [`packages`]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql/reference/objects#repository) connection or the [`PackageOwner`]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql/reference/interfaces#packageowner) interface.
108
+
To find all of the private packages you have published to {% data variables.product.prodname_registry %}, along with the version IDs for the packages, you can use the `packages` connection through the `repository` object. You will need a token with the `read:packages` and `repo` scopes. For more information, see the [`packages`](/graphql/reference/objects#repository) connection or the [`PackageOwner`](/graphql/reference/interfaces#packageowner) interface.
109
109
110
-
For more information about the `deletePackageVersion` mutation, see "[`deletePackageVersion`]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql/reference/mutations#deletepackageversion)."
110
+
For more information about the `deletePackageVersion` mutation, see "[`deletePackageVersion`](/graphql/reference/mutations#deletepackageversion)."
111
111
112
112
You cannot directly delete an entire package using GraphQL, but if you delete every version of a package, the package will no longer show on {% data variables.product.product_name %}.
Copy file name to clipboardExpand all lines: content/packages/learn-github-packages/introduction-to-github-packages.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -112,7 +112,7 @@ You can delete a private or public package in the {% data variables.product.prod
112
112
You can delete a version of a package in the {% data variables.product.product_name %} user interface or using the GraphQL API.
113
113
{% endif %}
114
114
115
-
When you use the GraphQL API to query and delete private packages, you must use the same token you use to authenticate to {% data variables.product.prodname_registry %}. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" and "[Forming calls with GraphQL]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql/guides/forming-calls-with-graphql)."
115
+
When you use the GraphQL API to query and delete private packages, you must use the same token you use to authenticate to {% data variables.product.prodname_registry %}. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" and "[Forming calls with GraphQL](/graphql/guides/forming-calls-with-graphql)."
116
116
117
117
You can configure webhooks to subscribe to package-related events, such as when a package is published or updated. For more information, see the "[`package` webhook event](/webhooks/event-payloads/#package)."
Copy file name to clipboardExpand all lines: content/rest/overview/resources-in-the-rest-api.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -184,7 +184,7 @@ $ curl {% ifversion fpt or ghae or ghec %}
184
184
185
185
## GraphQL global node IDs
186
186
187
-
See the guide on "[Using Global Node IDs]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/guides/using-global-node-ids)"fordetailed information about how to find `node_id`s via the REST API and use themin GraphQL operations.
187
+
See the guide on "[Using Global Node IDs](/graphql/guides/using-global-node-ids)"fordetailed information about how to find `node_id`s via the REST API and use themin GraphQL operations.
Copy file name to clipboardExpand all lines: content/rest/rate-limit.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ The REST API overview documentation describes the [rate limit rules](/rest/overv
19
19
20
20
### Understanding your rate limit status
21
21
22
-
The Search API has a [custom rate limit](/rest/reference/search#rate-limit), separate from the rate limit governing the rest of the REST API. The GraphQL API also has a [custom rate limit]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/overview/resource-limitations#rate-limit) that is separate from and calculated differently than rate limits in the REST API.
22
+
The Search API has a [custom rate limit](/rest/reference/search#rate-limit), separate from the rate limit governing the rest of the REST API. The GraphQL API also has a [custom rate limit](/graphql/overview/resource-limitations#rate-limit) that is separate from and calculated differently than rate limits in the REST API.
23
23
24
24
For these reasons, the Rate Limit API response categorizes your rate limit. Under `resources`, you'll see four
25
25
objects:
@@ -28,7 +28,7 @@ objects:
28
28
29
29
* The `search` object provides your rate limit status for the [Search API](/rest/reference/search).
30
30
31
-
* The `graphql` object provides your rate limit status for the [GraphQL API]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql).
31
+
* The `graphql` object provides your rate limit status for the [GraphQL API](/graphql).
32
32
33
33
* The `integration_manifest` object provides your rate limit status for the [GitHub App Manifest code conversion](/apps/building-github-apps/creating-github-apps-from-a-manifest/#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration) endpoint.
0 commit comments