Liking cljdoc? Tell your friends :D

boundary.core.validation.codes

Error code catalog and definitions.

This namespace defines standardized error codes used across all validation operations, ensuring consistency in error reporting and enabling i18n support.

Error Code Format: :domain.field/error-type

Examples: :user.email/required :user.email/invalid-format :user.role/invalid-value :billing.amount/out-of-range

Categories:

  • :required - Missing required field
  • :invalid-format - Format validation failure
  • :invalid-value - Value doesn't match allowed values
  • :out-of-range - Numeric/date value outside allowed range
  • :too-short - String/collection below minimum length
  • :too-long - String/collection above maximum length
  • :duplicate - Uniqueness constraint violation
  • :not-found - Referenced entity doesn't exist
  • :forbidden - Operation not allowed by business rules
  • :dependency - Depends on another field/condition

Design Principles:

  • Codes are keywords for easy matching
  • Hierarchical naming for discoverability
  • Module-specific prefixes for isolation
  • Generic suffixes for cross-module consistency
Error code catalog and definitions.

This namespace defines standardized error codes used across all validation
operations, ensuring consistency in error reporting and enabling i18n support.

Error Code Format:
  :domain.field/error-type

Examples:
  :user.email/required
  :user.email/invalid-format
  :user.role/invalid-value
  :billing.amount/out-of-range

Categories:
  - :required         - Missing required field
  - :invalid-format   - Format validation failure
  - :invalid-value    - Value doesn't match allowed values
  - :out-of-range     - Numeric/date value outside allowed range
  - :too-short        - String/collection below minimum length
  - :too-long         - String/collection above maximum length
  - :duplicate        - Uniqueness constraint violation
  - :not-found        - Referenced entity doesn't exist
  - :forbidden        - Operation not allowed by business rules
  - :dependency       - Depends on another field/condition

Design Principles:
  - Codes are keywords for easy matching
  - Hierarchical naming for discoverability
  - Module-specific prefixes for isolation
  - Generic suffixes for cross-module consistency
raw docstring

billing-error-codesclj

Billing module specific error codes.

Billing module specific error codes.
sourceraw docstring

common-error-codesclj

Map of common error codes to their metadata.

Map of common error codes to their metadata.
sourceraw docstring

error-code-catalogclj

Complete catalog of all error codes.

Complete catalog of all error codes.
sourceraw docstring

error-code-exists?clj

(error-code-exists? code)

Check if error code is defined in catalog.

Args: code: Error code keyword

Returns: Boolean

Check if error code is defined in catalog.

Args:
  code: Error code keyword

Returns:
  Boolean
sourceraw docstring

get-error-code-infoclj

(get-error-code-info code)

Get metadata for an error code.

Args: code: Error code keyword

Returns: Error code metadata map or nil

Example: (get-error-code-info :user.email/required) => {:description "Email is required" :category :schema :field :email}

Get metadata for an error code.

Args:
  code: Error code keyword

Returns:
  Error code metadata map or nil

Example:
  (get-error-code-info :user.email/required)
  => {:description "Email is required" :category :schema :field :email}
sourceraw docstring

get-error-codes-by-categoryclj

(get-error-codes-by-category category)

Get all error codes for a category.

Args: category: Category keyword (:schema or :business)

Returns: Vector of [code metadata] pairs

Get all error codes for a category.

Args:
  category: Category keyword (:schema or :business)

Returns:
  Vector of [code metadata] pairs
sourceraw docstring

get-error-codes-for-fieldclj

(get-error-codes-for-field field)

Get all error codes related to a field.

Args: field: Field keyword

Returns: Vector of [code metadata] pairs

Get all error codes related to a field.

Args:
  field: Field keyword

Returns:
  Vector of [code metadata] pairs
sourceraw docstring

suggest-error-codeclj

(suggest-error-code code)

Suggest similar error codes for a typo/unknown code.

Args: code: Error code keyword (possibly misspelled)

Returns: Vector of similar codes (simple string distance matching)

Suggest similar error codes for a typo/unknown code.

Args:
  code: Error code keyword (possibly misspelled)

Returns:
  Vector of similar codes (simple string distance matching)
sourceraw docstring

user-error-codesclj

User module specific error codes.

User module specific error codes.
sourceraw docstring

workflow-error-codesclj

Workflow module specific error codes.

Workflow module specific error codes.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close