Clarify API endpoint path requirement

[axelson]

Proposed change

Added note about trailing slash in API endpoint. This tripped me up because I didn't expect it (many/most other API's I've used don't include a trailing / in paths). I hope that by including this note it will help someone else who is getting started with the API for the first time (since this is likely the API endpoint that they will try first)

Type of change

• Document existing features within Home Assistant
• Document new or changing features for which there is an existing pull request elsewhere
• Spelling or grammatical corrections, or rewording for improved clarity
• Changes to the backend of this documentation
• Remove stale or deprecated documentation

Checklist

• I have read and followed the documentation guidelines.
• I have verified that my changes render correctly in the documentation.

Additional information

• This PR fixes or closes issue: fixes #
• Link to relevant existing code or pull request:

Summary by CodeRabbit

• Documentation
  • Clarified API path requirements in documentation, noting that the API endpoint path must include a trailing slash.

[coderabbitai]

📝 Walkthrough

Walkthrough

Added a clarifying note to the REST API documentation specifying that the API path must include a trailing slash (full path: /api/, not /api) in the sample curl command under the /api/ ApiEndpoint section.

Changes

Cohort / File(s)	Summary
Documentation Clarification docs/api/rest.md	Added a note clarifying the trailing slash requirement in the API path for the /api/ endpoint sample curl command

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• The change is a straightforward documentation clarification with no code logic modifications
• Single file affected with additive changes only

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The pull request title "Clarify API endpoint path requirement" directly and accurately summarizes the main change in the changeset. The title is concise, specific, and clearly indicates that the PR adds documentation to clarify the API endpoint path requirement (specifically, the trailing slash). A teammate scanning the history would immediately understand that this PR involves API documentation clarification, making it appropriate for the changeset.
Description Check	✅ Passed	The pull request description follows the required template structure with all major sections present and completed: a proposed change section that explains the modification and its motivation, a type of change section with the appropriate box checked (documenting existing features), a checklist confirming the author followed guidelines and verified rendering, and an additional information section with placeholder fields. While the issue number and code links in additional information are not filled with specific values, the description is substantially complete and provides the necessary context for the review.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs/api/rest.md (1)

82-83: Consider using the structured callout syntax for consistency.

The documentation uses :::note, :::info, and :::tip blocks elsewhere (e.g., lines 585, 694, 739). Refactoring this note to use :::note would maintain visual consistency:

-Note: make sure you include the trailing `/`, the full path is `/api/`, NOT `/api`
+:::note
+Make sure you include the trailing `/`. The full path is `/api/`, NOT `/api`.
+:::

This is optional but would align with the established documentation style.

📜 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

📥 Commits

Reviewing files that changed from the base of the PR and between fdacf2c and 6c82136.

📒 Files selected for processing (1)

• docs/api/rest.md (1 hunks)

🔇 Additional comments (1)

docs/api/rest.md (1)

82-83: Helpful clarification!

The note effectively addresses the trailing slash requirement for the /api/ endpoint. The placement after the sample curl command (which correctly demonstrates the full path) makes it visible to users referencing this documentation.