From d56f30c15acbd722fefecd7b4d811cbcc5706308 Mon Sep 17 00:00:00 2001 From: Victor Woeltjen Date: Wed, 7 Sep 2016 10:15:57 -0700 Subject: [PATCH] [API] TelemetryRequest --- src/api/telemetry/TelemetryAPI.js | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/src/api/telemetry/TelemetryAPI.js b/src/api/telemetry/TelemetryAPI.js index ad665b7f63..172bebbb29 100644 --- a/src/api/telemetry/TelemetryAPI.js +++ b/src/api/telemetry/TelemetryAPI.js @@ -73,6 +73,19 @@ define([ * of possible values */ + /** + * Describes and bounds requests for telemetry data. + * + * @typedef TelemetryRequest + * @memberof module:openmct.TelemetryAPI~ + * @property {string} sort the key of the property to sort by + * @property {*} start the lower bound for values of the sorting property + * @property {*} end the upper bound for values of the sorting property + * @property {string[]} strategies symbolic identifiers for strategies + * (such as `minmax`) which may be recognized by providers; + * these will be tried in order until an appropriate provider + * is found + */ /** * An interface for retrieving telemetry data associated with a domain