Skip to content

Commit d1fed60

Browse files
authored
Merge pull request #22557 from github/repo-sync
repo sync
2 parents f8fb8be + 848c5a6 commit d1fed60

File tree

60 files changed

+1196
-1559
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+1196
-1559
lines changed

content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -117,11 +117,11 @@ For more information about the audit log REST API, see "[Enterprise administrati
117117

118118
### Example 1: All events in an enterprise, for a specific date, with pagination
119119

120-
You can use page-based pagination or cursor based pagination. For more information, see "[Traversing with Pagination](/rest/guides/traversing-with-pagination)."
120+
You can use page-based pagination or cursor based pagination. For more information about pagination, see "[Using pagination in the REST API](/rest/guides/using-pagination-in-the-rest-api)."
121121

122122
#### Example with page-based pagination
123123

124-
The query below searches for audit log events created on Jan 1st, 2022 in the `avocado-corp` enterprise, and return the first page with a maximum of 100 items per page using [REST API pagination](/rest/overview/resources-in-the-rest-api#pagination):
124+
The query below searches for audit log events created on Jan 1st, 2022 in the `avocado-corp` enterprise, and return the first page with a maximum of 100 items per page using pagination. For more information about pagination, see "[Using pagination in the REST API](/rest/guides/using-pagination-in-the-rest-api)."
125125

126126
```shell
127127
curl -H "Authorization: Bearer TOKEN" \
@@ -131,7 +131,7 @@ curl -H "Authorization: Bearer TOKEN" \
131131

132132
#### Example with cursor-based pagination
133133

134-
The query below searches for audit log events created on Jan 1st, 2022 in the `avocado-corp` enterprise, and returns the first page with a maximum of 100 items per page using [REST API pagination](/rest/overview/resources-in-the-rest-api#pagination). The `--include` flag causes the headers to be returned along with the response.
134+
The query below searches for audit log events created on Jan 1st, 2022 in the `avocado-corp` enterprise, and returns the first page with a maximum of 100 items per page using pagination. For more information about pagination, see "[Using pagination in the REST API](/rest/guides/using-pagination-in-the-rest-api)." The `--include` flag causes the headers to be returned along with the response.
135135

136136
```
137137
curl --include -H "Authorization: Bearer TOKEN" \

content/rest/guides/best-practices-for-integrators.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Often, API responses contain data in the form of URLs. For example, when request
6161

6262
For the stability of your app, you shouldn't try to parse this data or try to guess and construct the format of future URLs. Your app is liable to break if we decide to change the URL.
6363

64-
For example, when working with paginated results, it's often tempting to construct URLs that append `?page=<number>` to the end. Avoid that temptation. [Our guide on pagination](/guides/traversing-with-pagination) offers some safe tips on dependably following paginated results.
64+
For example, when working with paginated results, it's often tempting to construct URLs that append `?page=<number>` to the end. Avoid that temptation. For more information about dependably following paginated results, see "[Using pagination in the REST API](/rest/guides/using-pagination-in-the-rest-api)."
6565

6666
## Check the event type and action before processing the event
6767

content/rest/guides/discovering-resources-for-a-user.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ In addition to having their own personal repositories, a user may be a collabora
3030

3131
[OAuth scopes][scopes] and [organization application policies][oap] determine which of those repositories your app can access for a user. Use the workflow below to discover those repositories.
3232

33-
As always, first we'll require [GitHub's Octokit.rb][octokit.rb] Ruby library. Then we'll configure Octokit.rb to automatically handle [pagination][pagination] for us.
33+
As always, first we'll require [GitHub's Octokit.rb][octokit.rb] Ruby library. Then we'll configure Octokit.rb to automatically handle pagination for us. For more information about pagination, see "[Using pagination in the REST API](/rest/guides/using-pagination-in-the-rest-api)."
3434

3535
``` ruby
3636
require 'octokit'
@@ -67,7 +67,7 @@ end
6767

6868
Applications can perform all sorts of organization-related tasks for a user. To perform these tasks, the app needs an [OAuth authorization][scopes] with sufficient permission. For example, the `read:org` scope allows you to [list teams][list-teams], and the `user` scope lets you [publicize the user’s organization membership][publicize-membership]. Once a user has granted one or more of these scopes to your app, you're ready to fetch the user’s organizations.
6969

70-
Just as we did when discovering repositories above, we'll start by requiring [GitHub's Octokit.rb][octokit.rb] Ruby library and configuring it to take care of [pagination][pagination] for us:
70+
Just as we did when discovering repositories above, we'll start by requiring [GitHub's Octokit.rb][octokit.rb] Ruby library and configuring it to take care of pagination for us. For more information about pagination, see "[Using pagination in the REST API](/rest/guides/using-pagination-in-the-rest-api)."
7171

7272
``` ruby
7373
require 'octokit'
@@ -105,7 +105,6 @@ As an application, you typically want all of the user's organizations that your
105105
[make-authenticated-request-for-user]: /rest/guides/basics-of-authentication#making-authenticated-requests
106106
[oap]: https://developer.github.com/changes/2015-01-19-an-integrators-guide-to-organization-application-policies/
107107
[octokit.rb]: https://github.com/octokit/octokit.rb
108-
[pagination]: /rest#pagination
109108
[platform samples]: https://github.com/github/platform-samples/tree/master/api/ruby/discovering-resources-for-a-user
110109
[publicize-membership]: /rest/reference/orgs#set-public-organization-membership-for-the-authenticated-user
111110
[register-oauth-app]: /rest/guides/basics-of-authentication#registering-your-app

content/rest/guides/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ children:
1818
- /delivering-deployments
1919
- /rendering-data-as-graphs
2020
- /working-with-comments
21-
- /traversing-with-pagination
21+
- /using-pagination-in-the-rest-api
2222
- /building-a-ci-server
2323
- /best-practices-for-integrators
2424
- /getting-started-with-the-git-database-api

0 commit comments

Comments
 (0)