Add entity delete endpoint (REST API) to docs

[ChrSteinert]

Proposed change

Based on https://github.com/home-assistant/core/blob/f42b137c1b3071bbfafa1d026a153e082ad24054/homeassistant/components/api/__init__.py#L299-L305, entities that can be created and updated with the REST API, can also be deleted by it. The deletion part is missing from the documentation currently and this PR should change that.

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: at least partly fixes Documentation for the REST API /services endpoint is incorrect/incomplete #2419
• Link to relevant existing code or pull request: https://github.com/home-assistant/core/blob/f42b137c1b3071bbfafa1d026a153e082ad24054/homeassistant/components/api/__init__.py#L299-L305

Summary by CodeRabbit

• Documentation
  • Added documentation for a new REST API endpoint to delete entities by their ID, including usage examples.

[coderabbitai]

📝 Walkthrough

Walkthrough

A new section has been added to the REST API documentation describing the DELETE /api/states/<entity_id> endpoint. This documentation explains how to delete an entity by its entity_id and provides an example curl command for making such a request. No other endpoints or documentation sections were modified.

Changes

File(s)	Change Summary
docs/api/rest.md	Added documentation for the DELETE /api/states/<entity_id> endpoint, including usage example.

Assessment against linked issues

Objective	Addressed	Explanation
Improve or correct documentation for the /services REST API endpoint (#2419)	❌	The changes only add documentation for the /api/states/<entity_id> DELETE endpoint, not /services.

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)

• We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

---

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs/api/rest.md (1)

827-841: Add response documentation for DELETE endpoint
The new <ApiEndpoint path="/api/states/<entity_id>" method="delete"> section currently only shows how to invoke the call. For consistency with other endpoints, please document the expected HTTP status codes (e.g., 200 or 204 on success, 404 if the entity isn’t found) and any response body or headers. Including a sample response will make this section more complete.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9c86375 and 0052a82.

📒 Files selected for processing (1)

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

⏰ 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

🔇 Additional comments (1)

docs/api/rest.md (1)

827-841: Verify <ApiEndpoint> DELETE support and rendering
Double‑check that the <ApiEndpoint> component supports "delete" (lowercase) in its method prop and that the new section renders correctly in the generated site.

[frenck]

Thanks, @ChrSteinert 👍

../Frenck