Added documentation

This commit is contained in:
Alex Tavarez
2025-07-25 12:23:21 -04:00
parent 07b1477a97
commit 75b43eb20a

View File

@@ -1,6 +1,13 @@
defmodule Sukaato.Vschemas do defmodule Sukaato.Vschemas do
# import Validate @moduledoc """
Provide validation schemas for tail parameters
of `Validate.validate`.
"""
@doc """
Schema for validating updates to column `:affil` on table
corresponding to `Sukaato.User`.
"""
@affil_vschema [ @affil_vschema [
required: false, required: false,
type: :list, type: :list,
@@ -22,6 +29,10 @@ defmodule Sukaato.Vschemas do
] ]
] ]
@doc """
Schema for validating updates to column `:perms` on table
corresponding to `Sukaato.User`.
"""
@perms_vschema [ @perms_vschema [
required: true, required: true,
type: :list, type: :list,
@@ -33,6 +44,10 @@ defmodule Sukaato.Vschemas do
] ]
] ]
@doc """
Schema for validating updates to column `:pub_keys` on table
corresponding to `Sukaato.User`.
"""
@pubkeys_vschema %{ @pubkeys_vschema %{
oauth: [ oauth: [
required: false, required: false,
@@ -68,6 +83,10 @@ defmodule Sukaato.Vschemas do
totp_secret: [required: false, type: :string] totp_secret: [required: false, type: :string]
} }
@doc """
Schema for validating updates to column `:resume` on table
corresponding to `Sukaato.Folio`.
"""
@resume_vschema %{ @resume_vschema %{
"basics" => [ "basics" => [
required: true, required: true,
@@ -310,7 +329,10 @@ defmodule Sukaato.Vschemas do
] ]
} }
#@TODO finish 'showcase' 'folio' database field validation schema @doc """
Schema for validating updates to column `:showcase` on table
corresponding to `Sukaato.Folio`.
"""
@showcase_vschema %{ @showcase_vschema %{
audio: [ audio: [
required: false, required: false,