Skip to content

[Anomaly Detector] Rename operations and fix path casing #10572

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
mayurid merged 8 commits into from
Aug 26, 2020
Merged

[Anomaly Detector] Rename operations and fix path casing #10572

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
99856fe
Rename operations and fix path casing
joheredi Aug 24, 2020
84655e1
Ad x-ms-enum details
joheredi Aug 25, 2020
d9fbd58
add changepoint to custom-words
joheredi Aug 25, 2020
30df9d7
Remove enum renames while architects discuss
joheredi Aug 25, 2020
c820530
Add x-ms-enum
joheredi Aug 25, 2020
c0337b4
Rename Request. Point and Granularity
joheredi Aug 25, 2020
9663a4d
Update error name
joheredi Aug 25, 2020
f43a092
Formatting
joheredi Aug 25, 2020
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
1 change: 1 addition & 0 deletions custom-words.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,7 @@ certificatesdelete
Certificatethumbprint
certverify
chainer
changepoint
changestate
CHECKACCESS
checkmark
Expand Down
63 changes: 44 additions & 19 deletions specification/cognitiveservices/data-plane/AnomalyDetector/preview/v1.0/AnomalyDetector.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,15 @@
"post": {
"summary": "Detect anomalies for the entire series in batch.",
"description": "This operation generates a model using an entire series, each point is detected with the same model. With this method, points before and after a certain point are used to determine whether it is an anomaly. The entire detection can give user an overall status of the time series.",
"operationId": "EntireDetect",
"operationId": "DetectEntireSeries",
"parameters": [
{
"name": "body",
"in": "body",
"description": "Time series points and period if needed. Advanced model parameters can also be set in the request.",
"required": true,
"schema": {
"$ref": "#/definitions/Request"
"$ref": "#/definitions/DetectRequest"
}
}
],
Expand All @@ -59,7 +59,7 @@
"default": {
"description": "Error response.",
"schema": {
"$ref": "#/definitions/APIError"
"$ref": "#/definitions/AnomalyDetectorError"
}
}
},
Expand All @@ -74,15 +74,15 @@
"post": {
"summary": "Detect anomaly status of the latest point in time series.",
"description": "This operation generates a model using points before the latest one. With this method, only historical points are used to determine whether the target point is an anomaly. The latest point detecting operation matches the scenario of real-time monitoring of business metrics.",
"operationId": "LastDetect",
"operationId": "DetectLastPoint",
"parameters": [
{
"name": "body",
"in": "body",
"description": "Time series points and period if needed. Advanced model parameters can also be set in the request.",
"required": true,
"schema": {
"$ref": "#/definitions/Request"
"$ref": "#/definitions/DetectRequest"
}
}
],
Expand All @@ -102,7 +102,7 @@
"default": {
"description": "Error response.",
"schema": {
"$ref": "#/definitions/APIError"
"$ref": "#/definitions/AnomalyDetectorError"
}
}
},
Expand All @@ -113,11 +113,11 @@
}
}
},
"/timeseries/changePoint/detect": {
"/timeseries/changepoint/detect": {
"post": {
"summary": "Detect change point for the entire series",
"description": "Evaluate change point score of every series point",
"operationId": "ChangePointDetect",
"operationId": "DetectChangePoint",
"parameters": [
{
"name": "body",
Expand Down Expand Up @@ -145,7 +145,7 @@
"default": {
"description": "Error response.",
"schema": {
"$ref": "#/definitions/APIError"
"$ref": "#/definitions/AnomalyDetectorError"
}
}
},
Expand All @@ -158,7 +158,7 @@
}
},
"definitions": {
"APIError": {
"AnomalyDetectorError": {
"type": "object",
"description": "Error information returned by the API.",
"properties": {
Expand Down Expand Up @@ -186,13 +186,38 @@
}
}
},
"Granularity": {
"TimeGranularity": {
"type": "string",
"description": "Can only be one of yearly, monthly, weekly, daily, hourly, minutely or secondly. Granularity is used for verify whether input series is valid.",
"x-nullable": false,
"x-ms-enum": {
"name": "Granularity",
"modelAsString": false
"name": "TimeGranularity",
"modelAsString": false,
"values": [
{
"value": "yearly"
},
{
"value": "monthly"
},
{
"value": "weekly"
},
{
"value": "daily"
},
{
"value": "hourly"
},
{
"name": "perMinute",
"value": "minutely"
},
{
"name": "perSecond",
"value": "secondly"
}
]
},
"enum": [
"yearly",
Expand All @@ -210,7 +235,7 @@
"x-nullable": false,
"description": "Custom Interval is used to set non-standard time interval, for example, if the series is 5 minutes, request can be set as {\"granularity\":\"minutely\", \"customInterval\":5}."
},
"Request": {
"DetectRequest": {
"type": "object",
"required": [
"granularity",
Expand All @@ -221,11 +246,11 @@
"type": "array",
"description": "Time series data points. Points should be sorted by timestamp in ascending order to match the anomaly detection result. If the data is not sorted correctly or there is duplicated timestamp, the API will not work. In such case, an error message will be returned.",
"items": {
"$ref": "#/definitions/Point"
"$ref": "#/definitions/TimeSeriesPoint"
}
},
"granularity": {
"$ref": "#/definitions/Granularity"
"$ref": "#/definitions/TimeGranularity"
},
"customInterval": {
"description": "Custom Interval is used to set non-standard time interval, for example, if the series is 5 minutes, request can be set as {\"granularity\":\"minutely\", \"customInterval\":5}.",
Expand All @@ -248,7 +273,7 @@
}
}
},
"Point": {
"TimeSeriesPoint": {
"type": "object",
"required": [
"timestamp",
Expand Down Expand Up @@ -400,11 +425,11 @@
"type": "array",
"description": "Time series data points. Points should be sorted by timestamp in ascending order to match the change point detection result.",
"items": {
"$ref": "#/definitions/Point"
"$ref": "#/definitions/TimeSeriesPoint"
}
},
"granularity": {
"$ref": "#/definitions/Granularity",
"$ref": "#/definitions/TimeGranularity",
"description": "Can only be one of yearly, monthly, weekly, daily, hourly, minutely or secondly. Granularity is used for verify whether input series is valid."
},
"customInterval": {
Expand Down