Skip to content

Conversation

@darrelmiller
Copy link
Contributor

@darrelmiller darrelmiller commented Sep 13, 2025

This pull request makes a series of editorial and clarification improvements to the draft-ietf-httpapi-ratelimit-headers.md document. The main focus is on updating references to RFCs, improving terminology consistency, clarifying normative requirements, and correcting minor typos and phrasing for better readability and accuracy.

Key changes include:

Reference and Terminology Updates:

  • Updated references to RFC8941 (Structured Fields) and RFC6454 (Web Origin) throughout the document to use consistent shorthand (SF and WEB-ORIGIN) and improved how these are cited in the text. [1] [2] [3] [4]

Normative and Behavioral Clarifications:

  • Clarified normative language, such as changing "cannot appear" to "MUST NOT appear" for fields in the trailer section, and improved the explanation of server behavior regarding quota hints and throttling. [1] [2]

Problem Type and Example Corrections:

  • Fixed typos and improved the clarity of problem type definitions and example response bodies, including correcting "satisifed" to "satisfied" and updating policy violation field names for consistency. [1] [2]

General Editorial Improvements:

  • Improved phrasing and grammar in several sections for better readability (e.g., "an user" to "a user", "unserviced requests" to "requests not being handled"), and clarified intermediary behavior. [1] [2] [3] [4] [5]

These changes help ensure the document is more precise, easier to understand, and consistent in its use of terminology and references.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR addresses various editorial issues in the IETF HTTP API rate limit headers specification document, focusing on improving clarity, consistency, and correctness throughout the document.

  • Fixes spelling and grammatical errors throughout the document
  • Updates reference formatting to use consistent short names
  • Improves clarity of technical language and requirements

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

darrelmiller and others added 2 commits September 13, 2025 19:53
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@darrelmiller darrelmiller merged commit cd34652 into main Sep 13, 2025
2 checks passed
@darrelmiller darrelmiller deleted the editorial-updates branch September 13, 2025 23:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants