ring.swagger.schema — metosin/ring-swagger 0.26.2

coerce clj

(coerce schema value)

(coerce schema value type)

Coerces a value against a schema using a given coerser. If no errors, returns the coerced value, otherwise returns ValidationError.

Optional third parameter is a dispatch value to ring.swagger.coerce/coercer, defaults to :json

coerce! clj

(coerce! schema value)

(coerce! schema value type)

Coerces a value against a schema using a given coerser. If no errors, returns the coerced value, otherwise throws a schema.utils.ErrorContainer enriched with :type ::validation.

Optional third parameter is a dispatch value to ring.swagger.coerce/coercer, defaults to :json

describe clj

(describe schema desc & kvs)

Attach description and possibly other meta-data to a schema.

error? clj

(error? x)

Checks whether input is an Schema error.

field clj

(field schema meta-data)

Attaches meta-data to a schema under :json-schema key. If the schema is of type which cannot have meta-data (e.g. Java Classes) schema is wrapped first into wrapper Schema.

named-schema? clj

(named-schema? x)

Checks whether input is a named schema.