Liking cljdoc? Tell your friends :D

boundary.admin.schema

Malli schemas for admin module configuration and entities.

This namespace defines all schemas used by the admin module for:

  • Admin module configuration and settings
  • Entity configuration and metadata
  • Field-level configuration
  • Validation and transformation

All schemas follow Malli specifications and include documentation for auto-generated validation and error messages.

Malli schemas for admin module configuration and entities.

This namespace defines all schemas used by the admin module for:
- Admin module configuration and settings
- Entity configuration and metadata
- Field-level configuration
- Validation and transformation

All schemas follow Malli specifications and include documentation
for auto-generated validation and error messages.
raw docstring

ActionConfigclj

Schema for custom action configuration.

Schema for custom action configuration.
sourceraw docstring

ActionParameterclj

Schema for custom action parameter definition.

Schema for custom action parameter definition.
sourceraw docstring

AdminConfigclj

Schema for complete admin module configuration.

Top-level configuration that controls all aspects of the admin interface.

Schema for complete admin module configuration.

Top-level configuration that controls all aspects of the admin interface.
sourceraw docstring

default-admin-configclj

Default admin configuration values.

Default admin configuration values.
sourceraw docstring

default-field-widgetsclj

Default widget mappings for field types.

Default widget mappings for field types.
sourceraw docstring

EntityConfigclj

Schema for entity configuration.

Defines how an entire entity (database table) is displayed and managed in the admin interface. Merges auto-detected schema with manual overrides.

Schema for entity configuration.

Defines how an entire entity (database table) is displayed and managed
in the admin interface. Merges auto-detected schema with manual overrides.
sourceraw docstring

EntityDiscoveryConfigclj

Schema for entity discovery configuration.

Defines how the admin interface discovers and exposes database entities.

Schema for entity discovery configuration.

Defines how the admin interface discovers and exposes database entities.
sourceraw docstring

EntityDiscoveryModeclj

Schema for entity discovery mode configuration.

Controls which database tables are exposed in the admin interface:

  • :allowlist - Only entities explicitly listed are accessible (most secure)
  • :denylist - All entities except those listed are accessible
  • :all - All database tables are accessible (least secure, development only)
Schema for entity discovery mode configuration.

Controls which database tables are exposed in the admin interface:
- :allowlist - Only entities explicitly listed are accessible (most secure)
- :denylist - All entities except those listed are accessible
- :all - All database tables are accessible (least secure, development only)
sourceraw docstring

FieldConfigclj

Schema for individual field configuration.

Defines how a single entity field is displayed and validated in the admin interface.

Schema for individual field configuration.

Defines how a single entity field is displayed and validated in the admin interface.
sourceraw docstring

FieldFilterclj

Schema for a single field filter (Week 2).

Represents a filter on one field with an operator and value(s).

Schema for a single field filter (Week 2).

Represents a filter on one field with an operator and value(s).
sourceraw docstring

FieldGroupclj

Schema for a single field group.

Defines a logical grouping of fields for forms and detail views.

Schema for a single field group.

Defines a logical grouping of fields for forms and detail views.
sourceraw docstring

FieldGroupingConfigclj

Schema for field grouping configuration.

Controls how ungrouped fields are labeled in grouped forms.

Schema for field grouping configuration.

Controls how ungrouped fields are labeled in grouped forms.
sourceraw docstring

FieldTypeclj

Schema for field data types.

Maps database column types to logical field types.

Schema for field data types.

Maps database column types to logical field types.
sourceraw docstring

FieldWidgetclj

Schema for field widget types.

Determines which UI component is used to render a field in forms.

Schema for field widget types.

Determines which UI component is used to render a field in forms.
sourceraw docstring

FilterOperatorclj

Schema for advanced filter operators (Week 2).

Operators for field-specific filtering with type-appropriate operations.

Schema for advanced filter operators (Week 2).

Operators for field-specific filtering with type-appropriate operations.
sourceraw docstring

get-default-widgetclj

(get-default-widget field-type)

Get default widget for field type.

Args: field-type: Keyword field type

Returns: Keyword widget type

Example: (get-default-widget :string) ;=> :text-input (get-default-widget :boolean) ;=> :checkbox

Get default widget for field type.

Args:
  field-type: Keyword field type

Returns:
  Keyword widget type

Example:
  (get-default-widget :string)  ;=> :text-input
  (get-default-widget :boolean) ;=> :checkbox
sourceraw docstring

ListEntitiesOptionsclj

Schema for list entities query parameters.

Schema for list entities query parameters.
sourceraw docstring

PaginationConfigclj

Schema for pagination configuration.

Schema for pagination configuration.
sourceraw docstring

UIConfigclj

Schema for UI-specific configuration.

Controls visual and layout options for forms and views.

Schema for UI-specific configuration.

Controls visual and layout options for forms and views.
sourceraw docstring

validate-admin-configclj

(validate-admin-config config)

Validate admin configuration against schema.

Args: config: Admin configuration map

Returns: {:valid? true :data transformed-data} or {:valid? false :errors validation-errors}

Example: (validate-admin-config {:enabled? true :base-path "/admin" ...})

Validate admin configuration against schema.

Args:
  config: Admin configuration map

Returns:
  {:valid? true :data transformed-data} or
  {:valid? false :errors validation-errors}

Example:
  (validate-admin-config {:enabled? true :base-path "/admin" ...})
sourceraw docstring

validate-entity-configclj

(validate-entity-config config)

Validate entity configuration against schema.

Args: config: Entity configuration map

Returns: {:valid? true :data transformed-data} or {:valid? false :errors validation-errors}

Example: (validate-entity-config {:label "Users" :table-name :users ...})

Validate entity configuration against schema.

Args:
  config: Entity configuration map

Returns:
  {:valid? true :data transformed-data} or
  {:valid? false :errors validation-errors}

Example:
  (validate-entity-config {:label "Users" :table-name :users ...})
sourceraw docstring

validate-list-optionsclj

(validate-list-options options)

Validate list entities options against schema.

Args: options: Query options map

Returns: {:valid? true :data transformed-data} or {:valid? false :errors validation-errors}

Example: (validate-list-options {:limit 50 :offset 0 :sort :email})

Validate list entities options against schema.

Args:
  options: Query options map

Returns:
  {:valid? true :data transformed-data} or
  {:valid? false :errors validation-errors}

Example:
  (validate-list-options {:limit 50 :offset 0 :sort :email})
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