Skip to content

Enhance REST API documentation with conditional requests #43138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
JustinGrote wants to merge 2 commits into
base: main
Choose a base branch
from
+2 −0
Open

Enhance REST API documentation with conditional requests #43138

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8fdec7a
Enhance REST API documentation with conditional requests
JustinGrote Feb 26, 2026
1897929
Update content/rest/about-the-rest-api/comparing-githubs-rest-api-and…
JustinGrote Feb 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions content/rest/about-the-rest-api/comparing-githubs-rest-api-and-graphql-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,3 +82,5 @@ mutation {
}
}
```

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)
Copy link

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Suggested change
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)

Copilot uses AI. Check for mistakes.
Copy link

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
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)

Copilot uses AI. Check for mistakes.
Loading