Skip to content

[TimeSeriesInsights] Swagger update - Added support for sample interpolation #6947

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
raych1 merged 2 commits into from
Aug 14, 2019
Merged

[TimeSeriesInsights] Swagger update - Added support for sample interpolation #6947

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4dee278
added support sample interpolation in swagger
prjain-msft Aug 14, 2019
70e7e38
Fixed the model validation failure
prjain-msft Aug 14, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
114 changes: 114 additions & 0 deletions ...ghts/preview/2018-11-01-preview/examples/QueryAggregateSeriesWithSampleInterpolation.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
{
"parameters": {
"api-version": "2018-11-01-preview",
"environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com",
"continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=",
"parameters": {
"aggregateSeries": {
"timeSeriesId": [
"006dfc2d-0324-4937-998c-d16f3b4f1952",
"T1"
],
"searchSpan": {
"from": "2016-08-01T00:00:00Z",
"to": "2016-08-01T00:16:50Z"
},
"interval": "PT1M",
"inlineVariables": {
"LinearSampleInterpolation": {
"kind": "numeric",
"value": {
"tsx": "$event.Temperature"
},
"filter": null,
"interpolation": {
"kind": "Linear",
"boundary": {
"span": "P1D"
}
},
"aggregation": {
"tsx": "left($value)"
}
},
"StepSampleInterpolation": {
"kind": "numeric",
"value": {
"tsx": "$event.Temperature"
},
"filter": null,
"interpolation": {
"kind": "Step",
"boundary": {
"span": "P1D"
}
},
"aggregation": {
"tsx": "left($value)"
}
}
},
"projectedVariables": [
"LinearSampleInterpolation",
"StepSampleInterpolation"
]
}
}
},
"responses": {
"200": {
"body": {
"timestamps": [
"2016-08-01T00:00:00Z",
"2016-08-01T00:01:00Z",
"2016-08-01T00:02:00Z",
"2016-08-01T00:03:00Z",
"2016-08-01T00:04:00Z",
"2016-08-01T00:05:00Z",
"2016-08-01T00:06:00Z",
"2016-08-01T00:07:00Z",
"2016-08-01T00:08:00Z",
"2016-08-01T00:09:00Z",
"2016-08-01T00:10:00Z"
],
"properties": [
{
"name": "LinearSampleInterpolation",
"type": "Double",
"values": [
50.0,
60.0,
60.0,
60.0,
60.0,
60.0,
60.0,
60.0,
60.0,
60.0,
62.0
]
},
{
"name": "StepSampleInterpolation",
"type": "Double",
"values": [
71.25,
85.0,
82.5,
80.0,
89.166666666666671,
75.0,
90.0,
75.833333333333329,
85.0,
82.5,
84.0
]
}
],
"progress": 100.0
}
}
}
}
39 changes: 38 additions & 1 deletion ...ata-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/timeseriesinsights.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -291,6 +291,9 @@
"QueryAggregateSeriesPage2": {
"$ref": "./examples/QueryAggregateSeriesPage2.json"
},
"QueryAggregateSeriesWithSampleInterpolation": {
"$ref": "./examples/QueryAggregateSeriesWithSampleInterpolation.json"
},
"QueryGetEventsPage1": {
"$ref": "./examples/QueryGetEventsPage1.json"
},
Expand Down Expand Up @@ -1158,6 +1161,34 @@
"tsx"
]
},
"Interpolation": {
"description": "The interpolation operation to be performed on the raw data points. Interpolation is only supported in \"numeric\" variables. Currently, only sampling of interpolated time series is allowed. Allowed aggregate function - eg: left($value). Can be null if no interpolation needs to be applied.",
"type": "object",
"properties": {
"kind": {
"description": "The type of interpolation technique : \"Linear\" or \"Step\".",
"type": "string",
"enum": [
"Linear",
"Step"
],
"x-ms-enum": {
"name": "InterpolationKind",
"modelAsString": true
}
},
"boundary": {
"description": "The time range to the left and right of the search span to be used for Interpolation. This is helpful in scenarios where the data points are missing close to the start or end of the input search span. Can be null.",
"type": "object",
"properties": {
"span": {
"type": "string",
"format": "duration"
}
}
}
}
},
"DateTimeRange": {
"description": "The range of time. Cannot be null or negative.",
"type": "object",
Expand Down Expand Up @@ -1192,6 +1223,9 @@
"description": "Value time series expression is used to represent the value of the signal that is going to be aggregated or interpolated. For example, temperature values from the event is represented like this: \"$event.Temperature.Double\".",
"$ref": "#/definitions/Tsx"
},
"interpolation": {
"$ref": "#/definitions/Interpolation"
},
"aggregation": {
"description": "Aggregation time series expression when kind is \"numeric\" is used to represent the aggregation that needs to be performed on the $value expression. This requires $value to be specified and can only use $value inside the aggregate functions. For example, aggregation for calculating minimum of the $value is written as: \"min($value)\".",
"$ref": "#/definitions/Tsx"
Expand All @@ -1206,7 +1240,7 @@
]
},
"AggregateVariable": {
"description": "Aggregate variable represents any aggregation calculation.",
"description": "Aggregate variable represents any aggregation calculation. Aggregate Variables does not support interpolation.",
"x-ms-discriminator-value": "aggregate",
"allOf": [
{
Expand Down Expand Up @@ -1239,6 +1273,9 @@
"filter": {
"description": "Filter over the events that restricts the number of events being considered for computation. Example: \"$event.Status.String='Good'\". Optional.",
"$ref": "#/definitions/Tsx"
},
"interpolation": {
"$ref": "#/definitions/Interpolation"
}
},
"required": [
Expand Down