Skip to content

Conversation

jakeoneill64
Copy link

No description provided.

@char0n
Copy link
Member

char0n commented Aug 29, 2025

Hi @jakeoneill64,

This library has been foundational in formalizing path templating in OpenAPI specification. Please read following links:

Long story short, grammar from this library (with minor changes) have been adopted by OpenAPI and will be officially released as OpenAPI 3.2 - https://github.com/OAI/OpenAPI-Specification/blob/v3.2-dev/src/oas.md#path-templating. Notice that ? and query-string MUST NOT be part of the ABNF. This applies to OpenAPI 2.0, 3.0 and 3.1 as well.

As stipulated above, ? question mark and query-string must not be part of the ABNF grammar, they MUST be handled by Parameter Object with in: query & required: true fixed fields.

Here is an excerpt from OpenAPI 3.2 spec which verifies this:

The value for these path parameters MUST NOT contain any unescaped "generic syntax" characters described by RFC3986: forward slashes (/), question marks (?), or hashes (#). See URL Percent-Encoding for additional guidance on escaping characters.

I'll close this PR as it's something that will go against what we've already established in OpenAPI.

Thank you!

@char0n char0n closed this Aug 29, 2025
@char0n char0n self-assigned this Aug 29, 2025
@char0n char0n added the invalid This doesn't seem right label Aug 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

invalid This doesn't seem right

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants