diff --git a/custom-words.txt b/custom-words.txt index c8fc8175067f..8bcd0a387718 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -2415,6 +2415,8 @@ Ctlr vcenters Mwarev pmem +actuals +Actuals rawphysical rawvirtual sesparse @@ -2427,4 +2429,4 @@ stackset CSPM autoprovisioning schemagroups -videoanalyzer \ No newline at end of file +videoanalyzer diff --git a/specification/maps/data-plane/Weather/preview/1.0/examples/GetDailyHistoricalActuals.json b/specification/maps/data-plane/Weather/preview/1.0/examples/GetDailyHistoricalActuals.json new file mode 100644 index 000000000000..e9849b734c26 --- /dev/null +++ b/specification/maps/data-plane/Weather/preview/1.0/examples/GetDailyHistoricalActuals.json @@ -0,0 +1,158 @@ +{ + "parameters": { + "api-version": "1.0", + "format": "json", + "query": "40.78,-77.89", + "startDate": "2012-01-20", + "endDate": "2012-01-22" + }, + "responses": { + "200": { + "body": { + "historicalActuals": [ + { + "date": "2012-01-20T00:00:00-04:00", + "temperature": { + "maximum": { + "value": -6.1, + "unit": "C", + "unitType": 17 + }, + "minimum": { + "value": -11.1, + "unit": "C", + "unitType": 17 + }, + "average": { + "value": -8.6, + "unit": "C", + "unitType": 17 + } + }, + "degreeDaySummary": { + "heating": { + "value": 27.0, + "unit": "C", + "unitType": 17 + }, + "cooling": { + "value": 0.0, + "unit": "C", + "unitType": 17 + } + }, + "precipitation": { + "value": 10.9, + "unit": "mm", + "unitType": 3 + }, + "snowfall": { + "value": 12.19, + "unit": "cm", + "unitType": 4 + }, + "snowDepth": { + "value": 15.2, + "unit": "cm", + "unitType": 4 + } + }, + { + "date": "2012-01-21T00:00:00-04:00", + "temperature": { + "maximum": { + "value": -1.7, + "unit": "C", + "unitType": 17 + }, + "minimum": { + "value": -8.9, + "unit": "C", + "unitType": 17 + }, + "average": { + "value": -5.3, + "unit": "C", + "unitType": 17 + } + }, + "degreeDaySummary": { + "heating": { + "value": 24.0, + "unit": "C", + "unitType": 17 + }, + "cooling": { + "value": 0.0, + "unit": "C", + "unitType": 17 + } + }, + "precipitation": { + "value": 0.0, + "unit": "mm", + "unitType": 3 + }, + "snowfall": { + "value": 0.51, + "unit": "cm", + "unitType": 4 + }, + "snowDepth": { + "value": 12.7, + "unit": "cm", + "unitType": 4 + } + }, + { + "date": "2012-01-22T00:00:00-04:00", + "temperature": { + "maximum": { + "value": 0.0, + "unit": "C", + "unitType": 17 + }, + "minimum": { + "value": -7.2, + "unit": "C", + "unitType": 17 + }, + "average": { + "value": -3.6, + "unit": "C", + "unitType": 17 + } + }, + "degreeDaySummary": { + "heating": { + "value": 22.0, + "unit": "C", + "unitType": 17 + }, + "cooling": { + "value": 0.0, + "unit": "C", + "unitType": 17 + } + }, + "precipitation": { + "value": 0.0, + "unit": "mm", + "unitType": 3 + }, + "snowfall": { + "value": 0.0, + "unit": "cm", + "unitType": 4 + }, + "snowDepth": { + "value": 10.2, + "unit": "cm", + "unitType": 4 + } + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Weather/preview/1.0/examples/GetDailyHistoricalNormals.json b/specification/maps/data-plane/Weather/preview/1.0/examples/GetDailyHistoricalNormals.json new file mode 100644 index 000000000000..7078f5b7a951 --- /dev/null +++ b/specification/maps/data-plane/Weather/preview/1.0/examples/GetDailyHistoricalNormals.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "api-version": "1.0", + "format": "json", + "query": "39.952583,-75.165222", + "startDate": "2012-01-20", + "endDate": "2012-01-22" + }, + "responses": { + "200": { + "body": { + "historicalNormals": [ + { + "date": "2012-01-20T00:00:00-04:00", + "temperature": { + "maximum": { + "value": 4.4, + "unit": "C", + "unitType": 17 + }, + "minimum": { + "value": -3.7, + "unit": "C", + "unitType": 17 + }, + "average": { + "value": 0.4, + "unit": "C", + "unitType": 17 + } + }, + "degreeDaySummary": { + "heating": { + "value": 18.0, + "unit": "C", + "unitType": 17 + }, + "cooling": { + "value": 0.0, + "unit": "C", + "unitType": 17 + } + }, + "precipitation": { + "value": 2.5, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2012-01-21T00:00:00-04:00", + "temperature": { + "maximum": { + "value": 4.5, + "unit": "C", + "unitType": 17 + }, + "minimum": { + "value": -3.7, + "unit": "C", + "unitType": 17 + }, + "average": { + "value": 0.4, + "unit": "C", + "unitType": 17 + } + }, + "degreeDaySummary": { + "heating": { + "value": 18.0, + "unit": "C", + "unitType": 17 + }, + "cooling": { + "value": 0.0, + "unit": "C", + "unitType": 17 + } + }, + "precipitation": { + "value": 2.5, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2012-01-22T00:00:00-04:00", + "temperature": { + "maximum": { + "value": 4.5, + "unit": "C", + "unitType": 17 + }, + "minimum": { + "value": -3.7, + "unit": "C", + "unitType": 17 + }, + "average": { + "value": 0.4, + "unit": "C", + "unitType": 17 + } + }, + "degreeDaySummary": { + "heating": { + "value": 18.0, + "unit": "C", + "unitType": 17 + }, + "cooling": { + "value": 0.0, + "unit": "C", + "unitType": 17 + } + }, + "precipitation": { + "value": 2.3, + "unit": "mm", + "unitType": 3 + } + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Weather/preview/1.0/examples/GetDailyHistoricalRecords.json b/specification/maps/data-plane/Weather/preview/1.0/examples/GetDailyHistoricalRecords.json new file mode 100644 index 000000000000..f80e52d09d83 --- /dev/null +++ b/specification/maps/data-plane/Weather/preview/1.0/examples/GetDailyHistoricalRecords.json @@ -0,0 +1,131 @@ +{ + "parameters": { + "api-version": "1.0", + "format": "json", + "query": "39.952583,-75.165222", + "startDate": "2012-01-20", + "endDate": "2012-01-22" + }, + "responses": { + "200": { + "body": { + "historicalRecords": [ + { + "date": "2012-01-20T00:00:00-04:00", + "temperature": { + "maximum": { + "value": 18.3, + "unit": "C", + "unitType": 17, + "year": 1951 + }, + "minimum": { + "value": -19.4, + "unit": "C", + "unitType": 17, + "year": 1984 + }, + "average": { + "value": -0.6, + "unit": "C", + "unitType": 17 + } + }, + "precipitation": { + "maximum": { + "value": 48.0, + "unit": "mm", + "unitType": 3, + "year": 1978 + } + }, + "snowfall": { + "maximum": { + "value": 12.19, + "unit": "cm", + "unitType": 4, + "year": 1978 + } + } + }, + { + "date": "2012-01-21T00:00:00-04:00", + "temperature": { + "maximum": { + "value": 16.7, + "unit": "C", + "unitType": 17, + "year": 1959 + }, + "minimum": { + "value": -21.1, + "unit": "C", + "unitType": 17, + "year": 1985 + }, + "average": { + "value": -2.2, + "unit": "C", + "unitType": 17 + } + }, + "precipitation": { + "maximum": { + "value": 33.5, + "unit": "mm", + "unitType": 3, + "year": 1979 + } + }, + "snowfall": { + "maximum": { + "value": 34.29, + "unit": "cm", + "unitType": 4, + "year": 2014 + } + } + }, + { + "date": "2012-01-22T00:00:00-04:00", + "temperature": { + "maximum": { + "value": 21.1, + "unit": "C", + "unitType": 17, + "year": 1906 + }, + "minimum": { + "value": -21.7, + "unit": "C", + "unitType": 17, + "year": 1984 + }, + "average": { + "value": -0.3, + "unit": "C", + "unitType": 17 + } + }, + "precipitation": { + "maximum": { + "value": 26.2, + "unit": "mm", + "unitType": 3, + "year": 1987 + } + }, + "snowfall": { + "maximum": { + "value": 22.35, + "unit": "cm", + "unitType": 4, + "year": 1987 + } + } + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Weather/preview/1.0/weather.json b/specification/maps/data-plane/Weather/preview/1.0/weather.json index 4c460e8d0240..d2f88e281f05 100644 --- a/specification/maps/data-plane/Weather/preview/1.0/weather.json +++ b/specification/maps/data-plane/Weather/preview/1.0/weather.json @@ -555,6 +555,210 @@ } } } + }, + "/weather/historical/actuals/daily/{format}": { + "get": { + "description": "**Get Daily Historical Actuals**\n \n \n**Applies to**: Gen 1 (S0 and S1) and Gen 2 pricing tiers.\n\n\nGet Daily Historical Actuals service returns climatology data such as past daily actual observed temperatures, precipitation, snowfall, snow depth and cooling/heating degree day information, for the day at a given coordinate location. The data is requested for a specified date range, up to 31 days in a single API request. Generally, historical data may be available as far back as the last 5 to 40+ years, depending on the location.", + "operationId": "Weather_GetDailyHistoricalActuals", + "x-ms-examples": { + "Successful Daily Historical Actuals Request": { + "$ref": "./examples/GetDailyHistoricalActuals.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat" + }, + { + "name": "query", + "x-ms-client-name": "coordinates", + "in": "query", + "description": "The applicable query specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\".", + "required": true, + "x-ms-parameter-location": "method", + "type": "array", + "collectionFormat": "csv", + "minItems": 2, + "maxItems": 2, + "items": { + "type": "number", + "format": "double" + } + }, + { + "name": "startDate", + "description": "Start date in ISO 8601 format, for example, 2019-10-27. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).", + "in": "query", + "type": "string", + "format": "date", + "required": true + }, + { + "name": "endDate", + "description": "End date in ISO 8601 format, for example, 2019-10-28. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).", + "in": "query", + "type": "string", + "format": "date", + "required": true + }, + { + "$ref": "#/parameters/WeatherDataUnit" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DailyHistoricalActualsResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/weather/historical/records/daily/{format}": { + "get": { + "description": "**Get Daily Historical Records**\n \n \n**Applies to**: Gen 1 (S0 and S1) and Gen 2 pricing tiers.\n\n\nGet Daily Historical Records service returns climatology data such as past daily record temperatures, precipitation and snowfall at a given coordinate location. Availability of records data will vary by location. Generally, historical data may be available as far back as the last 5 to 40+ years, depending on the location.", + "operationId": "Weather_GetDailyHistoricalRecords", + "x-ms-examples": { + "Successful Daily Historical Records Request": { + "$ref": "./examples/GetDailyHistoricalRecords.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat" + }, + { + "name": "query", + "x-ms-client-name": "coordinates", + "in": "query", + "description": "The applicable query specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\".", + "required": true, + "x-ms-parameter-location": "method", + "type": "array", + "collectionFormat": "csv", + "minItems": 2, + "maxItems": 2, + "items": { + "type": "number", + "format": "double" + } + }, + { + "name": "startDate", + "description": "Start date in ISO 8601 format, for example, 2019-10-27. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).", + "in": "query", + "type": "string", + "format": "date", + "required": true + }, + { + "name": "endDate", + "description": "End date in ISO 8601 format, for example, 2019-10-28. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).", + "in": "query", + "type": "string", + "format": "date", + "required": true + }, + { + "$ref": "#/parameters/WeatherDataUnit" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DailyHistoricalRecordsResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/weather/historical/normals/daily/{format}": { + "get": { + "description": "**Get Daily Historical Normals**\n \n \n**Applies to**: Gen 1 (S0 and S1) and Gen 2 pricing tiers.\n\n\nGet Daily Historical Normals service returns climatology data such as past daily normal temperatures, precipitation and cooling/heating degree day information for the day at a given coordinate location. Normals are a 30-year average for temperatures and precipitation for a specific location. As is standard practice in climatology, the 30-year average covers years 1991-2020, this data will be used for one decade and then will reset in the year 2030. Generally, historical data may be available as far back as the last 5 to 40+ years, depending on the location.", + "operationId": "Weather_GetDailyHistoricalNormals", + "x-ms-examples": { + "Successful Daily Historical Normals Request": { + "$ref": "./examples/GetDailyHistoricalNormals.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/JsonFormat" + }, + { + "name": "query", + "x-ms-client-name": "coordinates", + "in": "query", + "description": "The applicable query specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\".", + "required": true, + "x-ms-parameter-location": "method", + "type": "array", + "collectionFormat": "csv", + "minItems": 2, + "maxItems": 2, + "items": { + "type": "number", + "format": "double" + } + }, + { + "name": "startDate", + "description": "Start date in ISO 8601 format, for example, 2019-10-27. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).", + "in": "query", + "type": "string", + "format": "date", + "required": true + }, + { + "name": "endDate", + "description": "End date in ISO 8601 format, for example, 2019-10-28. The date range supported is 1 to 31 calendar days, so be sure to specify a startDate and endDate that does not exceed a maximum of 31 days (i.e.: startDate=2012-01-01&endDate=2012-01-31).", + "in": "query", + "type": "string", + "format": "date", + "required": true + }, + { + "$ref": "#/parameters/WeatherDataUnit" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DailyHistoricalNormalsResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } } }, "definitions": { @@ -2443,6 +2647,186 @@ "description": "A textual explanation that can be used for display purposes to summarize the index value and category. For example, when the index value for Flight Delays is very good, the description will be \"Conditions are excellent for flying!\"." } } + }, + "DailyHistoricalActualsResponse": { + "type": "object", + "properties": { + "historicalActuals": { + "type": "array", + "description": "Historical actuals for each requested day.", + "items": { + "$ref": "#/definitions/DailyHistoricalActuals" + } + } + } + }, + "DailyHistoricalActuals": { + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time", + "description": "Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + }, + "temperature": { + "$ref": "#/definitions/WeatherUnitMaxMinAvg", + "description": "Temperature values." + }, + "degreeDaySummary": { + "$ref": "#/definitions/DegreeDaySummary", + "description": "Summary of heating or cooling degree day information. Degree days are measures of how cold or warm a location is. A degree day compares the mean (the average of the high and low) outdoor temperatures recorded for a location to a standard temperature of 65 degrees F/ 18 degree C." + }, + "precipitation": { + "$ref": "#/definitions/WeatherUnit", + "description": "The amount of precipitation (liquid equivalent) that has fallen." + }, + "snowfall": { + "$ref": "#/definitions/WeatherUnit", + "description": "The amount of snow that has fallen." + }, + "snowDepth": { + "$ref": "#/definitions/WeatherUnit", + "description": "Snow depth." + } + } + }, + "DailyHistoricalRecordsResponse": { + "type": "object", + "properties": { + "historicalRecords": { + "type": "array", + "description": "Historical records for each requested day.", + "items": { + "$ref": "#/definitions/DailyHistoricalRecords" + } + } + } + }, + "DailyHistoricalRecords": { + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time", + "description": "Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + }, + "temperature": { + "$ref": "#/definitions/WeatherUnitYearMaxMinAvg", + "description": "Temperature value." + }, + "precipitation": { + "$ref": "#/definitions/WeatherUnitYearMax", + "description": "Maximum amount of precipitation (liquid equivalent) that has fallen." + }, + "snowfall": { + "$ref": "#/definitions/WeatherUnitYearMax", + "description": "Maximum snowfall." + } + } + }, + "DailyHistoricalNormalsResponse": { + "type": "object", + "properties": { + "historicalNormals": { + "type": "array", + "description": "Historical normals for each requested day.", + "items": { + "$ref": "#/definitions/DailyHistoricalNormals" + } + } + } + }, + "DailyHistoricalNormals": { + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time", + "description": "Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + }, + "temperature": { + "$ref": "#/definitions/WeatherUnitMaxMinAvg", + "description": "Temperature values." + }, + "degreeDaySummary": { + "$ref": "#/definitions/DegreeDaySummary", + "description": "Summary of heating or cooling degree day information" + }, + "precipitation": { + "$ref": "#/definitions/WeatherUnit", + "description": "The amount of precipitation (liquid equivalent) that has fallen." + } + } + }, + "WeatherUnitMaxMinAvg": { + "type": "object", + "description": "Returned temperature values.", + "properties": { + "maximum": { + "$ref": "#/definitions/WeatherUnit", + "description": "Maximum temperature for the time period." + }, + "minimum": { + "$ref": "#/definitions/WeatherUnit", + "description": "Minimum temperature for the time period." + }, + "average": { + "$ref": "#/definitions/WeatherUnit", + "description": "Average temperature for the time period." + } + } + }, + "WeatherUnitYearMax": { + "type": "object", + "description": "Returned temperature values.", + "properties": { + "maximum": { + "$ref": "#/definitions/WeatherUnitYear", + "description": "Maximum temperature for the time period." + } + } + }, + "WeatherUnitYearMaxMinAvg": { + "type": "object", + "description": "Returned temperature values.", + "properties": { + "maximum": { + "$ref": "#/definitions/WeatherUnitYear", + "description": "Maximum temperature for the time period." + }, + "minimum": { + "$ref": "#/definitions/WeatherUnitYear", + "description": "Minimum temperature for the time period." + }, + "average": { + "$ref": "#/definitions/WeatherUnit", + "description": "Average temperature for the time period." + } + } + }, + "WeatherUnitYear": { + "type": "object", + "properties": { + "value": { + "type": "number", + "format": "float", + "description": "Rounded value." + }, + "unit": { + "type": "string", + "description": "Type of unit for the returned value." + }, + "unitType": { + "type": "integer", + "format": "int32", + "description": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details." + }, + "year": { + "type": "integer", + "format": "int32", + "description": "Year the value occurred." + } + } } } }