Skip to content

v3.1: Should we change the "?" in the style example table (again)? #4662

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.

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
handrews opened this issue Jun 5, 2025 · 1 comment
Open
Labels
example obj/keywords Issues with the Example Object or exampel(s) keywords
Milestone

Comments

@handrews
Copy link
Member

handrews commented Jun 5, 2025

In 3.1.1 we added the ? because it matched RFC6570 library behavior, but explained that sometimes you need to strip it. This is awkward, because the table is showing individual parameters, and of course not all of them have a ?! The leading ? and intermediate & characters need to be sorted out when composing the whole query string. And in request bodies, there is no leading ? at all.

In PR #4647 for 3.2, with the new example fields, we have removed the ? and changed the wording to explain when to add the ? back. This allows matching the style example table to the Example Object fields.

Should we make a similar change for 3.1.2, or leave it as-is? Technically, we might only need to be a bit more clear about the reason the ? is shown in 3.1.2, since we do discuss stripping it.

See also:

@handrews handrews added the example obj/keywords Issues with the Example Object or exampel(s) keywords label Jun 5, 2025
@handrews handrews added this to the v3.1.2 milestone Jun 5, 2025
@handrews
Copy link
Member Author

handrews commented Jun 9, 2025

Addressed for 3.2 in PR #4673, 3.1.x still TBD

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
example obj/keywords Issues with the Example Object or exampel(s) keywords
Projects
None yet
Development

No branches or pull requests

1 participant