Skip to content

index.md

Latest commit

 

History

History
51 lines (41 loc) · 3.76 KB

index.md

File metadata and controls

51 lines (41 loc) · 3.76 KB
Raw
title API Reference
path api-reference
summary Exact configuration, collection, field, and Client SDK contracts, with links to the subsystem references that own search, authentication, uploads, rich text, routing, and storage.

API Reference

Companions:

  • Configuration — an introductory tour of the application files and runtime boundaries behind these contracts.
  • Key architectural decisions — the design context for the APIs listed here.
  • Scheduling — the ServerConfig scheduling properties in context: recurring tasks, the ticker, and scheduled publication.
  • Testing — the unit, integration, and browser suites used to verify these contracts.

This section is the lookup surface for Byline's application-facing APIs. Use it when you know which system you are configuring and need the exact properties, defaults, parameters, return shapes, or runtime restrictions.

Core references

  • Configuration API documents BaseConfig, AdminConfig, ServerConfig, BylineCore, configuration registration, and server client getters.
  • Collections API documents CollectionDefinition, CollectionAdminConfig, BlockAdminConfig, workflow configuration, and lifecycle hooks.
  • Fields API documents the common field contract, all 22 built-in field kinds, default values, validation, hooks, and admin field overrides.
  • Client SDK API documents BylineClientConfig, BylineClient, every public CollectionHandle method, shared read and write options, and result envelopes.

Subsystem references

These existing documents remain the canonical references for their narrower contracts:

Surface Canonical reference
Authentication, actors, abilities, and sessions Authentication and authorization
Audit log and version attribution Auditability
File and image uploads, UploadConfig, and upload hooks File and media uploads
Relation fields, populate, and relation envelopes Relationships
Rich-text editor and server adapters Rich text
Document paths and slugifiers Document paths
Document trees Document trees
Search collection configuration Search configuration
Search query API Search API
SearchProvider implementation contract Search provider contract
Admin and API route mounts Routing and API
Interface and content locale configuration Internationalization
Database adapter contract and boot composition Core composition
Typed EAV storage and stored value shapes Document storage

Reference conventions

  • A property without ? is required by TypeScript.
  • “Conditional” means the property is optional in the type but required when another configured feature uses it.
  • Defaults describe current runtime behavior when the property is omitted.
  • _-prefixed options are internal or trusted-tooling escape hatches, even when TypeScript exposes them for hook re-entry.
  • The implementation and exported TypeScript types remain authoritative when a reference and a locally installed package version differ.