Refactoring of Reports context

lib/mobilizon/reports/note.ex

@@ -1,27 +1,39 @@
 defmodule Mobilizon.Reports.Note do
   @moduledoc """
-  Report Note entity
+  Represents a note entity.
   """
+
   use Ecto.Schema
-  import Ecto.Changeset
+
+  import Ecto.Changeset, only: [cast: 3, validate_required: 2]
+
   alias Mobilizon.Actors.Actor
   alias Mobilizon.Reports.Report
 
-  @attrs [:content, :moderator_id, :report_id]
+  @required_attrs [:content, :moderator_id, :report_id]
+  @attrs @required_attrs
+
+  @type t :: %__MODULE__{
+          content: String.t(),
+          report: Report.t(),
+          moderator: Actor.t()
+        }
 
   @derive {Jason.Encoder, only: [:content]}
   schema "report_notes" do
     field(:content, :string)
-    belongs_to(:moderator, Actor)
+
     belongs_to(:report, Report)
+    belongs_to(:moderator, Actor)
 
     timestamps()
   end
 
   @doc false
+  @spec changeset(t | Ecto.Changeset.t(), map) :: Ecto.Changeset.t()
   def changeset(note, attrs) do
     note
     |> cast(attrs, @attrs)
-    |> validate_required(@attrs)
+    |> validate_required(@required_attrs)
   end
 end