Documentation

Documentation

Cleave documentation will cover installation, configuration, JSON:API resource access, authorization, validation, repository adapters, operations, and SDK usage.

Getting Started

A first pass through where Cleave fits and what to configure first.

Resource Access

Use Cleave resources with CRUD, filters, fields, pagination, relationships, and write acknowledgements.

Request Requirements

Required headers, method and path rules, request size limits, authorization, and preflight behavior.

Error Responses

HTTP status codes, error body format, client-correctable failures, preflight errors, parser errors, and repository error behavior.

JWT Authentication

Configure JWT verification and map token claims into Cleave access decisions.

Repositories

Define repository connections, adapter boundaries, reader pools, writer pools, and repository-specific behavior.

Access Control

Choose who can read, change, or delete records, with authenticated request examples.

Configuration

Configure listeners, HTTP limits, interface policy, repositories, authentication, caching, logging, and metrics.

Deployment

Install Cleave, run it in Docker, connect repositories, and monitor service health and performance.

Logging and Metrics

Operational visibility for request counters, method mix, reads, writes, and logging output.

SDKs and Examples

Language-level SDK guidance and concise examples for ordinary application use.