Add documentation for opt-in IPv6 for containers #2677
Conversation
|
Warning Rate limit exceeded@davidrapan has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 17 minutes and 18 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
📝 Walkthrough""" WalkthroughThe documentation for Docker API endpoints was updated to add a new boolean field, Changes
Sequence Diagram(s)sequenceDiagram
participant Client
participant API
Client->>API: GET /docker/info
API-->>Client: { ..., "enable_ipv6": true/false, ... }
Client->>API: POST /docker/options { "enable_ipv6": true/false }
API-->>Client: 200 OK (Docker options updated)
""" 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)
docs/api/supervisor/endpoints.md (1)
1527-1536: 🛠️ Refactor suggestionSync the example JSON with the added field
The “Example response” block for/docker/infodoesn’t include the newly documentedenable_ipv6field. Update it to demonstrate the field, for example:{ "version": "1.0.1", "enable_ipv6": false, "storage": "overlay2", "logging": "journald", "registries": {} }This will prevent confusion and ensure the docs accurately reflect the API schema.
🧹 Nitpick comments (2)
docs/api/supervisor/endpoints.md (2)
1522-1522: Unify the new field’s description for clarity
The table entry forenable_ipv6reads “Enabled/Disabled IPv6 for containers,” which deviates from the active-voice style used elsewhere (e.g. “True if …”). Consider rephrasing to something like:| enable_ipv6 | bool | True if IPv6 is enabled for containers |
This keeps descriptions consistent and immediately intelligible.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
1522-1522: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe(MD055, table-pipe-style)
1522-1522: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe(MD055, table-pipe-style)
1540-1552: Enrich the/docker/optionsendpoint documentation
To give users full context, you might:
- Note that
enable_ipv6is disabled by default and toggles IPv6 support on the daemon.- Indicate any required post-change actions (e.g. restarting containers or the Supervisor).
- Explicitly call out authorization requirements (endpoints default to locked unless marked
unprotected).A brief intro paragraph or a tip box would make this new endpoint more self-explanatory.
📜 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)
docs/api/supervisor/endpoints.md(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/api/supervisor/endpoints.md
1522-1522: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
(MD055, table-pipe-style)
1522-1522: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/api/supervisor/endpoints.md (2)
1522-1522: Includeenable_ipv6in the example response.
The new field is documented in the table but missing from the JSON example for theGET /docker/infoendpoint. Please update the example to include it, for example:{ "version": "1.0.1", + "enable_ipv6": false, "storage": "overlay2", "logging": "journald", "registries": {} }🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
1522-1522: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe(MD055, table-pipe-style)
1522-1522: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe(MD055, table-pipe-style)
1540-1552: Add an example payload for/docker/options.
To help users understand how to invoke this new endpoint, consider adding a concrete example payload:Example payload:
{ "enable_ipv6": true }
📜 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)
docs/api/supervisor/endpoints.md(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/api/supervisor/endpoints.md
1522-1522: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
(MD055, table-pipe-style)
1522-1522: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
🔇 Additional comments (1)
docs/api/supervisor/endpoints.md (1)
1522-1522: Ignore markdownlint table pipe style for this row.
The table uses the existingno_leading_or_trailingpipe style consistently across all rows, so the MD055 warning can be safely ignored.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
1522-1522: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe(MD055, table-pipe-style)
1522-1522: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe(MD055, table-pipe-style)
There was a problem hiding this comment.
Actionable comments posted: 2
📜 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)
docs/api/supervisor/endpoints.md(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/api/supervisor/endpoints.md
1522-1522: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
(MD055, table-pipe-style)
1522-1522: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - developers-home-assistant
- GitHub Check: Header rules - developers-home-assistant
- GitHub Check: Pages changed - developers-home-assistant
Signed-off-by: David Rapan <david@rapan.cz>
Proposed change
Add documentation for newly added opt-in IPv6 for containers
Type of change
Checklist
Additional information
Summary by CodeRabbit
New Features
Documentation