[OASIS Issue Tracker] (ODATA-1080) $each as wildcard for keys

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

    [ https://issues.oasis-open.org/browse/ODATA-1080?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=66350#comment-66350 ] 

George Ericson commented on ODATA-1080:
---------------------------------------

Additional background.
In the above, a MetricDefinition is used to define behavioral characteristics of a metric.  MetricProperties is a property of MetricDefinition.  Its values specify properties that are consistent with the MetricDefinition..  The example is specifying the properties named ReadIOPercent, WriteIOPercent, and NonIOPercent within all Volume entities of all known StorageService entities.

We don't expect this semantics to be supported directly by OData, but we would like the syntax to be consistent with OData syntax.  Specifically for selecting all entities of a NavigationProperty collection.

 

> $each as wildcard for keys
> --------------------------
>
>                 Key: ODATA-1080
>                 URL: https://issues.oasis-open.org/browse/ODATA-1080
>             Project: OASIS Open Data Protocol (OData) TC
>          Issue Type: Improvement
>          Components: Protocol
>    Affects Versions: V4.01_CSD01
>         Environment: Wildcard specificationa
>            Reporter: George Ericson
>            Assignee: George Ericson
>             Fix For: V4.01_CSD02
>
>
> There is a use case for specifying wildcards when processing a URL for use in requests.  Typically this is outside of OData, but it seems relevant to the use of $each.  So we want to vet it here.
> For example, consider the following JSON: 
> 	"Wildcards": [ 
> 		{ 	"Name": "allSS",
> 			"Values": ["$each"] },
> 		{ 	"Name": "allV",
> 			"Values": ["$each"] },
> 		{ 	"Name": "percentStats",
> 			"Values": ["ReadIOPercent", "WriteIOPercent", "NonIOPercent"] }
>     ],
> 	"MetricProperties": [
> 		"/redfish/v1/StorageServices/Members({allSS})/Volumes/Members({allV})/VolumeStatistics/{percentStats}"],
> In the case of {allSS} or {allV} one natural specification would be to use "*" to mean all keys.  However as shown above, an alternative is to use the $each keyword to mean all.
> So, several questions:
> 1) Should $each be available to mean all within parenthesis?  The /$each as a segment is consistent with the alternate key format. 
> 2) Should we define the wildcard substitution within OData?
> 3) For this purpose, should we use "*" for all of the above instead of $each.
> 		



--
This message was sent by Atlassian JIRA
(v6.2.2#6258)