Merge pull request github#29314 from github/repo-sync

Repo sync

content/rest/guides/using-pagination-in-the-rest-api.md

@@ -19,25 +19,31 @@ shortTitle: Pagination
 
 When a response from the REST API would include many results, {% data variables.product.company_short %} will paginate the results and return a subset of the results. For example, `GET /repos/octocat/Spoon-Knife/issues` will only return 30 issues from the `octocat/Spoon-Knife` repository even though the repository includes over 1600 open issues. This makes the response easier to handle for servers and for people.
 
-This guide demonstrates how to request additional pages of results for paginated responses, how to change the number of results returned on each page, and how to write a script to fetch multiple pages of results.
+You can use the `link` header from the response to request additional pages of data. If an endpoint supports the `per_page` query parameter, you can control how many results are returned on a page.
 
-## Using link headers
+This article demonstrates how to request additional pages of results for paginated responses, how to change the number of results returned on each page, and how to write a script to fetch multiple pages of results.
 
-When a response is paginated, the response headers will include a link header. The link header will be omitted if the endpoint does not support pagination or if all results fit on a single page. The link header contains URLs that you can used to fetch additional pages of results. To see the response headers if you are using curl or {% data variables.product.prodname_cli %}, pass the `--include` flag with your request. To see the response headers if you are using a library to make requests, follow the documentation for that library. For example:
+## Using `link` headers
 
-```shell
-curl --include --request GET \
---url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \
---header "Accept: application/vnd.github+json"
-```
+When a response is paginated, the response headers will include a `link` header. If the endpoint does not support pagination, or if all results fit on a single page, the `link` header will be omitted.
+
+The `link` header contains URLs that you can use to fetch additional pages of results. For example, the previous, next, first, and last page of results.
+
+To see the response headers for a particular endpoint, you can use curl, GitHub CLI, or a library you're using to make requests. To see the response headers if you are using a library to make requests, follow the documentation for that library. To see the response headers if you are using curl or GitHub CLI, pass the `--include` flag with your request. For example:
+
+  ```shell
+  curl --include --request GET \
+  --url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \
+  --header "Accept: application/vnd.github+json"
+  ```
 
-If the response is paginated, the link header will look something like this:
+If the response is paginated, the `link` header will look something like this:
 
 ```http
 link: <https://api.github.com/repositories/1300192/issues?page=2>; rel="prev", <https://api.github.com/repositories/1300192/issues?page=4>; rel="next", <https://api.github.com/repositories/1300192/issues?page=515>; rel="last", <https://api.github.com/repositories/1300192/issues?page=1>; rel="first"
 ```
 
-The link header provides the URL for the previous, next, first, and last page of results:
+The `link` header provides the URL for the previous, next, first, and last page of results:
 
 - The URL for the previous page is followed by `rel="prev"`.
 - The URL for the next page is followed by `rel="next"`.
@@ -46,15 +52,15 @@ The link header provides the URL for the previous, next, first, and last page of
 
 In some cases, only a subset of these links are available. For example, the link to the previous page won't be included if you are on the first page of results, and the link to the last page won't be included if it can't be calculated.
 
-You can use the URLs from the link header to request another page of results. For example, to request the last page of results based on the previous example:
+You can use the URLs from the `link` header to request another page of results. For example, to request the last page of results based on the previous example:
 
 ```shell
 curl --include --request GET \
 --url "https://api.github.com/repositories/1300192/issues?page=515" \
 --header "Accept: application/vnd.github+json"
 ```
 
-The URLs in the link header use query parameters to indicate what page of results to return. The query parameters in the link URLs may differ between endpoints: each paginated endpoint will use the `page`, `before`/`after`, or `since` query parameters. (Some endpoints use the `since` parameter for something other than pagination.) In all cases, you can use the URLs in the link header to fetch additional pages of results. For more information about query parameters see "[AUTOTITLE](/rest/guides/getting-started-with-the-rest-api#using-query-parameters)."
+The URLs in the `link` header use query parameters to indicate which page of results to return. The query parameters in the `link` URLs may differ between endpoints, however each paginated endpoint will use the `page`, `before`/`after`, or `since` query parameters. (Some endpoints use the `since` parameter for something other than pagination.) In all cases, you can use the URLs in the `link` header to fetch additional pages of results. For more information about query parameters see "[AUTOTITLE](/rest/guides/getting-started-with-the-rest-api#using-query-parameters)."
 
 ## Changing the number of items per page
 
@@ -68,15 +74,15 @@ curl --include --request GET \
 --header "Accept: application/vnd.github+json"
 ```
 
-The `per_page` parameter will automatically be included in the link header. For example:
+The `per_page` parameter will automatically be included in the `link` header. For example:
 
 ```http
 link: <https://api.github.com/repositories/1300192/issues?per_page=2&page=2>; rel="next", <https://api.github.com/repositories/1300192/issues?per_page=2&page=7715>; rel="last"
 ```
 
 ## Scripting with pagination
 
-Instead of manually copying URLs from the link header, you can write a script to fetch multiple pages of results.
+Instead of manually copying URLs from the `link` header, you can write a script to fetch multiple pages of results.
 
 The following examples use JavaScript and {% data variables.product.company_short %}'s Octokit.js library. For more information about Octokit.js, see "[AUTOTITLE](/rest/guides/getting-started-with-the-rest-api?tool=javascript)" and [the Octokit.js README](https://github.com/octokit/octokit.js/#readme).
 
@@ -111,7 +117,7 @@ You can pass an optional map function to `octokit.paginate()` to end pagination
 
 If you are using another language or library that doesn't have a pagination method, you can build your own pagination method. This example still uses the Octokit.js library to make requests, but does not rely on `octokit.paginate()`.
 
-The `getPaginatedData` function makes a request to an endpoint with `octokit.request()`. The data from the response is processed by `parseData`, which handles cases where no data is returned or cases where the data that is returned is an object instead of an array. The processed data is then appended to a list that contains all of the paginated data collected so far. If the response includes a link header and if the link header includes a link for the next page, then the function uses a RegEx pattern (`nextPattern`) to get the URL for the next page. The function then repeats the previous steps, now using this new URL. Once the link header no longer includes a link to the next page, all of the results are returned.
+The `getPaginatedData` function makes a request to an endpoint with `octokit.request()`. The data from the response is processed by `parseData`, which handles cases where no data is returned or cases where the data that is returned is an object instead of an array. The processed data is then appended to a list that contains all of the paginated data collected so far. If the response includes a `link` header and if the `link` header includes a link for the next page, then the function uses a RegEx pattern (`nextPattern`) to get the URL for the next page. The function then repeats the previous steps, now using this new URL. Once the `link` header no longer includes a link to the next page, all of the results are returned.
 
 ```javascript copy
 import { Octokit } from "octokit";

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

@@ -289,10 +289,6 @@ gem:
 [rfc]: https://datatracker.ietf.org/doc/html/rfc6570
 [uri]: https://github.com/hannesg/uri_template
 
-## Pagination
-
-When a response from the REST API would include many results, {% data variables.product.company_short %} will paginate the results and return a subset of the results. You can use the link header from the response to request additional pages of data. If an endpoint supports the `per_page` query parameter, then you can control how many results are returned on a page. For more information about pagination, see "[AUTOTITLE](/rest/guides/using-pagination-in-the-rest-api)."
-
 ## Timeouts
 
 If {% data variables.product.prodname_dotcom %} takes more than 10 seconds to process an API request, {% data variables.product.prodname_dotcom %} will terminate the request and you will receive a timeout response like this: