feat: expose CRUD, onboarding, pubsub via web

2026-04-22 16:32:41 +02:00
parent 9807331da4
commit 9389c32244
33 changed files with 1536 additions and 7 deletions
@@ -0,0 +1,293 @@
+defmodule Localiser.Web.Schemas do
+  alias OpenApiSpex.Schema
+
+  defmodule User do
+    require OpenApiSpex
+    OpenApiSpex.schema(%{
+      title: "User", type: :object,
+      properties: %{
+        id:       %Schema{type: :integer},
+        username: %Schema{type: :string},
+        is_admin: %Schema{type: :boolean}
+      },
+      required: [:id, :username, :is_admin]
+    })
+  end
+
+  defmodule Floor do
+    require OpenApiSpex
+    OpenApiSpex.schema(%{
+      title: "Floor", type: :object,
+      properties: %{
+        id:     %Schema{type: :integer},
+        name:   %Schema{type: :string},
+        width:  %Schema{type: :number, format: :float},
+        height: %Schema{type: :number, format: :float}
+      },
+      required: [:id, :name, :width, :height]
+    })
+  end
+
+  defmodule Room do
+    require OpenApiSpex
+    OpenApiSpex.schema(%{
+      title: "Room", type: :object,
+      properties: %{
+        id:       %Schema{type: :integer},
+        name:     %Schema{type: :string},
+        floor_id: %Schema{type: :integer},
+        x:        %Schema{type: :number, format: :float},
+        y:        %Schema{type: :number, format: :float},
+        width:    %Schema{type: :number, format: :float},
+        height:   %Schema{type: :number, format: :float}
+      },
+      required: [:id, :name, :floor_id, :x, :y, :width, :height]
+    })
+  end
+
+  defmodule Sensor do
+    require OpenApiSpex
+    OpenApiSpex.schema(%{
+      title: "Sensor", type: :object,
+      properties: %{
+        id:        %Schema{type: :integer},
+        sensor_id: %Schema{type: :string},
+        room_id:   %Schema{type: :integer, nullable: true},
+        floor_x:   %Schema{type: :number, format: :float, nullable: true},
+        floor_y:   %Schema{type: :number, format: :float, nullable: true},
+        rssi_ref:  %Schema{type: :number, format: :float, nullable: true}
+      },
+      required: [:id, :sensor_id]
+    })
+  end
+
+  defmodule Tag do
+    require OpenApiSpex
+    OpenApiSpex.schema(%{
+      title: "Tag", type: :object,
+      properties: %{
+        id:     %Schema{type: :integer},
+        tag_id: %Schema{type: :string},
+        name:   %Schema{type: :string}
+      },
+      required: [:id, :tag_id, :name]
+    })
+  end
+
+  defmodule OnboardingStatus do
+    require OpenApiSpex
+    OpenApiSpex.schema(%{
+      title: "OnboardingStatus", type: :object,
+      properties: %{
+        has_admin:          %Schema{type: :boolean},
+        has_floors:         %Schema{type: :boolean},
+        has_rooms:          %Schema{type: :boolean},
+        has_sensors_placed: %Schema{type: :boolean},
+        has_tags:           %Schema{type: :boolean}
+      },
+      required: [:has_admin, :has_floors, :has_rooms, :has_sensors_placed, :has_tags]
+    })
+  end
+
+  defmodule TokenResponse do
+    require OpenApiSpex
+    OpenApiSpex.schema(%{
+      title: "TokenResponse", type: :object,
+      properties: %{
+        token: %Schema{type: :string},
+        user:  User
+      },
+      required: [:token, :user]
+    })
+  end
+
+  defmodule Error do
+    require OpenApiSpex
+    OpenApiSpex.schema(%{
+      title: "Error", type: :object,
+      properties: %{error: %Schema{type: :string}},
+      required: [:error]
+    })
+  end
+
+  defmodule ValidationErrors do
+    require OpenApiSpex
+    OpenApiSpex.schema(%{
+      title: "ValidationErrors", type: :object,
+      properties: %{
+        errors: %Schema{
+          type: :object,
+          additionalProperties: %Schema{type: :array, items: %Schema{type: :string}}
+        }
+      }
+    })
+  end
+
+  defmodule CalibrationStatus do
+    require OpenApiSpex
+    OpenApiSpex.schema(%{
+      title: "CalibrationStatus", type: :object,
+      properties: %{status: %Schema{type: :string, enum: ["calibrating", "idle"]}},
+      required: [:status]
+    })
+  end
+
+  # ── Request body schemas ────────────────────────────────────────────────────
+
+  defmodule SetupParams do
+    require OpenApiSpex
+    OpenApiSpex.schema(%{
+      title: "SetupParams", type: :object,
+      properties: %{
+        username: %Schema{type: :string},
+        password: %Schema{type: :string, format: :password}
+      },
+      required: [:username, :password]
+    })
+  end
+
+  defmodule SessionParams do
+    require OpenApiSpex
+    OpenApiSpex.schema(%{
+      title: "SessionParams", type: :object,
+      properties: %{
+        username: %Schema{type: :string},
+        password: %Schema{type: :string, format: :password}
+      },
+      required: [:username, :password]
+    })
+  end
+
+  defmodule UserCreateParams do
+    require OpenApiSpex
+    OpenApiSpex.schema(%{
+      title: "UserCreateParams", type: :object,
+      properties: %{
+        username: %Schema{type: :string},
+        password: %Schema{type: :string, format: :password},
+        is_admin: %Schema{type: :boolean, default: false}
+      },
+      required: [:username, :password]
+    })
+  end
+
+  defmodule UserUpdateParams do
+    require OpenApiSpex
+    OpenApiSpex.schema(%{
+      title: "UserUpdateParams", type: :object,
+      properties: %{
+        username: %Schema{type: :string},
+        password: %Schema{type: :string, format: :password}
+      }
+    })
+  end
+
+  defmodule FloorParams do
+    require OpenApiSpex
+    OpenApiSpex.schema(%{
+      title: "FloorParams", type: :object,
+      properties: %{
+        name:   %Schema{type: :string},
+        width:  %Schema{type: :number, format: :float},
+        height: %Schema{type: :number, format: :float}
+      },
+      required: [:name, :width, :height]
+    })
+  end
+
+  defmodule FloorUpdateParams do
+    require OpenApiSpex
+    OpenApiSpex.schema(%{
+      title: "FloorUpdateParams", type: :object,
+      properties: %{
+        name:   %Schema{type: :string},
+        width:  %Schema{type: :number, format: :float},
+        height: %Schema{type: :number, format: :float}
+      }
+    })
+  end
+
+  defmodule RoomParams do
+    require OpenApiSpex
+    OpenApiSpex.schema(%{
+      title: "RoomParams", type: :object,
+      properties: %{
+        name:   %Schema{type: :string},
+        x:      %Schema{type: :number, format: :float},
+        y:      %Schema{type: :number, format: :float},
+        width:  %Schema{type: :number, format: :float},
+        height: %Schema{type: :number, format: :float}
+      },
+      required: [:name, :x, :y, :width, :height]
+    })
+  end
+
+  defmodule RoomUpdateParams do
+    require OpenApiSpex
+    OpenApiSpex.schema(%{
+      title: "RoomUpdateParams", type: :object,
+      properties: %{
+        name:   %Schema{type: :string},
+        x:      %Schema{type: :number, format: :float},
+        y:      %Schema{type: :number, format: :float},
+        width:  %Schema{type: :number, format: :float},
+        height: %Schema{type: :number, format: :float}
+      }
+    })
+  end
+
+  defmodule SensorUpdateParams do
+    require OpenApiSpex
+    OpenApiSpex.schema(%{
+      title: "SensorUpdateParams", type: :object,
+      properties: %{rssi_ref: %Schema{type: :number, format: :float}}
+    })
+  end
+
+  defmodule SensorPlaceParams do
+    require OpenApiSpex
+    OpenApiSpex.schema(%{
+      title: "SensorPlaceParams", type: :object,
+      properties: %{
+        room_id: %Schema{type: :integer},
+        x:       %Schema{type: :number, format: :float},
+        y:       %Schema{type: :number, format: :float}
+      },
+      required: [:room_id, :x, :y]
+    })
+  end
+
+  defmodule CalibrationStartParams do
+    require OpenApiSpex
+    OpenApiSpex.schema(%{
+      title: "CalibrationStartParams", type: :object,
+      properties: %{
+        reference_distance: %Schema{
+          type: :number, format: :float,
+          description: "Known tag-to-sensor distance in metres"
+        }
+      },
+      required: [:reference_distance]
+    })
+  end
+
+  defmodule TagParams do
+    require OpenApiSpex
+    OpenApiSpex.schema(%{
+      title: "TagParams", type: :object,
+      properties: %{
+        tag_id: %Schema{type: :string, description: "BLE MAC address or device ID"},
+        name:   %Schema{type: :string}
+      },
+      required: [:tag_id, :name]
+    })
+  end
+
+  defmodule TagUpdateParams do
+    require OpenApiSpex
+    OpenApiSpex.schema(%{
+      title: "TagUpdateParams", type: :object,
+      properties: %{name: %Schema{type: :string}}
+    })
+  end
+end