Omission of collection-valued parameters/properties #2049
+54
−16
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
HeikoTheissen
commented
Feb 13, 2025
Comment on lines
341
to
343
| of nullability or optionality. Unless a `Core.OptionalValue` with `DefaultValue` is annotated, | ||
| the interpretation of such an omitted parameter is up to the service, | ||
| this includes assuming an empty collection or reporting an error. |
There was a problem hiding this comment.
Note: This allows a service to treat an absent mandatory parameter of type Collection(Edm.Int16) like [1,2].
ralfhandl
previously approved these changes
Feb 13, 2025
ralfhandl
reviewed
Feb 19, 2025
Comment on lines
340
to
343
| Non-binding collection-valued parameters MAY be omitted from the request body regardless | ||
| of nullability or optionality. Unless a `Core.OptionalValue` with `DefaultValue` is annotated, | ||
| the interpretation of such an omitted parameter is up to the service, | ||
| this includes assuming an empty collection or reporting an error. |
There was a problem hiding this comment.
Mention this in the "Changes" section
ralfhandl
reviewed
Feb 19, 2025
odata-protocol/8 Header Fields.md
Outdated
| null values from the response, in which case it MUST specify the | ||
| `Preference-Applied` response header with `omit-values=nulls`. | ||
|
|
||
| If `defaults` is specified, then the service MAY omit properties | ||
| If `defaults` is specified, then the service MAY omit single-valued properties | ||
| containing default values from the response, including nulls for |
There was a problem hiding this comment.
"containing" -> "having"
ralfhandl
reviewed
Feb 19, 2025
| @@ -337,6 +337,11 @@ how to interpret the omitted parameter. Note: a nullable non-binding | |||
| parameter is equivalent to being annotated as optional with a default | |||
| value of `null`. | |||
|
|
|||
| Non-binding collection-valued parameters MAY be omitted from the request body regardless | |||
| of nullability or optionality. Unless a `Core.OptionalValue` with `DefaultValue` is annotated, | |||
There was a problem hiding this comment.
DefaultValue has type String, so it only works for primitive single-valued :-(
There was a problem hiding this comment.
We could extend the term Core.OptionalParameter with AnyDefaultValue or NonPrimitiveDefaultValue or similar of type Edm.Untyped.
ralfhandl
previously approved these changes
Feb 20, 2025
ralfhandl
previously approved these changes
Feb 22, 2025
ralfhandl
previously approved these changes
Feb 28, 2025
mikepizzo
reviewed
Mar 5, 2025
| @@ -337,6 +337,11 @@ how to interpret the omitted parameter. Note: a nullable non-binding | |||
| parameter is equivalent to being annotated as optional with a default | |||
| value of `null`. | |||
|
|
|||
| Non-binding collection-valued parameters MAY be omitted from the request body regardless | |||
| of nullability or optionality. The interpretation of such an omitted parameter is up to the service, | |||
There was a problem hiding this comment.
"May be omitted" and "reporting an error" seem in conflict. Can we remove the first part, and just say something like "If collection-valued parameters are omitted from the request, the interpretation is up to the service,..."
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #2045