Skip to content

Commit 28deb38

Browse files
authored
Remove hardcoded links from GHEC docs to FPT GraphQL docs (#28973)
1 parent 4e579a1 commit 28deb38

File tree

22 files changed

+41
-32
lines changed

22 files changed

+41
-32
lines changed

content/actions/deployment/targeting-different-environments/using-environments-for-deployment.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ You can also delete environments through the REST API. For more information, see
129129

130130
{% data reusables.actions.environment-deployment-event %}
131131

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)."
133133

134134
## Next steps
135135

content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ Because user-level permissions are granted on an individual user basis, you can
158158

159159
## User-to-server requests
160160

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.
162162

163163
### Supported endpoints
164164

content/developers/apps/building-github-apps/rate-limits-for-github-apps.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -82,4 +82,4 @@ The rate limits for user-to-server requests made by {% data variables.product.pr
8282
## Further reading
8383

8484
- "[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

content/developers/apps/getting-started-with-apps/migrating-oauth-apps-to-github-apps.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,13 @@ These guidelines assume that you have a registered OAuth App{% ifversion fpt or
4646

4747
### Review the available API endpoints for GitHub Apps
4848

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.
5050

5151
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 %}.
5252

5353
### Design to stay within API rate limits
5454

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).
5656

5757
### Register a new GitHub App
5858

content/developers/apps/guides/creating-ci-tests-with-the-checks-api.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ To get an idea of what your Checks API CI server will do when you've completed t
5252

5353
## Prerequisites
5454

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.
5656

5757
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.
5858

content/developers/apps/guides/using-content-attachments.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ curl -X "POST" "{% data variables.product.api_url_code %}/graphql" \
118118
}'
119119
```
120120

121-
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)."
122122

123123
## Example using Probot and GitHub App Manifests
124124

content/developers/overview/about-githubs-apis.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ topics:
1414
- API
1515
---
1616

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).
1818

1919
## Deprecated versions
2020

content/developers/webhooks-and-events/events/issue-event-types.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ Name | Type | Description
131131
`html_url` | `string` | The HTML URL of the issue comment.
132132
`issue_url` | `string` | The HTML URL of the issue.
133133
`id` | `integer` | The unique identifier of the event.
134-
`node_id` | `string` | The [Global Node ID]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql/guides/using-global-node-ids) of the event.
134+
`node_id` | `string` | The [Global Node ID](/graphql/guides/using-global-node-ids) of the event.
135135
`user` | `object` | The person who commented on the issue.
136136
`created_at` | `string` | The timestamp indicating when the comment was added.
137137
`updated_at` | `string` | The timestamp indicating when the comment was updated or created, if the comment is never updated.
@@ -157,7 +157,7 @@ A commit was added to the pull request's `HEAD` branch.
157157
Name | Type | Description
158158
-----|------|--------------
159159
`sha` | `string` | The SHA of the commit in the pull request.
160-
`node_id` | `string` | The [Global Node ID]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql/guides/using-global-node-ids) of the event.
160+
`node_id` | `string` | The [Global Node ID](/graphql/guides/using-global-node-ids) of the event.
161161
`url` | `string` | The REST API URL to retrieve the commit.
162162
`html_url` | `string` | The HTML URL of the commit.
163163
`author` | `object` | The person who authored the commit.
@@ -594,7 +594,7 @@ The pull request was reviewed.
594594
Name | Type | Description
595595
-----|------|--------------
596596
`id` | `integer` | The unique identifier of the event.
597-
`node_id` | `string` | The [Global Node ID]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql/guides/using-global-node-ids) of the event.
597+
`node_id` | `string` | The [Global Node ID](/graphql/guides/using-global-node-ids) of the event.
598598
`user` | `object` | The person who commented on the issue.
599599
`body` | `string` | The review summary text.
600600
`commit_id` | `string` | The SHA of the latest commit in the pull request at the time of the review.

content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -399,7 +399,7 @@ Key | Type | Description
399399
400400
{% data reusables.webhooks.discussions-webhooks-beta %}
401401
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)."
403403
### Availability
404404
405405
- Repository webhooks
@@ -424,7 +424,7 @@ Key | Type | Description
424424
425425
{% data reusables.webhooks.discussions-webhooks-beta %}
426426
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)."
428428
429429
### Availability
430430
@@ -437,7 +437,7 @@ Activity related to a comment in a discussion. For more information, see "[Using
437437
Key | Type | Description
438438
----|------|-------------
439439
`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.
441441
{% data reusables.webhooks.discussion_desc %}
442442
{% data reusables.webhooks.repo_desc_graphql %}
443443
{% data reusables.webhooks.org_desc_graphql %}

content/graphql/guides/using-the-graphql-api-for-discussions.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ title: Using the GraphQL API for Discussions
33
intro: 'Learn how to use the {% data variables.product.prodname_discussions %} GraphQL API.'
44
versions:
55
fpt: '*'
6+
ghec: '*'
67
shortTitle: Use GraphQL for Discussions
78
---
89

content/issues/trying-out-the-new-projects-experience/using-the-api-to-manage-projects.md

+12-4
Original file line numberDiff line numberDiff line change
@@ -52,13 +52,13 @@ gh api graphql -f query='
5252
}' -f organization=$my_org -F number=$my_num
5353
```
5454

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)."
5656

5757
{% endcli %}
5858

5959
## Finding information about projects
6060

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)."
6262

6363
### Finding the node ID of an organization project
6464

@@ -430,7 +430,7 @@ A project may contain items that a user does not have permission to view. In thi
430430
431431
## Updating projects
432432
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)."
434434
435435
{% note %}
436436
@@ -594,7 +594,15 @@ gh api graphql -f query='
594594

595595
{% note %}
596596

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:
598+
599+
- [addAssigneesToAssignable](/graphql/reference/mutations#addassigneestoassignable)
600+
- [removeAssigneesFromAssignable](/graphql/reference/mutations#removeassigneesfromassignable)
601+
- [addLabelsToLabelable](/graphql/reference/mutations#addlabelstolabelable)
602+
- [removeLabelsFromLabelable](/graphql/reference/mutations#removelabelsfromlabelable)
603+
- [updateIssue](/graphql/reference/mutations#updateissue)
604+
- [updatePullRequest](/graphql/reference/mutations#updatepullrequest)
605+
- [transferIssue](/graphql/reference/mutations#transferissue)
598606

599607
{% endnote %}
600608

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 numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ Note that you can't retrieve Git events using the GraphQL API. To retrieve Git e
164164

165165
The GraphQL response can include data for up to 90 to 120 days.
166166

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/)."
168168

169169
{% ifversion ghec %}
170170

content/packages/learn-github-packages/deleting-and-restoring-a-package.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -105,9 +105,9 @@ curl -X POST \
105105
HOSTNAME/graphql
106106
```
107107

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.
109109

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)."
111111

112112
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 %}.
113113

content/packages/learn-github-packages/introduction-to-github-packages.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ You can delete a private or public package in the {% data variables.product.prod
112112
You can delete a version of a package in the {% data variables.product.product_name %} user interface or using the GraphQL API.
113113
{% endif %}
114114

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)."
116116

117117
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)."
118118

content/rest/overview/resources-in-the-rest-api.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ $ curl {% ifversion fpt or ghae or ghec %}
184184
185185
## GraphQL global node IDs
186186
187-
See the guide on "[Using Global Node IDs]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/guides/using-global-node-ids)" for detailed information about how to find `node_id`s via the REST API and use them in GraphQL operations.
187+
See the guide on "[Using Global Node IDs](/graphql/guides/using-global-node-ids)" for detailed information about how to find `node_id`s via the REST API and use them in GraphQL operations.
188188
189189
## Client errors
190190

content/rest/rate-limit.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The REST API overview documentation describes the [rate limit rules](/rest/overv
1919

2020
### Understanding your rate limit status
2121

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.
2323

2424
For these reasons, the Rate Limit API response categorizes your rate limit. Under `resources`, you'll see four
2525
objects:
@@ -28,7 +28,7 @@ objects:
2828

2929
* The `search` object provides your rate limit status for the [Search API](/rest/reference/search).
3030

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).
3232

3333
* 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.
3434

0 commit comments

Comments
 (0)