Enhance REST API documentation with conditional requests#43138
Enhance REST API documentation with conditional requests#43138JustinGrote wants to merge 1 commit intogithub:mainfrom
Conversation
Added information about conditional requests in the REST API.
|
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
How to review these changes 👓Thank you for your contribution. To review these changes, choose one of the following options: A Hubber will need to deploy your changes internally to review. Table of review linksNote: Please update the URL for your staging server or codespace. The table shows the files in the
Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server 🤖 This comment is automatically generated. |
github-actions
bot
added
the
triage
There was a problem hiding this comment.
Pull request overview
This pull request adds documentation about conditional requests to the REST API comparison article. The change highlights a key feature of the REST API that can help developers optimize their API usage and avoid rate limit charges by using HTTP caching headers.
Changes:
- Added a new paragraph explaining conditional requests in the REST API, including the use of etag and If-Modified-Since headers with a link to best practices documentation
| } | ||
| ``` | ||
|
|
||
| The REST API also has the concept of conditional requests, which allow you to use ETAG and If-None-Modified headers to observe if the previous query has changed without incurring a rate limit query charge. For more info, see: [AUTOTITLE](/rest/using-the-rest-api/best-practices-for-using-the-rest-api#use-conditional-requests-if-appropriate) |
There was a problem hiding this comment.
The header name should be lowercase "etag" not uppercase "ETAG" to match HTTP header conventions and the consistent usage throughout the documentation (see the linked article at line 72 and other REST API documentation).
| The REST API also has the concept of conditional requests, which allow you to use ETAG and If-None-Modified headers to observe if the previous query has changed without incurring a rate limit query charge. For more info, see: [AUTOTITLE](/rest/using-the-rest-api/best-practices-for-using-the-rest-api#use-conditional-requests-if-appropriate) | |
| The REST API also has the concept of conditional requests, which allow you to use etag and If-None-Modified headers to observe if the previous query has changed without incurring a rate limit query charge. For more info, see: [AUTOTITLE](/rest/using-the-rest-api/best-practices-for-using-the-rest-api#use-conditional-requests-if-appropriate) |
| } | ||
| ``` | ||
|
|
||
| The REST API also has the concept of conditional requests, which allow you to use ETAG and If-None-Modified headers to observe if the previous query has changed without incurring a rate limit query charge. For more info, see: [AUTOTITLE](/rest/using-the-rest-api/best-practices-for-using-the-rest-api#use-conditional-requests-if-appropriate) |
There was a problem hiding this comment.
The header name "If-None-Modified" is incorrect. The correct HTTP header name is "If-Modified-Since". The linked article confirms this uses "if-modified-since" as the proper header name.
| The REST API also has the concept of conditional requests, which allow you to use ETAG and If-None-Modified headers to observe if the previous query has changed without incurring a rate limit query charge. For more info, see: [AUTOTITLE](/rest/using-the-rest-api/best-practices-for-using-the-rest-api#use-conditional-requests-if-appropriate) | |
| The REST API also has the concept of conditional requests, which allow you to use ETag and If-Modified-Since headers to observe if the previous query has changed without incurring a rate limit query charge. For more info, see: [AUTOTITLE](/rest/using-the-rest-api/best-practices-for-using-the-rest-api#use-conditional-requests-if-appropriate) |
| } | ||
| ``` | ||
|
|
||
| The REST API also has the concept of conditional requests, which allow you to use ETAG and If-None-Modified headers to observe if the previous query has changed without incurring a rate limit query charge. For more info, see: [AUTOTITLE](/rest/using-the-rest-api/best-practices-for-using-the-rest-api#use-conditional-requests-if-appropriate) |
There was a problem hiding this comment.
The abbreviation "info" should be spelled out as "information" to match the style used consistently throughout this file and the documentation. See lines 24 and 26 of this file which use "For more information" in similar contexts.
| The REST API also has the concept of conditional requests, which allow you to use ETAG and If-None-Modified headers to observe if the previous query has changed without incurring a rate limit query charge. For more info, see: [AUTOTITLE](/rest/using-the-rest-api/best-practices-for-using-the-rest-api#use-conditional-requests-if-appropriate) | |
| The REST API also has the concept of conditional requests, which allow you to use ETAG and If-None-Modified headers to observe if the previous query has changed without incurring a rate limit query charge. For more information, see [AUTOTITLE](/rest/using-the-rest-api/best-practices-for-using-the-rest-api#use-conditional-requests-if-appropriate). |
Added information about conditional requests in the REST API.
Why:
Closes:
What's being changed (if available, include any code snippets, screenshots, or gifs):
Check off the following: