diff --git a/specification/maps/cspell.yaml b/specification/maps/cspell.yaml index 623f8bda2743..e361272acb39 100644 --- a/specification/maps/cspell.yaml +++ b/specification/maps/cspell.yaml @@ -39,6 +39,9 @@ overrides: words: - locationally - unittype + - Accu + - AccuWeather + - dailyhistoricalactuals - filename: >- **/specification/maps/data-plane/Render/preview/1.0/render.json words: diff --git a/specification/maps/data-plane/Weather/stable/1.1/weather.json b/specification/maps/data-plane/Weather/stable/1.1/weather.json index ffdcb750eb84..833ba962a3a5 100644 --- a/specification/maps/data-plane/Weather/stable/1.1/weather.json +++ b/specification/maps/data-plane/Weather/stable/1.1/weather.json @@ -1840,7 +1840,7 @@ }, "hasPrecipitation": { "type": "boolean", - "description": "Indicates the presence or absence of precipitation. True indicates the presence of precipitation, false indicates the absence of precipitation." + "description": "A boolean value that indicates whether precipitation (rain, snow, sleet, or hail) is expected during the specified timeframe. Returns true if precipitation is expected, otherwise false." }, "isDaylight": { "type": "boolean", @@ -2208,7 +2208,7 @@ }, "hasPrecipitation": { "type": "boolean", - "description": "Indicates the presence or absence of precipitation. True indicates the presence of precipitation, false indicates the absence of precipitation." + "description": "A boolean value that indicates whether precipitation (rain, snow, sleet, or hail) is expected during the specified timeframe. Returns true if precipitation is expected, otherwise false." }, "precipitationType": { "$ref": "#/definitions/PrecipitationType" @@ -2367,7 +2367,7 @@ }, "hasPrecipitation": { "type": "boolean", - "description": "Indicates the presence or absence of precipitation. True indicates the presence of precipitation, false indicates the absence of precipitation." + "description": "A boolean value that indicates whether precipitation (rain, snow, sleet, or hail) is expected during the specified timeframe. Returns true if precipitation is expected, otherwise false." }, "isDayTime": { "x-ms-client-name": "isDaytime", @@ -2469,25 +2469,25 @@ "startDate": { "type": "string", "format": "date-time", - "description": "Date and time that the summary is in effect, displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + "description": "The start date and time for the forecast summary, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, such as *2019-10-27T19:39:57-08:00*." }, "endDate": { "type": "string", "format": "date-time", - "description": "Date and time that the summary period ends, displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + "description": "The end date and time for the forecast summary, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, such as *2019-10-27T19:39:57-08:00*." }, "severity": { "type": "integer", "format": "int32", - "description": "severity" + "description": "Indicates the severity of the forecasted weather as an integer. Lower numbers represent higher severity: 0 = Unknown, 1 = Significant, 2 = Major, 3 = Moderate, 4 = Minor, 5 = Minimal, 6 = Insignificant, 7 = Informational." }, "phrase": { "type": "string", - "description": "Summary phrase of the daily forecast. Displayed in specified language." + "description": "Provides a brief textual summary of the daily weather conditions, displayed in the specified language." }, "category": { "type": "string", - "description": "one or 2 word(s) to summarize the phrase." + "description": "Provides a one or two-word summary of the forecasted weather conditions, such as Sunny, Partly Cloudy, Rain, or Snow." } }, "description": "Summary for the main conditions for the requested time period. Notice that summary can cover only part of the time period." @@ -2507,63 +2507,65 @@ }, "AirAndPollen": { "type": "object", + "description": "The AirAndPollen object provides comprehensive environmental data. It identifies various pollen types such as tree, grass, ragweed, and mold, and pollutants including PM2.5, PM10, O3, NO2, SO2, and CO. Additionally, it reports the UV Index on a scale from 1 to 10, offers qualitative descriptions of air quality or pollen levels, and provides numerical measurements of the concentration of pollutants or pollen in the air. This detailed information helps users assess air quality and pollen conditions along their travel route.", "properties": { "name": { "x-ms-client-name": "description", "type": "string", - "description": "Name of the pollen or pollutant. For example, grass, mold, weed, air quality, tree and UV index." + "description": "**For pollen:**\nReturns the name of the pollen, such as tree, grass, ragweed, or mold.\n\n**For pollutants:**\nWhen the `name` property is `AirQuality`, the name of the pollutant is returned in the `type` property.\nValid pollutants include: PM2.5, PM10, O3,NO2,SO2,CO.\n\n**For UV Index:**\nWhen the `name` property is `UVIndex`, the UV index is returned in the `value` property. Valid UV Index values range from 0 to 11+ and represent the intensity of ultraviolet radiation.\nUV Index values are categorized as follows:\n" }, "value": { "type": "integer", "format": "int32", - "description": "Value of the given type above. Values associated with mold, grass, weed and tree are in units of parts per cubic meter. Both air quality and UV are indices, so they are unitless." + "description": "Provides a numerical measurement of the concentration of pollutants or pollen in the air. This value is typically expressed in units relevant to the type of pollutant or pollen being measured, such as micrograms per cubic meter (µg/m³) for particulate matter or parts per billion (ppb) for gases like ozone. Both air quality and UV are indices, so they are unitless." }, "category": { "type": "string", - "description": "Category of the air quality or pollution type. For example, low, high, good, moderate, unhealthy, hazardous." + "description": "Provides a one-word qualitative description of the air quality or pollen level for the forecast period in the specified language. This property categorizes the air quality or pollen count into different levels, such as low, high, good, moderate, unhealthy, hazardous giving users an easy-to-understand assessment of the current conditions." }, "categoryValue": { "type": "integer", "format": "int32", - "description": "Value associated with the air quality or pollution category. These values range from 1 to 6. 1 implying good conditions, 6 implying hazardous conditions." + "description": "Provides a numerical representation of the air quality or pollen level. This value corresponds to the qualitative `category` property, offering a precise way to quantify the air quality or pollen level." }, "type": { "x-ms-client-name": "airQualityType", "type": "string", - "description": "Only exists for air quality. Examples include ozone and particle pollution." + "description": "Specifies the type of air pollutant being measured. Only used when the `name` property equals *AirQuality*. Examples of air pollutants include Particulate Matter (PM2.5, PM10), Ozone (O3), Nitrogen Dioxide (NO2), Sulfur Dioxide (SO2), and Carbon Monoxide (CO)." } } }, "DailyForecast": { "type": "object", + "description": "Provides detailed weather information for a specific day, such as temperature, wind, precipitation, air quality, and UV index.", "properties": { "date": { "x-ms-client-name": "dateTime", "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." + "description": "Date and time of the current observation, displayed in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format (yyyy-mm-ddThh:mm:ss-hh:mm). For example, *2025-04-29T07:00:00-07:00*." }, "temperature": { "$ref": "#/definitions/WeatherUnitRange", - "description": "Temperature values for the day." + "description": "Provides the forecasted high and low temperatures for the day, in degrees Celsius (C) or Fahrenheit (F), depending on the `unit` specified in the request." }, "realFeelTemperature": { "$ref": "#/definitions/WeatherUnitRange", - "description": "RealFeel™ Temperature being returned." + "description": "Provides RealFeel™ Temperature values for the specified day, measured in degrees Celsius (C) or Fahrenheit (F), depending on the unit specified in the request. This metric, developed by AccuWeather, incorporates over a dozen factors, including humidity, wind speed, cloud cover, and sun intensity, to offer a comprehensive measure of how the weather actually feels.\n\nFor more information, see [What is the AccuWeather RealFeel Temperature?](https://www.accuweather.com/en/weather-news/what-is-the-accuweather-realfeel-temperature/156655)" }, "realFeelTemperatureShade": { "$ref": "#/definitions/WeatherUnitRange", - "description": "RealFeel™ Temperature being returned. Describes what the temperature really feels like in the shade." + "description": "Provides RealFeel™ Temperature values for the specified day in shaded areas. This metric, developed by AccuWeather, incorporates over a dozen factors, including humidity, wind speed, cloud cover, and sun intensity, to offer a comprehensive measure of how the weather actually feels in the shade." }, "hoursOfSun": { "type": "number", "format": "float", - "description": "Hours of sun." + "description": "Provides the expected number of hours of sunshine for the specified day." }, "degreeDaySummary": { "x-ms-client-name": "meanTemperatureDeviation", "$ref": "#/definitions/DegreeDaySummary", - "description": "Summary for mean temperature of Heating Degree Day or Cooling Degree Day information" + "description": "Provides a summary of heating and cooling degree days. Heating Degree Days (HDD) measure the demand for energy to heat a building, calculated based on the degrees a day's average temperature is below 65°F/18°C. Cooling Degree Days (CDD) measure the demand for energy to cool a building, calculated based on the degrees a day's average temperature is above 65°F/18°C. This summary aids in energy management and planning." }, "airAndPollen": { "x-ms-client-name": "airQuality", @@ -2571,20 +2573,20 @@ "items": { "$ref": "#/definitions/AirAndPollen" }, - "description": "Air quality" + "description": "A list containing pollutants, pollen levels, and the UV index for the daily forecast. Each list item includes forecasted amounts and categories (e.g., low, high, good, moderate, unhealthy, hazardous) to assess potential health risks." }, "day": { "x-ms-client-name": "daytimeForecast", "$ref": "#/definitions/DayOrNight", - "description": "Day forecast detail" + "description": "Provides detailed weather information for the daytime weather forecast, including temperature, precipitation, wind, and other key attributes." }, "night": { "x-ms-client-name": "nighttimeForecast", "$ref": "#/definitions/DayOrNight", - "description": "Night forecast detail" + "description": "Provides detailed weather information for the nighttime weather forecast, including temperature, precipitation, wind, and other key attributes." }, "sources": { - "description": "Source(s) of the forecast data.", + "description": "A list of sources contributing to the weather forecast data.", "type": "array", "items": { "type": "string" @@ -2644,7 +2646,7 @@ }, "hasPrecipitation": { "type": "boolean", - "description": "Indicates the presence or absence of precipitation. True indicates the presence of precipitation, false indicates the absence of precipitation." + "description": "A boolean value that indicates whether precipitation (rain, snow, sleet, or hail) is expected during the specified timeframe. Returns true if precipitation is expected, otherwise false." }, "precipitationType": { "$ref": "#/definitions/PrecipitationType" @@ -3119,51 +3121,51 @@ }, "DailyIndex": { "type": "object", - "description": "Information about a daily index.", + "description": "The DailyIndex object helps users plan outdoor activities based on weather conditions by providing the activity name, such as 'Ski Weather Forecast'; a numerical rating from 0.0 to 10.0 indicating suitability; a text rating, such as 'Poor'; and a brief description of the conditions, such as 'Expect poor conditions for skiing.'", "properties": { "indexName": { "type": "string", - "description": "Name of the index, for example, \"Construction\", \"Outdoor Activity\", \"Flight Delays\"." + "description": "The name of the index, indicating the type of activity or condition it relates to, such as running, golfing, or other outdoor activities. For more information, see [Index IDs](/azure/azure-maps/weather-services-concepts#index-ids-and-index-groups-ids) in the *Weather service in Azure Maps* concepts article." }, "indexId": { "type": "integer", "format": "int32", - "description": "Numeric ID used to identify the specific index. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#daily-index-range-sets) for details and to see the supported index IDs. For example, the index ID can support UI visualization scenarios." + "description": "A numeric identifier that uniquely represents a specific index type, distinguishing between different indices for various outdoor activities. For example, an 'indexId' of 1 corresponds to the 'Running' index, and an 'indexId' of 5 corresponds to the 'Golfing' index. For more information, see [Index IDs](/azure/azure-maps/weather-services-concepts#index-ids-and-index-groups-ids) in the *Weather service in Azure Maps* concepts article." }, "dateTime": { "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." + "description": "Date and time of the observation in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format (yyyy-mm-ddThh:mm:ss-hh:mm). For example, *2025-04-29T07:00:00-07:00*." }, "value": { "type": "number", "format": "float", - "description": "Index value. Ranges from 0.0 to 10.0. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#daily-index-range-sets) for details and to see the supported ranges." + "description": "A numerical index value ranging from 0.0 to 10.0 that quantifies the suitability of weather conditions for a specific activity or condition, such as running or golfing. Higher values typically indicate more favorable conditions, depending on the value of the `ascending` property. For example, a value of 8 for the 'Running' index suggests very good weather for running, while a value of 6 for the 'Golfing' index indicates good but slightly less ideal conditions. For more information, see [Daily index range sets](/azure/azure-maps/daily-index-range-sets) in the *Weather service in Azure Maps* concepts article." }, "category": { "x-ms-client-name": "categoryDescription", "type": "string", - "description": "Textual description for `categoryValue` corresponding to the level that the index value falls under, for example \"Very Good\"." + "description": "Provides a qualitative assessment of the index, describing the `categoryValue` property. Categories vary among indices and may include values such as Excellent, Good, Fair, Poor, and Very Poor." }, "categoryValue": { "type": "integer", "format": "int32", - "description": "Level that the index value falls under, represented by an integer. This value can be 1 through 5 and should be used in combination with the `ascending` flag because it can differ among indices. For example, the following values apply for Mosquito Activity: Low=1, Moderate=2, High=3, Very High=4, and Extreme=5." + "description": "Provides a numeric representation of the category property, indicating the qualitative assessment of the index. Values range from 1 to 5 and should be used with the ascending flag, as they can differ among indices. For example, for Mosquito Activity: Low=1, Moderate=2, High=3, Very High=4, Extreme=5." }, "ascending": { "x-ms-client-name": "isAscending", "type": "boolean", - "description": "Describes the direction of the `value` and `categoryValue`. For example, when set to `true`, the poorest index value is 0 and the best index value is 10. When set to `true`, the poorest index value is 10 and the best index value is 0." + "description": "Indicates the direction of the `value` and `categoryValue` properties. When true, the poorest index value is 0 and the best index value is 10. When false, the poorest index value is 10 and the best index value is 0." }, "description": { "type": "string", - "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!\"." + "description": "Provides a brief, user-friendly explanation of the index value, helping users understand its significance in relation to specific weather conditions or activities. For example, if the index value for Outdoor Barbecue is 'Excellent', the description will be 'This is a great day for an outdoor barbecue!'" } } }, "ActiveStormResult": { "type": "object", - "description": "All government-issued active storms", + "description": "The ActiveStormResult object provides comprehensive information about ongoing tropical storms. It includes an array of [ActiveStorm](#ActiveStorm) objects, each detailing specific attributes of individual storms. These attributes encompass the storm's government ID, basin ID, year of origin, name, and subtropical status.", "properties": { "results": { "type": "array", @@ -3171,7 +3173,7 @@ "items": { "$ref": "#/definitions/ActiveStorm" }, - "description": "All government-issued active storms" + "description": "An array of [ActiveStorm](#ActiveStorm) objects, each providing essential details about an ongoing tropical storm, as reported by national weather forecasting agencies." }, "nextLink": { "$ref": "#/definitions/NextLink" @@ -3180,32 +3182,32 @@ }, "ActiveStorm": { "type": "object", - "description": "Government-issued active storm", + "description": "Provides essential details about ongoing tropical storms, as reported by national weather forecasting agencies.", "properties": { "year": { "type": "string", - "description": "Year of origination" + "description": "Specifies the year in which the tropical storm originated." }, "basinId": { "$ref": "#/definitions/basinId", - "description": "Basin identifier (AL, EP, SI, NI, CP, NP, SP)" + "description": "Categorizes the different ocean basins where tropical storms can originate. Each basin is assigned a unique identifier to help specify the location of the storm's origin. Valid Basin identifiers include AL, CP, EP, NI, NP, SI, and SP." }, "name": { "type": "string", - "description": "The name of the depression." + "description": "The name of the storm." }, "isActive": { "type": "boolean", - "description": "True if the depression has been updated recently." + "description": "Indicates whether the tropical storm is currently active. If true, the storm is active; if false, the storm is not active." }, "isSubtropical": { "type": "boolean", - "description": "True when the depression is classified as a subtropical cyclone." + "description": "A return value of true indicates that the storm is classified as a subtropical cyclone, meaning it has both tropical and extratropical features." }, "govId": { "type": "integer", "format": "int32", - "description": "Government storm ID. This will match the depression number." + "description": "A unique identifier assigned to tropical storms by national weather forecasting agencies. This identifier helps track and reference specific storms accurately, including its status, location, and intensity." } } }, @@ -3258,7 +3260,7 @@ }, "StormSearchResult": { "type": "object", - "description": "Search government-issued storms", + "description": "Contains a list of government-issued storms that meet the specified search criteria, including details such as the storm's basin ID, government-issued ID and status.", "properties": { "results": { "type": "array", @@ -3266,7 +3268,7 @@ "items": { "$ref": "#/definitions/StormSearchResultItem" }, - "description": "Search government-issued storms" + "description": "Array of [StormSearchResultItem](#stormsearchresultitem) objects, each representing a tropical storm matching the search criteria provided in the request." }, "nextLink": { "$ref": "#/definitions/NextLink" @@ -3275,42 +3277,42 @@ }, "StormSearchResultItem": { "type": "object", - "description": "Government-issued active storm event", + "description": "A government-issued storm event, including the storm's basin identifier (basinId), government-issued identifier (govId) and status. This object is returned as part of an array within the [StormSearchResult](#stormsearchresult) object.", "properties": { "year": { "type": "string", - "description": "Year of origination" + "description": "Specifies the year in which the tropical storm originated." }, "basinId": { "$ref": "#/definitions/basinId", - "description": "Basin identifier (AL, EP, SI, NI, CP, NP, SP)" + "description": "Categorizes the different ocean basins where tropical storms can originate. Each basin is assigned a unique identifier to help specify the location of the storm's origin. Valid Basin identifiers include AL, CP, EP, NI, NP, SI, and SP." }, "name": { "type": "string", - "description": "The name of the depression." + "description": "Identifies the tropical storm by its official name, as designated by the relevant national weather forecasting agency." }, "isActive": { "type": "boolean", - "description": "True if the depression has been updated recently." + "description": "Indicates whether the tropical storm is currently active. If true, the storm is active; if false, the storm is not active" }, "isRetired": { "type": "boolean", - "description": "True if the storm name has been permanently retired in the source basin." + "description": "Returns true if the storm has been permanently retired in the source basin." }, "isSubtropical": { "type": "boolean", - "description": "True when the depression is classified as a subtropical cyclone." + "description": "Returns true if the storm is classified as a subtropical cyclone, meaning it has both tropical and extratropical features." }, "govId": { "type": "integer", "format": "int32", - "description": "Government storm ID. This will match the depression number." + "description": "A unique identifier assigned to tropical storms by national weather forecasting agencies. This identifier helps track and reference specific storms accurately, including its status, location, and intensity. This will match the depression number." } } }, "StormForecastResult": { "type": "object", - "description": "The list of Government-issued forecasts", + "description": "An array of [StormForecast](#stormforecast) objects, each detailing individual storm forecasts issued by government authorities.", "properties": { "results": { "type": "array", @@ -3318,7 +3320,7 @@ "items": { "$ref": "#/definitions/StormForecast" }, - "description": "The list of Government-issued forecasts" + "description": "An array of forecast data for tropical storms, including predicted paths, intensities, and other relevant details. These forecasts are issued by government authorities." }, "nextLink": { "$ref": "#/definitions/NextLink" @@ -3327,46 +3329,46 @@ }, "StormForecast": { "type": "object", - "description": "Government-issued storm forecast", + "description": "The StormForecast object contains detailed Government-issued information about forecasted tropical storms, including the storm's location, status, forecast creation date, wind speed, and wind radii.", "properties": { "dateTime": { "type": "string", "x-ms-client-name": "timestamp", - "description": "Datetime the forecast is valid, displayed in ISO8601 format." + "description": "Date and time that the current forecast is valid, displayed in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format (yyyy-mm-ddThh:mm:ss-hh:mm). For example, *2025-04-29T07:00:00-07:00*." }, "initializedDateTime": { "type": "string", "x-ms-client-name": "initialized_timestamp", - "description": "Datetime the forecast was created, displayed in ISO8601 format." + "description": "Date and time that the forecast was created, displayed in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format (yyyy-mm-ddThh:mm:ss-hh:mm). For example, *2025-04-29T07:00:00-07:00*." }, "location": { "$ref": "../../../Common/preview/1.0/common.json#/definitions/LatLongPair", "x-ms-client-name": "coordinates", - "description": "Coordinates of the storm" + "description": "Specifies the geographical coordinates (latitude and longitude) of the storm's forecasted position." }, "maxWindGust": { "$ref": "#/definitions/WeatherUnit", - "description": "Maximum wind gust speed associated with the storm. May be NULL." + "description": "Specifies the expected maximum wind gust speed and direction expected during the storm, measured in kilometers per hour (km/h) or miles per hour (mph), based on the specified unit. Wind direction is given in azimuth degrees, ranging from 0° (true North) to 359°, moving clockwise. May be NULL." }, "sustainedWind": { "$ref": "#/definitions/WeatherUnit", - "description": "Maximum sustained wind speed associated with the storm. May be NULL." + "description": "Specifies the maximum sustained wind speed expected during the storm, measured in kilometers per hour (km/h) or miles per hour (mph), based on the unit specified in the request. May be NULL." }, "status": { "type": "string", - "description": "Possible status values include:" + "description": "Indicates the current state or condition of the storm. This property provides information on whether the storm is active, dissipating, or has reached another significant status. Possible values:" }, "window": { "$ref": "#/definitions/WeatherWindow", "x-ms-client-name": "WeatherWindow", - "description": "Contains information about the forecast window for the storm during the specified time period (not the entire cone). If windowGeometry=true in the request, this object will include geoJSON details for window geometry." + "description": "Provides forecast details for the storm within the specified time frame. If the `windowGeometry` parameter is set to true in the API request, this property will include GeoJSON details for the window geometry." }, "windRadiiSummary": { "type": "array", "items": { "$ref": "#/definitions/StormWindRadiiSummary" }, - "description": "Displayed when details=true or radiiGeometry=true in the request." + "description": "Contains an array of [StormWindRadiiSummary](#stormwindradiisummary) objects, detailing wind radii in different quadrants around the storm's center. Displayed when `details=true` or `radiiGeometry=true` in the request." } } }, @@ -3412,33 +3414,33 @@ }, "StormWindRadiiSummary": { "type": "object", - "description": "Displayed when details=true or radiiGeometry=true in the request.", + "description": "The StormWindRadiiSummary object provides a high-level overview of the wind distribution around a tropical storm. It includes the geometric representation of wind radii (radiiGeometry), detailed sector-based wind data (radiusSectorData), and the wind speeds at various distances from the storm's center (windSpeed). These properties collectively help in understanding the spatial extent and intensity of winds associated with the storm. Displayed when the request includes `details=true` or `radiiGeometry=true`.", "properties": { "dateTime": { "type": "string", "x-ms-client-name": "timestamp", - "description": "DateTime for which the wind radii summary data is valid, displayed in ISO8601 format." + "description": "Date and time that the wind radii summary data is valid, displayed in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format (yyyy-mm-ddThh:mm:ss-hh:mm). For example, *2025-04-29T07:00:00-07:00*." }, "windSpeed": { "$ref": "#/definitions/WeatherUnit", - "description": "Wind speed associated with the radiusSectorData." + "description": "The overall wind speed associated with the storm's wind radii data. This single wind speed value applies collectively to all the sectors within the [radiusSectorData](#radiusSectorData) array, which provides detailed geographical information for the NE, SE, SW, and NW quadrants of the storm's wind radii." }, "radiusSectorData": { "type": "array", - "description": "Contains the information needed to plot wind radius quadrants. Bearing 0–90 = NE quadrant; 90–180 = SE quadrant; 180–270 = SW quadrant; 270–360 = NW quadrant.", + "description": "An array of [RadiusSector](#RadiusSector) objects. Each object contains detailed geographical information (in geoJSON format) needed to plot wind radius quadrants: 0-90° for NE, 90-180° for SE, 180-270° for SW, and 270-360° for NW.", "items": { "$ref": "#/definitions/RadiusSector" } }, "radiiGeometry": { "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonGeometry", - "description": "GeoJSON object. Displayed when radiiGeometry=true in request. Describes the outline of the wind radius quadrants." + "description": "A GeoJSON object that is returned when the `radiiGeometry` parameter is set to true in the request. It provides detailed geographical information about the storm's wind radii, including the spatial representation of areas affected by different wind speeds." } } }, "RadiusSector": { "type": "object", - "description": "Bearing 0–90 = NE quadrant; 90–180 = SE quadrant; 180–270 = SW quadrant; 270–360 = NW quadrant.", + "description": "Bearing 0-90 = NE quadrant; 90-180 = SE quadrant; 180-270 = SW quadrant; 270-360 = NW quadrant.", "properties": { "beginBearing": { "type": "number", @@ -3460,7 +3462,7 @@ }, "StormLocationsResult": { "type": "object", - "description": "Locations for an individual government-issued storm", + "description": "Contains an array of [StormLocation](#stormlocation) objects, representing government-issued active storm events. Includes details such as latitude and longitude coordinates, wind speed and direction, wind radii, basin identifier, minimum pressure, movement, status, and other relevant attributes.", "properties": { "results": { "type": "array", @@ -3468,7 +3470,7 @@ "items": { "$ref": "#/definitions/StormLocation" }, - "description": "Locations for an individual government-issued storm" + "description": "Array of data points, each detailing the location of an individual government-issued storm, including coordinates, geometry, basin ID, date, wind details, and wind radii." }, "nextLink": { "$ref": "#/definitions/NextLink" @@ -3477,7 +3479,7 @@ }, "StormLocation": { "type": "object", - "description": "Location for an individual Government-issued storm", + "description": "Contains detailed information about a tropical storm's location, including latitude and longitude coordinates, wind speed and direction, wind radii, and basin identifier. Essential for tracking and forecasting the storm's movement and intensity.", "properties": { "dateTime": { "type": "string", @@ -3491,27 +3493,27 @@ }, "maxWindGust": { "$ref": "#/definitions/WeatherUnit", - "description": "Maximum wind gust speed associated with the storm. May be NULL." + "description": "Specifies the expected maximum wind gust speed and direction expected during the storm, measured in kilometers per hour (km/h) or miles per hour (mph), based on the specified unit. Wind direction is given in azimuth degrees, ranging from 0° (true North) to 359°, moving clockwise. May be NULL." }, "sustainedWind": { "$ref": "#/definitions/WeatherUnit", - "description": "Maximum sustained wind speed associated with the storm. May be NULL." + "description": "Maximum sustained wind speed associated with the storm, measured in kilometers per hour (km/h) or miles per hour (mph), based on the specified unit. May be NULL." }, "minimumPressure": { "$ref": "#/definitions/WeatherUnit", - "description": "Minimum pressure associated with the storm. May be NULL." + "description": "Specifies the lowest atmospheric pressure associated with the storm, measured in millibars (mb) or inches of mercury (inHg), depending on the unit specified in the request. This value may be NULL." }, "movement": { "$ref": "#/definitions/WindDetails", - "description": "The storm movement information." + "description": "Returns the storm's current direction (in degrees) and speed, measured in kilometers per hour (km/h) or miles per hour (mph), depending on the specified unit." }, "status": { "type": "string", - "description": "Storm status, in English." + "description": "Returns the current classification or stage of the storm in English, such as a tropical depression, tropical storm, or hurricane." }, "isSubtropical": { "type": "boolean", - "description": "True when the depression is classified as a subtropical cyclone." + "description": "A return value of true indicates that the storm is classified as a subtropical cyclone, meaning it has both tropical and extratropical features." }, "hasTropicalPotential": { "type": "boolean", @@ -3519,20 +3521,20 @@ }, "isPostTropical": { "type": "boolean", - "description": "True when the storm is weakening away, and will no longer become a tropical system." + "description": "Returns true if the storm has transitioned from a tropical cyclone to a post-tropical cyclone, aiding in understanding the storm's lifecycle phase." }, "windRadiiSummary": { "type": "array", "items": { "$ref": "#/definitions/StormWindRadiiSummary" }, - "description": "Displayed when details=true or radiiGeometry=true in the request." + "description": "Contains an array of [StormWindRadiiSummary](#stormwindradiisummary) objects, detailing wind radii in different quadrants around the storm's center. Displayed when `details=true` or `radiiGeometry=true` in the request." } } }, "AirQualityResult": { "type": "object", - "description": "This object is returned from a successful Get Air Quality call.", + "description": "An array of [AirQuality](#airquality) objects, each providing comprehensive information about the current air quality at the specified location.", "properties": { "results": { "type": "array", @@ -3540,7 +3542,7 @@ "items": { "$ref": "#/definitions/AirQuality" }, - "description": "A list of all air quality results for the queried location." + "description": "Detailed air quality results within the specified location, including properties such as the air quality index (AQI), dominant pollutant, pollutant levels, risk level, and suggested precautions." }, "nextLink": { "$ref": "#/definitions/NextLink" @@ -3549,7 +3551,7 @@ }, "DailyAirQualityForecastResult": { "type": "object", - "description": "This object is returned from a successful Get Daily Air Quality Forecast call.", + "description": "Returns an array of [DailyAirQuality](#dailyairquality) objects, each detailing the forecasted air quality for a specific day. The number of days included is determined by the `duration` URI parameter (1-7 days, default is 1).", "properties": { "results": { "type": "array", @@ -3557,7 +3559,7 @@ "items": { "$ref": "#/definitions/DailyAirQuality" }, - "description": "A list of all daily air quality forecasts for the queried location." + "description": "Detailed air quality forecast data for each day within the requested duration, including properties such as date, air quality index (AQI), dominant pollutant, pollutant levels, risk level, and suggested precautions." }, "nextLink": { "$ref": "#/definitions/NextLink" @@ -3566,35 +3568,35 @@ }, "AirQuality": { "type": "object", - "description": "Information about the air quality in a specific location at a specific time.", + "description": "The AirQuality object provides comprehensive information about the current air quality at the specified location. This includes the concentration levels of various pollutants, numerical Air Quality Index (AQI) values indicating the overall air quality, and identification of the dominant pollutant affecting the air quality. Additionally, it offers a risk level summary, which briefly outlines potential health risks and suggests precautions.", "properties": { "dateTime": { "type": "string", "format": "date-time", "x-ms-client-name": "timestamp", - "description": "Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + "description": "Date and time of the current observation, displayed in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format (yyyy-mm-ddThh:mm:ss-hh:mm). For example, *2025-04-29T07:00:00-07:00*." }, "index": { "type": "number", "format": "float", - "description": "Air quality rating on a scale set by local regulating bodies. Scales can vary widely based on location. See [Wikipedia](https://en.wikipedia.org/wiki/Air_quality_index) for more information." + "description": "The air quality index (AQI) is an air quality rating scale set by local regulating bodies. Scales can vary widely based on location. For more information, see [Air quality index](https://en.wikipedia.org/wiki/Air_quality_index) in Wikipedia." }, "globalIndex": { "type": "number", "format": "float", - "description": "Internationally normalized air quality rating on a scale from 0 to 300 and up, with higher numbers representing worse air quality." + "description": "Provides an internationally standardized way to understand the concentration of pollutants in the air. Ratings range from 0 to 300 and up, with higher numbers representing worse air quality. The pollutants measured includes PM2.5, PM10, NO2, SO2, CO, and O3." }, "dominantPollutant": { "$ref": "#/definitions/DominantPollutant", - "description": "The pollutant with the highest concentration." + "description": "Identifies the pollutant with the highest concentration." }, "category": { "type": "string", - "description": "One-word description of the air quality in the requested language. For example, \"Excellent\"." + "description": "Provides a one-word description of the air quality for the forecast period in the specified language, such as Poor, Fair, or Excellent." }, "categoryColor": { "type": "string", - "description": "A unique color corresponding to the category of this air quality result." + "description": "Provides a unique hexadecimal color code corresponding to the air quality category for each day in the forecast period. This color helps users quickly identify the air quality level visually, with each color corresponding to a category such as Poor, Fair, or Excellent." }, "description": { "type": "string", @@ -3605,29 +3607,29 @@ "items": { "$ref": "#/definitions/Pollutant" }, - "description": "Information about individual pollutants." + "description": "An array containing detailed information about each pollutant in the response. Returned when the `pollutants` URI Parameter is *true*." } } }, "DailyAirQuality": { "type": "object", - "description": "Information about the air quality in a specific location at a specific time.", + "description": "Provides a summary of the forecasted air quality conditions for a specific day and location, in the requested language. This includes key metrics such as the air quality index (AQI), the dominant pollutant expected for that day, and a brief description of the overall air quality. The information helps users understand what to expect regarding air quality and any potential health implications for the forecasted day.", "properties": { "dateTime": { "type": "string", "format": "date-time", "x-ms-client-name": "timestamp", - "description": "Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + "description": "Date and time of the current observation, displayed in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format (yyyy-mm-ddThh:mm:ss-hh:mm). For example, *2025-04-29T07:00:00-07:00*." }, "index": { "type": "number", "format": "float", - "description": "Air quality rating on a scale set by local regulating bodies. Scales can vary widely based on location. See [Wikipedia](https://en.wikipedia.org/wiki/Air_quality_index) for more information." + "description": "The air quality index (AQI) is a rating scale set by local regulating bodies, which can vary widely by location. For more information, see [Air quality index](https://en.wikipedia.org/wiki/Air_quality_index) in Wikipedia." }, "globalIndex": { "type": "number", "format": "float", - "description": "Internationally normalized air quality rating on a scale from 0 to 300 and up, with higher numbers representing worse air quality." + "description": "Provides an internationally standardized air quality rating from 0 to 300 and above, with higher numbers indicating worse air quality. The index measures pollutants such as PM2.5, PM10, NO2, SO2, CO, and O3." }, "dominantPollutant": { "$ref": "#/definitions/DominantPollutant", @@ -3635,15 +3637,15 @@ }, "category": { "type": "string", - "description": "One-word description of the air quality in the requested language. For example, \"Excellent\"." + "description": "Provides a one-word summary of the air quality for the forecast period in the specified language, such as Poor, Fair, or Excellent. This summary helps users quickly understand the overall air quality conditions." }, "categoryColor": { "type": "string", - "description": "A unique color corresponding to the category of this air quality result." + "description": "Provides a unique hexadecimal color code for each air quality category in the daily forecast, visually representing levels such as Poor, Fair, or Excellent." }, "description": { "type": "string", - "description": "A textual explanation of this air quality result in the requested language." + "description": "Provides a summary of the forecasted air quality conditions for a specific day and location, in the requested language." } } }, @@ -3761,10 +3763,11 @@ }, "DailyHistoricalActualsResult": { "type": "object", + "description": "Returns an array of [DailyHistoricalActuals](#dailyhistoricalactuals) objects, each detailing the observed historical weather data for the specified date and location. The number of days included is determined by the `startDate` and `endDate` URI parameters which can include up to 31 days.", "properties": { "results": { "type": "array", - "description": "Historical actuals for each requested day.", + "description": "Aggregates detailed historical weather data for specific dates and locations, including temperature, precipitation, snowfall, snow depth, and degree day summaries.", "x-ms-client-name": "historicalActuals", "items": { "$ref": "#/definitions/DailyHistoricalActuals" @@ -3777,41 +3780,43 @@ }, "DailyHistoricalActuals": { "type": "object", + "description": "Provides climatology data for a specific day, including observed temperatures, precipitation, snowfall, snow depth, and heating/cooling degree days.", "properties": { "date": { "type": "string", "format": "date-time", "x-ms-client-name": "timestamp", - "description": "Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + "description": "The date and time for the requested weather data in ISO 8061 format displayed in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (yyyy-mm-ddThh:mm:ss-hh:mm). For example, *2025-04-29T07:00:00-07:00*." }, "temperature": { "$ref": "#/definitions/WeatherUnitMaxMinAvg", - "description": "Temperature values." + "description": "Provides the observed maximum, minimum, and average temperatures for a specific day at a given location." }, "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." + "description": "Provides a summary of heating and cooling degree days. Heating Degree Days (HDD) measure the demand for energy to heat a building, calculated based on the degrees a day's average temperature is below 65°F/18°C. Cooling Degree Days (CDD) measure the demand for energy to cool a building, calculated based on the degrees a day's average temperature is above 65°F/18°C. This summary aids in energy management and planning." }, "precipitation": { "$ref": "#/definitions/WeatherUnit", - "description": "The amount of precipitation (liquid equivalent) that has fallen." + "description": "The amount of precipitation accumulated over the specified day, measured in centimeters (cm) or inches (in), depending on the unit specified in the request." }, "snowfall": { "$ref": "#/definitions/WeatherUnit", - "description": "The amount of snow that has fallen." + "description": "Provides the amount of snow that has fallen over the specified day, measured in centimeters (cm) or inches (in), based on the specified unit in the request." }, "snowDepth": { "$ref": "#/definitions/WeatherUnit", - "description": "Snow depth." + "description": "Provides the average accumulated snow depth, measured in centimeters (cm) or inches (in), based on the specified unit in the request." } } }, "DailyHistoricalRecordsResult": { "type": "object", + "description": "Provides an array of historical Daily Historical Records for specified dates and locations, each with aggregate detailed climatology data for the requested day, such as record temperatures, precipitation, and snowfall.", "properties": { "results": { "type": "array", - "description": "Historical records for each requested day.", + "description": "Aggregates detailed climatology data for each requested day, including record temperatures, precipitation, snowfall, snow depth, and degree day summaries.", "x-ms-client-name": "historicalRecords", "items": { "$ref": "#/definitions/DailyHistoricalRecords" @@ -3829,28 +3834,29 @@ "type": "string", "format": "date-time", "x-ms-client-name": "timestamp", - "description": "Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + "description": "Date and time of the current observation, displayed in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (yyyy-mm-ddThh:mm:ss-hh:mm). For example, *2025-04-29T07:00:00-07:00*." }, "temperature": { "$ref": "#/definitions/WeatherUnitYearMaxMinAvg", - "description": "Temperature value." + "description": "Returns the year in which both the minimum and the maximum temperatures occurred on a specified day, along with the recorded amounts. Also returns the average temperature for the given date. Measured in degrees Celsius (C) or Fahrenheit (F), depending on the unit specified in the request." }, "precipitation": { "$ref": "#/definitions/WeatherUnitYearMax", - "description": "Maximum amount of precipitation (liquid equivalent) that has fallen." + "description": "The amount of precipitation accumulated over the specified day, measured in centimeters (cm) or inches (in), based on the specified unit in the request." }, "snowfall": { "$ref": "#/definitions/WeatherUnitYearMax", - "description": "Maximum snowfall." + "description": "Returns the year in which the record high snowfall occurred on a specified date, along with the recorded amounts, measured in centimeters (cm) or inches (in), based on the unit specified in the request." } } }, "DailyHistoricalNormalsResult": { "type": "object", + "description": "Returns an array of [DailyHistoricalNormals](#dailyhistoricalnormals) objects, each detailing climatology data such as past daily normal temperatures, precipitation, and cooling/heating degree day information for the specified date range, calculated as a 30-year average (1991-2020). The number of days included is determined by the `startDate` and `endDate` URI parameters, which can include up to 31 days.", "properties": { "results": { "type": "array", - "description": "Historical normals for each requested day.", + "description": "Aggregates detailed climatology data for each requested day, including normal temperatures, precipitation, snowfall, snow depth, and degree day summaries.", "x-ms-client-name": "historicalNormals", "items": { "$ref": "#/definitions/DailyHistoricalNormals" @@ -3868,19 +3874,19 @@ "type": "string", "format": "date-time", "x-ms-client-name": "timestamp", - "description": "Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + "description": "Date and time of the current observation, displayed in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (yyyy-mm-ddThh:mm:ss-hh:mm). For example, *2025-04-29T07:00:00-07:00*." }, "temperature": { "$ref": "#/definitions/WeatherUnitMaxMinAvg", - "description": "Temperature values." + "description": "Provides the normal high, low, and average temperatures for a specific day at a given location, calculated as a 30-year average (1991-2020)." }, "degreeDaySummary": { "$ref": "#/definitions/DegreeDaySummary", - "description": "Summary of heating or cooling degree day information" + "description": "Provides a summary of heating and cooling degree days. Heating Degree Days (HDD) measure the demand for energy to heat a building, calculated based on the degrees a day's average temperature is below 65°F/18°C. Cooling Degree Days (CDD) measure the demand for energy to cool a building, calculated based on the degrees a day's average temperature is above 65°F/18°C. This summary aids in energy management and planning." }, "precipitation": { "$ref": "#/definitions/WeatherUnit", - "description": "The amount of precipitation (liquid equivalent) that has fallen." + "description": "Provides the amount of precipitation accumulated over the specified day, measured in centimeters (cm) or inches (in), based on the specified unit in the request." } } }, @@ -3960,7 +3966,7 @@ }, "NextLink": { "type": "string", - "description": "The is the link to the next page of the features returned. If it's the last page, no this field." + "description": "Contains the URL to fetch the next page of results if the response is paginated. This is useful when the response is too large to be returned in a single call, allowing users to navigate through multiple pages of results." } } }