chore: update docs

jvandenaardweg · Dec 15, 2022 · 15f6084 · 15f6084
1 parent 5b191cd
commit 15f6084
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/types.ts b/src/types.ts
@@ -179,6 +179,12 @@ export interface ErrorResponse {
   };
 }
 
+/**
+ * The /api/v1/system endpoint can be used to configure system settings.
+ * Currently the only available option it to turn on and off all cloud communication.
+ *
+ * @link: https://homewizard-energy-api.readthedocs.io/endpoints.html#system-api-v1-system
+ */
 export interface SystemResponse {
   cloud_enabled: boolean;
 }