Malli schemas for platform-level concerns: pagination, versioning, API metadata.
These schemas are used across all modules for consistent API responses.
Malli schemas for platform-level concerns: pagination, versioning, API metadata. These schemas are used across all modules for consistent API responses.
Schema for API response metadata.
Includes version info, timestamp, and request ID for observability.
Schema for API response metadata. Includes version info, timestamp, and request ID for observability.
Schema for decoded cursor data (before Base64 encoding).
Contains enough information to resume pagination from a specific point.
Schema for decoded cursor data (before Base64 encoding). Contains enough information to resume pagination from a specific point.
Schema for cursor-based pagination metadata in API responses.
Uses opaque cursors instead of offsets for stable pagination.
Schema for cursor-based pagination metadata in API responses. Uses opaque cursors instead of offsets for stable pagination.
Schema for cursor-based pagination parameters.
Schema for cursor-based pagination parameters.
Schema for Base64-encoded cursor string.
Schema for Base64-encoded cursor string.
Schema for API error responses.
Consistent error format across all API versions.
Schema for API error responses. Consistent error format across all API versions.
(explain-paginated-response response)Get detailed validation errors for paginated response.
Args: response - Paginated response map
Returns: Malli explanation map or nil if valid
Get detailed validation errors for paginated response. Args: response - Paginated response map Returns: Malli explanation map or nil if valid
(explain-pagination-params params)Get detailed validation errors for pagination parameters.
Args: params - Map of pagination parameters
Returns: Malli explanation map or nil if valid
Get detailed validation errors for pagination parameters. Args: params - Map of pagination parameters Returns: Malli explanation map or nil if valid
Schema for link data used to build RFC 5988 Link headers.
Contains URL and relation type for pagination links.
Schema for link data used to build RFC 5988 Link headers. Contains URL and relation type for pagination links.
Schema for RFC 5988 Link header string.
Format: '</api/v1/users?offset=20&limit=20>; rel="next", ...'
Schema for RFC 5988 Link header string. Format: '</api/v1/users?offset=20&limit=20>; rel="next", ...'
Schema for RFC 5988 link relation types.
Supported relations for pagination navigation.
Schema for RFC 5988 link relation types. Supported relations for pagination navigation.
Schema for offset-based pagination metadata in API responses.
Includes total count, offset, limit, and navigation flags.
Schema for offset-based pagination metadata in API responses. Includes total count, offset, limit, and navigation flags.
Schema for offset-based pagination parameters.
Schema for offset-based pagination parameters.
Schema for paginated API responses.
Standard envelope for all paginated endpoints across the application.
Example: {:data [{:id ... :name ...} ...] :pagination {:type "offset" :total 100 :offset 0 :limit 20 ...} :meta {:version :v1 :timestamp #inst "..." ...}}
Schema for paginated API responses.
Standard envelope for all paginated endpoints across the application.
Example:
{:data [{:id ... :name ...} ...]
:pagination {:type "offset" :total 100 :offset 0 :limit 20 ...}
:meta {:version :v1 :timestamp #inst "..." ...}}Schema for pagination configuration.
Used in config.edn to configure pagination behavior.
Schema for pagination configuration. Used in config.edn to configure pagination behavior.
Union schema for pagination metadata (either offset or cursor).
Union schema for pagination metadata (either offset or cursor).
Schema for pagination query parameters.
Used for validating incoming pagination requests. All parameters are optional with sensible defaults.
Schema for pagination query parameters. Used for validating incoming pagination requests. All parameters are optional with sensible defaults.
Schema for parsed version components.
Result of parsing a version string into its major.minor.patch components.
Schema for parsed version components. Result of parsing a version string into its major.minor.patch components.
Schema for sort parameter.
Format: 'field' for ascending, '-field' for descending. Examples: 'name', '-created_at', 'email'
Schema for sort parameter. Format: 'field' for ascending, '-field' for descending. Examples: 'name', '-created_at', 'email'
(valid-cursor-pagination-params? params)Validate cursor pagination parameters.
Args: params - Map of cursor pagination parameters
Returns: Boolean indicating validity
Validate cursor pagination parameters. Args: params - Map of cursor pagination parameters Returns: Boolean indicating validity
(valid-offset-pagination-params? params)Validate offset pagination parameters.
Args: params - Map of offset pagination parameters
Returns: Boolean indicating validity
Validate offset pagination parameters. Args: params - Map of offset pagination parameters Returns: Boolean indicating validity
(valid-paginated-response? response)Validate paginated response structure.
Args: response - Paginated response map
Returns: Boolean indicating validity
Validate paginated response structure. Args: response - Paginated response map Returns: Boolean indicating validity
(valid-pagination-params? params)Validate pagination parameters against schema.
Args: params - Map of pagination parameters
Returns: Boolean indicating validity
Validate pagination parameters against schema. Args: params - Map of pagination parameters Returns: Boolean indicating validity
(valid-version-string? version-str)Validate version string format.
Args: version-str - String version (e.g., "v1", "v1.2")
Returns: Boolean indicating validity
Validate version string format. Args: version-str - String version (e.g., "v1", "v1.2") Returns: Boolean indicating validity
Schema for validation error details.
Used when request parameters fail validation.
Schema for validation error details. Used when request parameters fail validation.
Schema for collection of validation errors.
Schema for collection of validation errors.
Schema for API versioning configuration.
Used in config.edn to configure version behavior.
Schema for API versioning configuration. Used in config.edn to configure version behavior.
Schema for version metadata in API responses.
Provides version information and deprecation status to clients.
Schema for version metadata in API responses. Provides version information and deprecation status to clients.
Schema for API version string.
Supports formats: v1, v1.2, v1.2.3, v0 (experimental)
Schema for API version string. Supports formats: v1, v1.2, v1.2.3, v0 (experimental)
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |