Update Actions.md

philipabbey · web-flow · commit 816f2e6399c4 · 2024-12-31T18:02:03.000Z
Documentation for the `service` field after a recently uncovered issue with its value. See #205. Signed-off-by: Philip Abbey <philipabbey@users.noreply.github.com>
diff --git a/examples/Actions.md b/examples/Actions.md
@@ -70,3 +70,8 @@ Note that for notify events, you _must_ not supply an `entity_id` or the API cal
   }
 }
 ```
+
+> [!IMPORTANT]
+> Be careful with the value of the `service` field.
+
+Note that the `service` field will need to be a locally custom `script.<something>` as soon as any `data` fields are populated and not something more generic like `script.turn_on`. If the `service` field is wrong, the application will fail with a [`Communications.INVALID_HTTP_BODY_IN_NETWORK_RESPONSE`](https://developer.garmin.com/connect-iq/api-docs/Toybox/Communications.html) error in the response from your Home Assistant and show the error message as _"No JSON returned from HTTP request"_ on your device. In the [web-based editor](https://house-of-abbey.github.io/GarminHomeAssistant/web/) you can use the standard developer tools to observe an `HTTP 400` error which the application does not see. Here we are limited by the [Garmin Connect IQ](https://developer.garmin.com/connect-iq/overview/) software development kit (SDK). We do not have enough information at the point of execution in the application to determine the cause of the error. Nor is there an immediately obvious way of identifying this issue using the JSON schema checks.

Original file line number	Diff line number	Diff line change
@@ -70,3 +70,8 @@ Note that for notify events, you _must_ not supply an `entity_id` or the API cal
`70`	`70`	`}`
`71`	`71`	`}`
`72`	`72`	```
	`73`	`+`
	`74`	`+> [!IMPORTANT]`
	`75`	+> Be careful with the value of the `service` field.
	`76`	`+`
	`77`	+Note that the `service` field will need to be a locally custom `script.<something>` as soon as any `data` fields are populated and not something more generic like `script.turn_on`. If the `service` field is wrong, the application will fail with a [`Communications.INVALID_HTTP_BODY_IN_NETWORK_RESPONSE`](https://developer.garmin.com/connect-iq/api-docs/Toybox/Communications.html) error in the response from your Home Assistant and show the error message as _"No JSON returned from HTTP request"_ on your device. In the [web-based editor](https://house-of-abbey.github.io/GarminHomeAssistant/web/) you can use the standard developer tools to observe an `HTTP 400` error which the application does not see. Here we are limited by the [Garmin Connect IQ](https://developer.garmin.com/connect-iq/overview/) software development kit (SDK). We do not have enough information at the point of execution in the application to determine the cause of the error. Nor is there an immediately obvious way of identifying this issue using the JSON schema checks.