Add Air Pollution in OpenWeatherMap and clarify availables modes #39435
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThe OpenWeatherMap integration documentation was revised to include support for air quality data, clarify API key requirements, distinguish between available API services, remove references to deprecated API v2.5, and add configuration details for air quality features. Section headings and supported air quality conditions were also updated. Changes
Sequence Diagram(s)sequenceDiagram
User->>OpenWeatherMap Integration: Configure integration (select weather and/or air quality)
OpenWeatherMap Integration->>OpenWeatherMap API: Request data (weather and/or air pollution)
OpenWeatherMap API-->>OpenWeatherMap Integration: Return requested data
OpenWeatherMap Integration-->>User: Display weather and air quality information
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
source/_integrations/openweathermap.markdown (1)
106-111:⚠️ Potential issueRemove obsolete v2.5 reference in action note
The action still mentions failure forv2.5, but that mode is deprecated and removed from the config table. Update to reference only the supported modes:- **Note:** Minute forecast is available only when the OWM integration mode is set to `v3.0`. The action will fail if the mode is set to `current`, `forecast`, or `v2.5`. + **Note:** Minute forecast is available only when the OWM integration mode is set to `v3.0`. The action will fail if the mode is set to `current` or `forecast`.
🧹 Nitpick comments (4)
source/_integrations/openweathermap.markdown (4)
31-31: Clarify API key phrasing
The sentence is a bit awkward. Consider rephrasing for clarity:- You need an API key, it requires a [registration](https://home.openweathermap.org/users/sign_up). + You need to register for an API key: [Sign up here](https://home.openweathermap.org/users/sign_up).
43-43: Polish deprecation notice wording
Recommend slight wording tweak for flow:- OpenWeatherMap API V2.5 has been deprecated and is not supported anymore by this integration. + OpenWeatherMap API V2.5 has been deprecated and is no longer supported by this integration.
68-68: Enhance v3.0 mode description
Thev3.0mode should mention current weather alongside forecasts—align with One Call API 3.0 capabilities:- `<li>\`v3.0\` (new API version) daily weather forecast for 8 days, and 1-hour steps for 48 hours</li>` + `<li>\`v3.0\` (new API version): current weather plus hourly forecast for 48 hours and daily forecast for 8 days</li>`
264-273: Fix grammar in PM2.5 description
Minor wording correction for accuracy:-| `pm2_5` | Concentration of PM2.5 (Fine particles matter), µg/m³. | +| `pm2_5` | Concentration of PM2.5 (fine particulate matter), µg/m³. |🧰 Tools
🪛 LanguageTool
[uncategorized] ~272-~272: Possible missing preposition found.
Context: ... Concentration of PM2.5 (Fine particles matter), µg/m³. ...(AI_HYDRA_LEO_MISSING_OF)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/openweathermap.markdown(5 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/openweathermap.markdown
[uncategorized] ~272-~272: Possible missing preposition found.
Context: ... Concentration of PM2.5 (Fine particles matter), µg/m³. ...
(AI_HYDRA_LEO_MISSING_OF)
🔇 Additional comments (4)
source/_integrations/openweathermap.markdown (4)
24-24: Update intro to include air quality data
Good addition—this now clearly states that both meteorological and air quality data are provided.
32-36: Approve supported service types list
The distinction between One Call API 3.0 and the Free tier (including air pollution) is clear and accurate.
45-45: Approve migration instructions heading
The guidance to migrate from API V2.5 is clear and actionable.
260-262: Approve new air quality section header
Introducing “Supported Air Quality conditions” as a standalone section aligns well with the rest of the documentation structure.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (6)
source/_integrations/openweathermap.markdown (6)
24-24: Reduce redundant branding in description
The phrase “The OpenWeatherMap weather integration uses [OpenWeatherMap]…” mentions the service name twice. Consider simplifying to “This integration uses [OpenWeatherMap] as a source for current meteorological and air quality data.”
31-31: Clarify API key registration details
Recommend noting that obtaining an API key is free by default and that the key activates within 10–120 minutes. This helps set expectations for new users.
33-37: Streamline service type descriptions
The two bullet points could be folded into a single table or use sub-lists for better readability. For example:
• One Call API 3.0 (subscription; current, 48-hour hourly, 8-day daily)
• Free tier (current, 3-hour 5-day forecast, air pollution)
44-46: Unify version identifier formatting
Wrap version IDs in backticks and match casing to the Mode table. E.g.:
OpenWeatherMap API v2.5has been deprecated and is no longer supported.- Use
v3.0instead of “API V3.0” for consistency.
69-69: Improve Mode table readability
The long<li>list in a single cell is hard to scan. Consider breaking into separate lines or sub-bullets in markdown for each mode.
265-274: Correct terminology for particulate matter
Line 273 reads “Fine particles matter” but should be “Fine particulate matter” to align with standard nomenclature.🧰 Tools
🪛 LanguageTool
[uncategorized] ~273-~273: Possible missing preposition found.
Context: ... Concentration of PM2.5 (Fine particles matter), µg/m³. ...(AI_HYDRA_LEO_MISSING_OF)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/openweathermap.markdown(5 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/openweathermap.markdown
[uncategorized] ~273-~273: Possible missing preposition found.
Context: ... Concentration of PM2.5 (Fine particles matter), µg/m³. ...
(AI_HYDRA_LEO_MISSING_OF)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (5)
source/_integrations/openweathermap.markdown (5)
107-107: Verify heading level consistency for Actions section
This was demoted to###. Ensure other integrations follow the same level for action definitions (usually##).
130-130: Verify heading level consistency for Examples section
The “Examples” heading is now###. Confirm that examples across docs maintain the correct hierarchy relative to “Action”.
260-260: Approve nested examples within collapsible block
Collapsing the example under a details block improves readability while keeping the page concise.
261-261: Approve addition of Supported Air Quality section
The new section clearly introduces the air quality feature.
263-263: Approve Current Air Quality subsection heading
Level-3 heading correctly scopes the new content under Air Quality.
Proposed change
Update OpenWeatherMap documentation to add Air Pollution and clarify the different available modes.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit