Fix / LightAPI (#6)

Author: thibauult

Makefile

@@ -0,0 +1,17 @@
+#
+# Usage:
+#		- make setup 	(Install or Update the Redocly CLI)
+#		- make verify (Validate that the specification is valid)
+#
+
+setup:
+	@command -v npm >/dev/null 2>&1 || { echo >&2 "NPM is required in order to install the Redocly CLI"; exit 1; }
+	@echo "Installing the Redocly CLI..."
+	@npm i -g @redocly/cli@latest
+
+verify: verify.redocly
+	@redocly lint
+
+verify.redocly:
+	@command -v redocly >/dev/null 2>&1 || { echo >&2 "The Redocly CLI is not installed"; exit 1; }
+

src/light/light_{lightId}.yaml

@@ -10,7 +10,7 @@ get:
     - name: lightId
       in: path
       schema:
-        type: integer
+        type: string
       required: true
       description: ID of the light.
   responses:
@@ -61,7 +61,7 @@ put:
     - name: lightId
       in: path
       schema:
-        type: integer
+        type: string
       required: true
       description: ID of the light.
   requestBody:

src/light/schemas/LightArchetype.yaml

@@ -0,0 +1,52 @@
+type: string
+description: Light archetype
+enum:
+  - unknown_archetype
+  - classic_bulb
+  - sultan_bulb
+  - flood_bulb
+  - spot_bulb
+  - candle_bulb
+  - luster_bulb
+  - pendant_round
+  - pendant_long
+  - ceiling_round
+  - ceiling_square
+  - floor_shade
+  - floor_lantern
+  - table_shade
+  - recessed_ceiling
+  - recessed_floor
+  - single_spot
+  - double_spot
+  - table_wash
+  - wall_lantern
+  - wall_shade
+  - flexible_lamp
+  - ground_spot
+  - wall_spot
+  - plug
+  - hue_go
+  - hue_lightstrip
+  - hue_iris
+  - hue_bloom
+  - bollard
+  - wall_washer
+  - hue_play
+  - vintage_bulb
+  - vintage_candle_bulb
+  - ellipse_bulb
+  - triangle_bulb
+  - small_globe_bulb
+  - large_globe_bulb
+  - edison_bulb
+  - christmas_tree
+  - string_light
+  - hue_centris
+  - hue_lightstrip_tv
+  - hue_lightstrip_pc
+  - hue_tube
+  - hue_signe
+  - pendant_spot
+  - ceiling_horizontal
+  - ceiling_tube

src/light/schemas/LightGet.yaml

@@ -13,6 +13,20 @@ properties:
     pattern: ^(\/[a-z]{4,32}\/[0-9a-zA-Z-]{1,32})?$
   owner:
     $ref: './ResourceIdentifier.yaml'
+  metadata:
+    type: object
+    description: Deprecated, use metadata on device level
+    properties:
+      name:
+        type: string
+        description: Human readable name of a resource
+      archetype:
+        $ref: './LightArchetype.yaml'
+      fixed_mired:
+        type: integer
+        minimum: 0
+        maximum: 100
+        description: A fixed mired value of the white lamp
   on:
     type: object
     properties: