Added documentation
This commit is contained in:
@@ -1,6 +1,13 @@
|
||||
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 [
|
||||
required: false,
|
||||
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 [
|
||||
required: true,
|
||||
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 %{
|
||||
oauth: [
|
||||
required: false,
|
||||
@@ -68,6 +83,10 @@ defmodule Sukaato.Vschemas do
|
||||
totp_secret: [required: false, type: :string]
|
||||
}
|
||||
|
||||
@doc """
|
||||
Schema for validating updates to column `:resume` on table
|
||||
corresponding to `Sukaato.Folio`.
|
||||
"""
|
||||
@resume_vschema %{
|
||||
"basics" => [
|
||||
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 %{
|
||||
audio: [
|
||||
required: false,
|
||||
|
Reference in New Issue
Block a user