[OASIS Issue Tracker] (ODATA-1446) Clarify usage of Edm.Stream-typed function parameters in URLs

[OASIS Issues Tracker <workgroup_mailer@lists.oasis-open.org>]

Gerald Krause created ODATA-1446:
------------------------------------

             Summary: Clarify usage of Edm.Stream-typed function parameters in URLs
                 Key: ODATA-1446
                 URL: https://issues.oasis-open.org/browse/ODATA-1446
             Project: OASIS Open Data Protocol (OData) TC
          Issue Type: Improvement
          Components: URL Conventions
    Affects Versions: V4.01_OS
            Reporter: Gerald Krause
             Fix For: V4.01_ERRATA01


Today, the option to pass a value to an Edm.Stream-typed parameter in a request addressing a function import requires to look at different places and combine the individual steps (analogous for function calls):
 * Section on [Addressing Functions|http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html#_Toc31360941] in the URL conventions spec refers to certain ABNF rules (e.g., {{primitiveFunctionImportCall}}) that eventually lead to either rule {{parameterAlias}} or {{primitiveLiteral}}.
 * Following {{parameterAlias}}, section [5.3 Parameter Aliases|https://docs.oasis-open.org/odata/odata/v4.01/os/part2-url-conventions/odata-v4.01-os-part2-url-conventions.html#_Toc31361051] in the same spec explains the relation to ABNF rule {{aliasAndValue}}, which finally gets us to {{parameterValue}} with {{arrayOrObject}} as one of the options.
 * Section [5.1.1.14.2 Complex and Collection Literals|https://docs.oasis-open.org/odata/odata/v4.01/os/part2-url-conventions/odata-v4.01-os-part2-url-conventions.html#_Toc31361029] in the same spec defines the use of this ABNF rule {{arrayOrObject}} for complex and collection literals, but not for JSON documents as values of Edm.Stream-typed properties.
 * So, the only escape is to go the other route and use {{commonExpr}}, which is the other choice for {{arrayOrObject}}. This can become a {{primitiveValue}}, which includes a [comment|https://github.com/oasis-tcs/odata-abnf/blob/513b5bd1319d3093491d76a30ea91ded619b9e5a/abnf/odata-abnf-construction-rules.txt#L930] that strings can be used for JSON documents
 * So, finally we have found a rule to pass such a stream value

The intention of this issue is to discuss if the consumption of this feature could be simplified by making it more explicit in the URL conventions spec.



--
This message was sent by Atlassian Jira
(v8.3.3#803004)