-
Notifications
You must be signed in to change notification settings - Fork 9.1k
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
Should style: form
examples include ?
prefix? If so, what about spaceDelimited
, pipeDelimited
, and deepObject
?
#3849
Comments
Oh and this has implications for the use of |
I think we should be consistent with our examples -- and for the case of query parameters, it might be helpful to show examples as full URIs (including url encoding), to show how each query parameter is parsed out of the URI based on the |
Fix added to PR #3859, with @karenetheridge , it would be great to have more examples but rather than expanding the difficult-to-update spec, let's do that on the Learn site. Or at least, let's discuss it here where @jeremyfiel has also suggested something similar, and I have proposed addressing it on the learn site: I'm going to keep this issue's scope limited to just the "should there be a |
PR merged for 3.0.4 and ported to 3.1.1 via PR #3921! |
The examples for the
simple
,label
, andmatrix
styles exactly match the corresponding RFC6570 output, including the initial;
formatrix
or.
forlabel
.RFC6570 form expansion includes the
?
initial character, for the same reasons as the initial;
and.
formatrix
andlabel
. In PR #3818 I note that that has implications for how multipleform
parameters are translated to a form that could be assed to an RFC6570 implementation.But the example table for
form
does not show the?
character, which seems incorrect to me. In issue #1945 (comment), @darrelmiller notes:This implies to me that the
?
should be present. However that also raises some questions:example
/examples
in each Parameter Object each have the?
prefix, even though in a full query string only one of them will be next to it? Note that this does not mean that the others would use RFC6570's&
operator, which I explained in more detail in PR Appendix on RFC6570-derived behavior +allowReserved
(3.0.4) #3818form: style, allowReserved: true
? (See also Appendix on RFC6570-derived behavior +allowReserved
(3.0.4) #3818 (comment))spaceDelimited
andpipeDelimited
are likestyle: form, explode: false
, but with,
replaced by space or|
, so should their examples also show the?
deepObject
is likestyle: form, explode: true
but with more complex names, so should it also show the?
The text was updated successfully, but these errors were encountered: