Skip to content

Commit 7586adf

Browse files
jackmakesthingsfabaff
authored andcommitted
Update rest_api.markdown (home-assistant#1257)
home-assistant#1052 - grammar fixes for docs
1 parent a39b33d commit 7586adf

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

source/developers/rest_api.markdown

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Successful calls will return status code 200 or 201. Other status codes that can
5454
The API supports the following actions:
5555

5656
#### {% linkable_title GET /api/ %}
57-
Returns message if API is up and running.
57+
Returns a message if the API is up and running.
5858

5959
```json
6060
{
@@ -142,7 +142,7 @@ $ curl -X GET -H "x-ha-access: YOUR_PASSWORD" \
142142
```
143143

144144
#### {% linkable_title GET /api/events %}
145-
Returns an array of event objects. Each event object contain event name and listener count.
145+
Returns an array of event objects. Each event object contains event name and listener count.
146146

147147
```json
148148
[
@@ -193,7 +193,7 @@ $ curl -X GET -H "x-ha-access: YOUR_PASSWORD" \
193193
```
194194

195195
#### {% linkable_title GET /api/history %}
196-
Returns an array of state changes in the past. Each object contains further detail for the entities.
196+
Returns an array of state changes in the past. Each object contains further details for the entities.
197197

198198
```json
199199
[
@@ -377,7 +377,7 @@ Returns a message if successful.
377377
```
378378

379379
#### {% linkable_title POST /api/services/<domain>/<service> %}
380-
Calls a service within a specific domain. Will return when the service has been executed or 10 seconds has past, whichever comes first.
380+
Calls a service within a specific domain. Will return when the service has been executed or after 10 seconds, whichever comes first.
381381

382382
You can pass an optional JSON object to be used as `service_data`.
383383

@@ -416,7 +416,7 @@ $ curl -X POST -H "x-ha-access: YOUR_PASSWORD" \
416416
```
417417

418418
<p class='note'>
419-
The result will include any changed states that changed while the service was being executed, even if their change was the result of something else happening in the system.
419+
The result will include any states that changed while the service was being executed, even if their change was the result of something else happening in the system.
420420
</p>
421421

422422
#### {% linkable_title POST /api/template %}
@@ -443,7 +443,7 @@ $ curl -X POST -H "x-ha-access: YOUR_PASSWORD" \
443443
```
444444

445445
#### {% linkable_title POST /api/event_forwarding %}
446-
Setup event forwarding to another Home Assistant instance.
446+
Set up event forwarding to another Home Assistant instance.
447447

448448
Requires a JSON object that represents the API to forward to.
449449

@@ -455,7 +455,7 @@ Requires a JSON object that represents the API to forward to.
455455
}
456456
```
457457

458-
It will return a message if event forwarding was setup successful.
458+
It will return a message if event forwarding was set up successfully.
459459

460460
```json
461461
{
@@ -476,7 +476,7 @@ Requires a JSON object that represents the API to cancel forwarding to.
476476
}
477477
```
478478

479-
It will return a message if event forwarding was cancelled successful.
479+
It will return a message if event forwarding was cancelled successfully.
480480

481481
```json
482482
{

0 commit comments

Comments
 (0)