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
Clarifications on pointers
#180
Comments
Hi @RomanHotsiy, The goal here it to allow short hand replacement of values without necessarily having to construct the full request structure. In situations where many of the request values support defaults this can be useful. Use I agree it should not enforce mutually exclusivity with I can issue a PR to remove this restriction. Regarding the ambiguity, that all depends on the schema of the requestBody.
If the expected shape of the request was as follows then
If the expected shape of the request as as follows then the value property
Can you provide more detail here? When evaluating the JSON Pointer, it must be resolved against JSON contents. The JSON is expected to conform to the schema of the request body. We are not expecting an attempt to resolve against anything other than the request body. When we remove the mutual exclusivity constraint with
Naming is never easy. I think |
What is the behavior if there is no
What if you have to remove one property from a payload? |
The request is constructed via a combination of schema defaults and the
Yes, these are all possible names.
Not currently supported. The only option would be to construct the explicit request using the |
But what if schema defaults are not provided or schema is not provided? Or if the schema is |
The expectation is that a constructed request body can be accepted by the operation. If there is a situation where that is not possible with |
@RomanHotsiy hopefully #183 improves clarity here. I also renamed |
@frankkilcommins yes, this sounds better. Thanks! |
Hey @frankkilcommins !
This is a follow-up discussion to #152 and #162.
I've noticed you added
pointers
which is mutually exclusive to thepayload
as per the latest version of the spec.I have concerns about it.
First, I think JSON pointers can't be used for constructing the JSON Object because of the ambiguity with arrays. For example:
Should it result in:
[22]
or
I also find this line contradicting: "which MUST be resolved against the request body."
Is it a mistake and it should not be mutually exclusive? Could you clarify the intention here.
Also, I find the
pointers
name to be misleading. When I first saw it I couldn't understand it. What about some other names likepatches
,updates
?But in general, what problem are we solving with this? What can be accomplished using it which is not possible or hard with the
payload
?The text was updated successfully, but these errors were encountered: