RADAR-base / RADAR-RestApi

RESTful interface to access near real-time data
Apache License 2.0
2 stars 0 forks source link

TimeFrame property name #38

Closed afolarin closed 6 years ago

afolarin commented 7 years ago

The enum param “timeFrame” name is confusing and should be changed to “timeInterval”.

OMH does have a “time_interval” property to define the time interval, although their definition is different from ours:

"timeFrame": "TEN_SECOND",
should be
"timeInterval": "TEN_SECOND",

TODO

blootsvoets commented 7 years ago

Note that in Kafka streams, where the data comes from, the TEN_SECOND symbol is called a time window. That is different from the time frame, since the timeFrame describes a dataset limited to a certain time frame. This latter name is consistent with the name data frame used in analytics packages like pandas or R. Could that be a resolution? Call TEN_SECOND a timeWindow and keep timeFrame for the dataset time frame?

herkulano commented 7 years ago

timeWindow works well, the confusing name was timeFrame.

Regarding the timeFrame and effectiveTimeframe, I added a comment to clarify it here: https://github.com/RADAR-CNS/RADAR-RestApi/issues/37#issuecomment-331550793

blootsvoets commented 7 years ago

Fixed with RADAR-CNS/RADAR-Schemas#55.