Add required properties to OpenAPI schemas

.gitignore

@@ -85,3 +85,5 @@ fabric.properties
 
 # IntelliJ HTTP Client
 *.private.env.json
+
+onlinedoc.html

src/bridge/schemas/BridgeGet.yaml

@@ -3,16 +3,21 @@ description: Definition of a bridge resource
 allOf:
   - $ref: '../../common/ResourceOwned.yaml'
   - type: object
+    required:
+      - bridge_id
+      - time_zone
     properties:
       type:
         type: string
         enum:
           - bridge
       bridge_id:
         type: string
-        description: Unique identifier of the bridge as printed on the device. Lower case (shouldn't it be upper case?)
+        description: Unique identifier of the bridge as printed on the device. Lower case.
       time_zone:
         type: object
+        required:
+          - time_zone
         properties:
           time_zone:
             type: string

src/bridge_home/schemas/BridgeHomeGet.yaml

@@ -3,6 +3,9 @@ description: Definition of a bridge resource
 allOf:
   - $ref: '../../common/Resource.yaml'
   - type: object
+    required:
+      - children
+      - services
     properties:
       type:
         type: string

src/common/ApiResponse.yaml

@@ -1,4 +1,7 @@
 type: object
+required:
+  - errors
+  - data
 properties:
   errors:
     type: array

src/common/Color.yaml

@@ -1,4 +1,6 @@
 type: object
+required:
+  - xy
 properties:
   xy:
     $ref: ./GamutPosition.yaml

src/common/Dimming.yaml

@@ -1,4 +1,6 @@
 type: object
+required:
+  - brightness
 properties:
   brightness:
     $ref: './Brightness.yaml'

src/common/GamutPosition.yaml

@@ -1,5 +1,8 @@
 type: object
 description: CIE XY gamut position
+required:
+  - x
+  - y
 properties:
   x:
     type: number

src/common/On.yaml

@@ -1,4 +1,6 @@
 type: object
+required:
+  - on
 properties:
   on:
     type: boolean

src/common/Resource.yaml

@@ -1,5 +1,8 @@
 type: object
 description: Common resource properties
+required:
+  - type
+  - id
 properties:
   type:
     type: string

src/common/ResourceIdentifier.yaml

@@ -1,4 +1,7 @@
 type: object
+required:
+  - rid
+  - rtype
 properties:
   rid:
     type: string

src/common/ResourceOwned.yaml

@@ -3,6 +3,8 @@ description: Common resource properties including the owner
 allOf:
   - $ref: './Resource.yaml'
   - type: object
+    required:
+      - owner
     properties:
       owner:
         $ref: './ResourceIdentifier.yaml'

src/common/error.yaml

@@ -67,13 +67,17 @@ components:
   schemas:
     ErrorResponse:
       type: object
+      required:
+        - errors
       properties:
         errors:
           type: array
           items:
             $ref: '#/components/schemas/Error'
     Error:
       type: object
+      required:
+        - description
       properties:
         description:
           type: string

src/device/schemas/DeviceGet.yaml

@@ -3,6 +3,11 @@ description: Definition of a device resource
 allOf:
   - $ref: '../../common/ResourceOwned.yaml'
   - type: object
+    required:
+      - product_data
+      - metadata
+      - identify
+      - services
     properties:
       type:
         type: string
@@ -12,6 +17,9 @@ allOf:
         $ref: './ProductData.yaml'
       metadata:
         type: object
+        required:
+          - name
+          - archetype
         properties:
           name:
             type: string
@@ -20,6 +28,9 @@ allOf:
             description: Human readable name of a resource
           archetype:
             $ref: './ProductArchetype.yaml'
+      identify:
+        type: object
+        description: Triggers a visual identification sequence on the device
       usertest:
         type: object
         properties:

src/device/schemas/ProductData.yaml

@@ -1,4 +1,11 @@
 type: object
+required:
+  - model_id
+  - manufacturer_name
+  - product_name
+  - product_archetype
+  - certified
+  - software_version
 properties:
   model_id:
     type: string

src/device_power/schemas/DevicePowerGet.yaml

@@ -1,8 +1,10 @@
 type: object
-description: Definition of a bridge power resource
+description: Definition of a device power resource
 allOf:
   - $ref: '../../common/ResourceOwned.yaml'
   - type: object
+    required:
+      - power_state
     properties:
       power_state:
         type: object

src/light/schemas/LightGet.yaml

@@ -2,21 +2,46 @@ type: object
 allOf:
   - $ref: '../../common/ResourceOwned.yaml'
   - type: object
+    required:
+      - metadata
+      - identify
+      - service_id
+      - on
+      - mode
     properties:
       metadata:
         type: object
         description: Deprecated, use metadata on device level
+        required:
+          - name
+          - archetype
+          - function
         properties:
           name:
             type: string
             description: Human readable name of a resource
           archetype:
             $ref: './LightArchetype.yaml'
+          function:
+            type: string
+            description: Function of the light service
+            enum:
+              - functional
+              - decorative
+              - mixed
+              - unknown
           fixed_mired:
             type: integer
             minimum: 153
             maximum: 500
             description: A fixed mired value of the white lamp
+      identify:
+        type: object
+        description: Triggers identification sequence on the light
+      service_id:
+        type: integer
+        minimum: 0
+        description: Service identification number. 0 indicates service of a single instance
       on:
         $ref: '../../common/On.yaml'
       dimming:

src/light_level/schemas/LightLevelGet.yaml

@@ -2,12 +2,18 @@ type: object
 allOf:
   - $ref: '../../common/ResourceOwned.yaml'
   - type: object
+    required:
+      - enabled
+      - light
     properties:
       enabled:
         type: boolean
         description: true when sensor is activated, false when deactivated
       light:
         type: object
+        required:
+          - light_level
+          - light_level_valid
         properties:
           light_level:
             type: integer

src/motion/schemas/MotionGet.yaml

@@ -2,12 +2,18 @@ type: object
 allOf:
   - $ref: '../../common/ResourceOwned.yaml'
   - type: object
+    required:
+      - enabled
+      - motion
     properties:
       enabled:
         type: boolean
-        description: ture when the sensor is activated, false when deactivated
+        description: true when the sensor is activated, false when deactivated
       motion:
         type: object
+        required:
+          - motion
+          - motion_valid
         properties:
           motion:
             type: boolean

src/room/schemas/RoomGet.yaml

@@ -2,6 +2,10 @@ type: object
 allOf:
   - $ref: '../../common/Resource.yaml'
   - type: object
+    required:
+      - children
+      - services
+      - metadata
     properties:
       children:
         type: array
@@ -22,6 +26,9 @@ allOf:
       metadata:
         type: object
         description: configuration object for a room
+        required:
+          - name
+          - archetype
         properties:
           name:
             type: string

src/scene/schemas/ActionGet.yaml

@@ -1,29 +1,28 @@
 type: object
-allOf:
-  - $ref: '../../common/ResourceOwned.yaml'
-  - type: object
+required:
+  - target
+  - action
+properties:
+  target:
+    description: The identifier of the light to execute the action on
+    $ref: '../../common/ResourceIdentifier.yaml'
+  action:
+    type: object
+    description: The action to be executed on recall
     properties:
-      target:
+      on:
+        $ref: '../../common/On.yaml'
+      dimming:
+        $ref: '../../common/Dimming.yaml'
+      color:
+        $ref: '../../common/Color.yaml'
+      color_temperature:
+        $ref: '../../common/ColorTemperature.yaml'
+      gradient:
+        $ref: '../../common/Gradient.yaml'
+      effects:
         type: object
-        description: The identifier of the light to execute the action on
-        $ref: '../../common/ResourceIdentifier.yaml'
-      action:
-        type: object
-        description: The action to be executed on recall
+        description: Basic feature containing effect properties.
         properties:
-          on:
-            $ref: '../../common/On.yaml'
-          dimming:
-            $ref: '../../common/Dimming.yaml'
-          color:
-            $ref: '../../common/Color.yaml'
-          color_temperature:
-            $ref: '../../common/ColorTemperature.yaml'
-          gradient:
-            $ref: '../../common/Gradient.yaml'
-          effects:
-            type: object
-            description: Basic feature containing effect properties.
-            properties:
-              effect:
-                $ref: '../../common/SupportedEffects.yaml'
+          effect:
+            $ref: '../../common/SupportedEffects.yaml'

src/scene/schemas/SceneGet.yaml

@@ -2,6 +2,13 @@ type: object
 allOf:
   - $ref: '../../common/ResourceOwned.yaml'
   - type: object
+    required:
+      - actions
+      - metadata
+      - group
+      - speed
+      - auto_dynamic
+      - status
     properties:
       type:
         type: string

src/temperature/schemas/TemperatureGet.yaml

@@ -2,13 +2,19 @@ type: object
 allOf:
   - $ref: '../../common/ResourceOwned.yaml'
   - type: object
+    required:
+      - enabled
+      - temperature
     properties:
       enabled:
         type: boolean
         description: |
           `true` when sensor is activated, `false` when deactivated
       temperature:
         type: object
+        required:
+          - temperature
+          - temperature_valid
         properties:
           temperature:
             type: number