Liking cljdoc? Tell your friends :D

boundary.core.schema

Canonical schemas for the core library's primary domain shapes.

Documents the two central data structures used across the framework:

  1. Validation result — returned by all core validation functions
  2. Interceptor context — the map that flows through interceptor pipelines

These schemas are provided as documentation references. Runtime validation of these shapes lives in boundary.core.interceptor-context and boundary.core.validation.result respectively.

Canonical schemas for the core library's primary domain shapes.

Documents the two central data structures used across the framework:

1. Validation result — returned by all core validation functions
2. Interceptor context — the map that flows through interceptor pipelines

These schemas are provided as documentation references. Runtime validation
of these shapes lives in boundary.core.interceptor-context and
boundary.core.validation.result respectively.
raw docstring

InterceptorContextclj

Schema for the map that flows through the interceptor pipeline.

Every interceptor receives and returns this map. Core interceptors add :result; shell interceptors handle :request, :system, and I/O.

Minimal example (CLI): {:op :example-op :system {} :request {:args ["--help"]}}

HTTP example: {:op :user-create :system {:logger ...} :request {:headers {...} :body {...}} :result {...}}

Schema for the map that flows through the interceptor pipeline.

Every interceptor receives and returns this map. Core interceptors add
:result; shell interceptors handle :request, :system, and I/O.

Minimal example (CLI):
  {:op :example-op :system {} :request {:args ["--help"]}}

HTTP example:
  {:op :user-create
   :system {:logger ...}
   :request {:headers {...} :body {...}}
   :result {...}}
sourceraw docstring

ValidationResultclj

Schema for the map returned by core validation functions.

Success example: {:valid? true :data {:email "user@example.com"}}

Failure example: {:valid? false :errors [{:field :email :code :invalid-format :message "..."}]}

Schema for the map returned by core validation functions.

Success example:
  {:valid? true :data {:email "user@example.com"}}

Failure example:
  {:valid? false :errors [{:field :email :code :invalid-format :message "..."}]}
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