Przeglądaj źródła

Add hex_color field to API documentation

Christopher Mullins 6 lat temu
rodzic
commit
8b812e77b8
1 zmienionych plików z 3 dodań i 0 usunięć
  1. 3 0
      docs/openapi.yaml

+ 3 - 0
docs/openapi.yaml

@@ -771,6 +771,7 @@ components:
       - group_id
       - device_type
       - oh_color
+      - hex_color
       description: >
         Defines a field which is a part of state for a particular light device.  Most fields are self-explanatory, but documentation for each follows:
 
@@ -786,6 +787,8 @@ components:
 
         * `oh_color` - same as `color` with a format compatible with [OpenHAB's colorRGB channel type](https://www.openhab.org/addons/bindings/mqtt.generic/#channel-type-colorrgb-colorhsb).
 
+        * `hex_color` - same as `color` except in hex color (e.g., `#FF0000` for red).
+
         * `device_id` / `device_type` / `group_id` - this information is in the MQTT topic or REST route, but can be included in the payload in the case that processing the topic or route is more difficult.
     DeviceId:
       type: array