Skip to content

v3.3: apply the ABNF for header names at rfc9110 §5.1#5233

Open
karenetheridge wants to merge 2 commits intoOAI:v3.3-devfrom
karenetheridge:ether/3.3-header-name-pattern
Open

v3.3: apply the ABNF for header names at rfc9110 §5.1#5233
karenetheridge wants to merge 2 commits intoOAI:v3.3-devfrom
karenetheridge:ether/3.3-header-name-pattern

Conversation

@karenetheridge
Copy link
Member

..and the same pattern applies to HTTP method names too

  • schema changes are included in this pull request

@karenetheridge karenetheridge requested review from a team as code owners March 5, 2026 04:07
@karenetheridge karenetheridge force-pushed the ether/3.3-header-name-pattern branch from c4bab1f to 3d2b3d4 Compare March 5, 2026 21:05
..and the same pattern applies to HTTP method names too
@karenetheridge karenetheridge force-pushed the ether/3.3-header-name-pattern branch from 3d2b3d4 to 0ce2ef6 Compare March 5, 2026 21:10
token:
$comment: see https://www.rfc-editor.org/rfc/rfc9110.html#section-5.6.2
type: string
pattern: '^[0-9A-Za-z!#$%&\'*+.^_`|~-]+$'
Copy link
Contributor

Choose a reason for hiding this comment

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

This is not valid YAML: use double quotes or no quotes.

Suggested change
pattern: '^[0-9A-Za-z!#$%&\'*+.^_`|~-]+$'
pattern: "^[a-zA-Z0-9!#$%&'*+.^_`|~-]+$"

version: 1.0.0
components:
headers:
'Still=Legal':
Copy link
Contributor

Choose a reason for hiding this comment

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

The equal sign (=) was never legal in names/keys of reusable components, see Components Object, subsection Fixed Fields:

All the fixed fields declared above are objects that MUST use keys that match the regular expression: ^[a-zA-Z0-9.-_]+$.

manifested in https://github.com/karenetheridge/OpenAPI-Specification/blob/1f4999c317a468d15aade5c61ea8095d9cf4641e/src/schemas/validation/schema.yaml#L209-L210

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