Skip to content
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

[Monitor.Query] Update Preview Swagger File #26331

Merged
merged 16 commits into from
Oct 30, 2023
Merged

[Monitor.Query] Update Preview Swagger File #26331

Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
28e76c9
update swagger
nisha-bhatia Oct 20, 2023
77ff8aa
batch update
gracewilcox Oct 20, 2023
121ef2b
update old swagger
gracewilcox Oct 20, 2023
6840097
Update metricBatch.json
nisha-bhatia Oct 23, 2023
2dbdb57
Update metricBatch.json
nisha-bhatia Oct 23, 2023
4458b8d
Update metrics_API.json
nisha-bhatia Oct 23, 2023
55e6934
wip
nisha-bhatia Oct 23, 2023
8c41cf3
Update metricBatch.json
nisha-bhatia Oct 23, 2023
2ff0f21
wip
nisha-bhatia Oct 23, 2023
14c7c21
update path
nisha-bhatia Oct 23, 2023
150ca95
Update metricBatch.json
nisha-bhatia Oct 23, 2023
a74a131
Update metricBatch.json
nisha-bhatia Oct 23, 2023
7336208
Update metricBatch.json
nisha-bhatia Oct 23, 2023
b1dd7e4
Update commonDefinitions.json
nisha-bhatia Oct 23, 2023
edbfd5c
Change metricBatch.json endpoint string format from "uri" to "url"
ToddKingMSFT Oct 26, 2023
5625560
Remove duration format from interval parameter and properties
ToddKingMSFT Oct 26, 2023
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
178 changes: 178 additions & 0 deletions specification/monitor/commonDefinitions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,178 @@
{
"swagger": "2.0",
"info": {
"version": "2023-11-01",
"title": "Common Monitoring types"
},
"paths": {},
"definitions": {
"LocalizableString": {
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"description": "The invariant value."
},
"localizedValue": {
"type": "string",
"description": "The display name."
}
},
"description": "The localizable string class."
},
"MetricValue": {
"type": "object",
"required": [
"timeStamp"
],
"properties": {
"timeStamp": {
"type": "string",
"format": "date-time",
"description": "The timestamp for the metric value in ISO 8601 format."
},
"average": {
"type": "number",
"format": "double",
"description": "The average value in the time range."
},
"minimum": {
"type": "number",
"format": "double",
"description": "The least value in the time range."
},
"maximum": {
"type": "number",
"format": "double",
"description": "The greatest value in the time range."
},
"total": {
"type": "number",
"format": "double",
"description": "The sum of all of the values in the time range."
},
"count": {
"type": "number",
"format": "double",
"description": "The number of samples in the time range. Can be used to determine the number of values that contributed to the average value."
}
},
"description": "Represents a metric value."
},
"MetadataValue": {
"type": "object",
"properties": {
"name": {
"$ref": "#/definitions/LocalizableString",
"description": "The name of the metadata."
},
"value": {
"type": "string",
"description": "The value of the metadata."
}
},
"description": "Represents a metric metadata value."
},
"Unit": {
"type": "string",
"description": "The unit of the metric.",
"enum": [
"Count",
"Bytes",
"Seconds",
"CountPerSecond",
"BytesPerSecond",
"Percent",
"MilliSeconds",
"ByteSeconds",
"Unspecified",
"Cores",
"MilliCores",
"NanoCores",
"BitsPerSecond"
],
"x-ms-enum": {
"name": "MetricUnit",
"modelAsString": true
}
},
"TimeSeriesElement": {
"type": "object",
"properties": {
"metadatavalues": {
"type": "array",
"items": {
"$ref": "#/definitions/MetadataValue"
},
"x-ms-identifiers": [
"name"
],
"description": "the metadata values returned if $filter was specified in the call."
},
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/MetricValue"
},
"x-ms-identifiers": [
"timeStamp"
],
"description": "An array of data points representing the metric values. This is only returned if a result type of data is specified."
}
},
"description": "A time series result type. The discriminator value is always TimeSeries in this case."
},
"Metric": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the metric Id."
},
"type": {
"type": "string",
"description": "the resource type of the metric resource."
},
"name": {
"$ref": "#/definitions/LocalizableString",
"description": "the name and the display name of the metric, i.e. it is localizable string."
},
"displayDescription": {
"type": "string",
"description": "Detailed description of this metric."
},
"errorCode": {
"type": "string",
"description": "'Success' or the error details on query failures for this metric."
},
"errorMessage": {
"type": "string",
"description": "Error message encountered querying this specific metric."
},
"unit": {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Breaking change" for the metricsBatch.json. Currently, unit has modelAsString set to false. We could have two separate Unit models, but I think it's better to make the change and set it as true.

"$ref": "#/definitions/Unit",
"description": "The unit of the metric."
},
"timeseries": {
"type": "array",
"items": {
"$ref": "#/definitions/TimeSeriesElement"
},
"x-ms-identifiers": [],
"description": "the time series returned when a data query is performed."
}
},
"required": [
"id",
"type",
"name",
"unit",
"timeseries"
],
"description": "The result data of a query."
}
}
}
Loading