metabase.util.schema — metabase/schema-util 1.0.1

Various schemas that are useful throughout the app.

api-error-message clj

(api-error-message schema)

Extract the API error messages attached to a schema, if any. This functionality is fairly sophisticated:

(api-error-message (s/maybe (non-empty [NonBlankString]))) ;; -> "value may be nil, or if non-nil, value must be an array. Each value must be a non-blank string. The array cannot be empty."

api-param clj

(api-param api-param-name schema)

Return schema with an additional api-param-name key that will be used in the auto-generate documentation and in error messages. This is important for situations where you want to bind a parameter coming in to the API to something other than the snake_case key it normally comes in as:

;; BAD -- Documentation/errors will tell you dimension-type is wrong [:is {{dimension-type :type} :body}] {dimension-type DimensionType}

;; GOOD - Documentation/errors will mention correct param name, type [:is {{dimension-type :type} :body}] {dimension-type (su/api-param "type" DimensionType)}

BooleanString clj

Schema for a string that is a valid representation of a boolean (either true or false). Something that adheres to this schema is guaranteed to to work with Boolean/parseBoolean.

distinct clj

(distinct schema)

Add an additional constraint to schema (presumably an array) that requires all elements to be distinct.

Email clj

Schema for a valid email string.

EmbeddingParams clj

Schema for a valid map of embedding params.

empty-or-distinct? clj

(empty-or-distinct? coll)

True if coll is either empty or distinct.

EntityTypeKeywordOrString clj

Validates entity type derivatives of :entity/*. Allows strings or keywords

FieldType clj

Schema for a valid Field type (does it derive from :type/*)?

FieldTypeKeywordOrString clj

Like FieldType (e.g. a valid derivative of :type/*) but allows either a keyword or a string. This is useful especially for validating API input or objects coming out of the DB as it is unlikely those values will be encoded as keywords at that point.

IntGreaterThanOrEqualToZero clj

Schema representing an integer than must also be greater than or equal to zero.

IntGreaterThanZero clj

Schema representing an integer than must also be greater than zero.

IntString clj

Schema for a string that can be parsed as an integer. Something that adheres to this schema is guaranteed to to work with Integer/parseInt.

IntStringGreaterThanOrEqualToZero clj

Schema for a string that can be parsed as an integer, and is greater than or equal to zero. Something that adheres to this schema is guaranteed to to work with Integer/parseInt.

IntStringGreaterThanZero clj

Schema for a string that can be parsed as an integer, and is greater than zero. Something that adheres to this schema is guaranteed to to work with Integer/parseInt.

JSONString clj

Schema for a string that is valid serialized JSON.

KeywordOrString clj

Schema for something that can be either a Keyword or a String.

Map clj

Schema for a valid map.

non-empty clj

(non-empty schema)

Add an addditonal constraint to schema (presumably an array) that requires it to be non-empty (i.e., it must satisfy seq).

NonBlankString clj

Schema for a string that cannot be blank.

NonNegativeInt clj

Schema representing an integer 0 or greater

PositiveNum clj

Schema representing a numeric value greater than zero. This allows floating point numbers and integers.

with-api-error-message clj

(with-api-error-message schema api-error-message)

Return schema with an additional api-error-message that will be used to explain the error if a parameter fails validation.