mirror of
https://github.com/home-assistant/developers.home-assistant.git
synced 2025-07-13 12:26:29 +00:00
API: apply sentence-style capitalization to headings (#2186)
* API: apply sentence-style capitalization to headings - to comply with MS Style Guide on [capitalization](https://learn.microsoft.com/en-us/style-guide/capitalization) * Update docs/api/native-app-integration/webview.md
This commit is contained in:
parent
6b538ce7f4
commit
2f2c7db974
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Native App Integration"
|
||||
title: "Native app integration"
|
||||
sidebar_label: "Introduction"
|
||||
---
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Push Notifications"
|
||||
title: "Push notifications"
|
||||
---
|
||||
|
||||
The `mobile_app` integration has a notify platform built in that allows for a generic way to send push notifications to your users without requiring installation of an external custom component. Push notifications can either be delivered via a websocket connection or via a cloud service.
|
||||
|
@ -289,7 +289,7 @@ There are two errors you may receive:
|
||||
- `encryption_already_enabled` - Encryption is already enabled for this registration
|
||||
- `encryption_not_available` - Sodium/NaCL is unable to be installed. Cease all future attempts to enable encryption.
|
||||
|
||||
## Stream Camera
|
||||
## Stream camera
|
||||
|
||||
_This requires Home Assistant 0.112 or later._
|
||||
|
||||
@ -320,7 +320,7 @@ The response will include paths for streaming either via HLS or via MJPEG image
|
||||
|
||||
If HLS streaming is not available, the `hls_path` will be `null`. See notes above on instance URL for how to construct a full URL.
|
||||
|
||||
## Process Conversation
|
||||
## Process conversation
|
||||
|
||||
_This requires Home Assistant 2023.2.0 or later._
|
||||
|
||||
|
@ -21,7 +21,7 @@ Home Assistant has a `mobile_app` component that allows applications to register
|
||||
|
||||
Once you have tokens to authenticate as a user, it's time to register the app with the mobile app integration in Home Assistant.
|
||||
|
||||
### Getting Ready
|
||||
### Getting ready
|
||||
|
||||
First, you must ensure that the `mobile_app` integration is loaded. There are two ways to do this:
|
||||
|
||||
|
@ -10,7 +10,7 @@ The token is available for add-ons and Home Assistant using the
|
||||
|
||||
To see more details about each endpoint, click on it to expand it.
|
||||
|
||||
### Addons
|
||||
### Add-ons
|
||||
|
||||
<ApiEndpoint path="/addons" method="get">
|
||||
Return overview information about installed add-ons.
|
||||
|
@ -82,7 +82,7 @@ These models are describing objects that are getting returned from the superviso
|
||||
| uuid | string | The UUID of the discovery |
|
||||
| config | dict | The configuration |
|
||||
|
||||
## Host Service
|
||||
## Host service
|
||||
|
||||
| key | type | description |
|
||||
| ----------- | ------ | ----------------------- |
|
||||
@ -129,7 +129,7 @@ These models are describing objects that are getting returned from the superviso
|
||||
| id | integer | The VLAN ID. |
|
||||
| parent | string | Parent interface which is the vlan attached. |
|
||||
|
||||
## Access-Points
|
||||
## Access-points
|
||||
|
||||
| key | type | description |
|
||||
| ---------- | ------- | ---------------------------------------------------------------------------- |
|
||||
@ -301,14 +301,14 @@ Response only fields will be in responses but cannot be included in requests.
|
||||
| child_jobs | list | A list of child [jobs](#job) started by this one |
|
||||
| errors | list | A list of [errors](#job-error) that occurred during execution |
|
||||
|
||||
## Job Error
|
||||
## Job error
|
||||
|
||||
| key | type | description |
|
||||
| ---------- | ------- | ---------------------------------------------- |
|
||||
| type | string | Type of error that occurred |
|
||||
| message | string | Human-readable description of what went wrong |
|
||||
|
||||
## Boot Slot
|
||||
## Boot slot
|
||||
|
||||
| key | type | description |
|
||||
| ---------- | ------- | ----------------------------------------------- |
|
||||
|
@ -466,7 +466,7 @@ The server will respond with a result message containing the current registered
|
||||
}
|
||||
```
|
||||
|
||||
## Pings and Pongs
|
||||
## Pings and pongs
|
||||
|
||||
The API supports receiving a ping from the client and returning a pong. This serves as a heartbeat to ensure the connection is still alive:
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: Core Architecture
|
||||
title: Core architecture
|
||||
sidebar_label: Core
|
||||
---
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user