Skip to content

History / Request

Revisions

  • Doc: Add CrudResourceConfig and v4 responses Add typed CrudResourceConfig and JsonResponse docs and update documentation to reflect Pair v4's explicit response path. Multiple docs (API, ApiExposable, ApiResponse, CorsMiddleware, CrudController, Idempotency, Middleware, MiddlewarePipeline, QueryFilter, RateLimiter, Request, SpecGenerator, User) were updated to: introduce CrudResourceConfig for normalized/typed CRUD config, document JsonResponse and ApiResponse::*Response builders, change middleware/action examples to return response objects (signatures now return mixed), and clarify that explicit response objects do not terminate execution while legacy helpers preserve terminate-after-send behavior. Also updated links and examples to use jsonResponse/errorResponse/paginatedResponse where appropriate.

    @viames viames committed Apr 21, 2026
  • Docs: expand API & Aircall docs, add Google pages Large documentation updates and additions: expanded the API, ApiController and ApiResponse guides with clearer lifecycle, middleware, idempotency and JSON handling examples; clarified ActiveRecord behavior, forms and pagination notes; refactored Aircall integration docs into an AircallAPI cookbook and enriched AircallClient reference with usage examples, error-handling guidance, and production patterns; added Google-related pages (GoogleAddress, GoogleGeocoder, GoogleMaps, GoogleMapsClient, GooglePlacesService). Various examples and small clarifications added across many markdown pages to improve developer guidance.

    @viames viames committed Mar 26, 2026
  • Docs: add API rate limiting, default throttle Add comprehensive documentation for API rate limiting and related behaviors across docs. Introduces Redis-first RateLimiter with file fallback, a new RateLimitResult returned by attempt() (with applyHeaders()), and guidance for atomic sliding-window semantics. Documents that ApiController now registers a default ThrottleMiddleware when PAIR_API_RATE_LIMIT_ENABLED=true, describes registerDefaultMiddleware() hook and ordering considerations, and shows examples for 429 handling. Update Request::ip() to be proxy-aware via PAIR_TRUSTED_PROXIES and document identity resolution used by ThrottleMiddleware (sid, bearer, user, IP). Add new .env variables and examples in Configuration-file.md and update common pitfalls and integration notes accordingly.

    @viames viames committed Mar 19, 2026
  • Add extensive Pair framework docs and update indexes Add dozens of new markdown docs for Pair framework components (ACL, exceptions, services, mailers, form controls, helpers, models, integrations and more). Update API.md and Home.md to reference the new pages. Extend ActiveRecord.md with a modern quick reference and practical recipes, add additional Database usage examples, and include minor updates to Query.md, Model.md and View.md to reflect the expanded documentation. These changes populate the docs/wiki with usage examples, main methods, and implementation notes for each component.

    @viames viames committed Feb 24, 2026
  • Add API docs and update core documentation Add comprehensive API documentation and related reference pages. Also update existing docs: refine .env/config guidance in Configuration-file.md, restructure and simplify Controller.md, refresh Home.md and Router.md and update index.md. These changes expand the framework docs to cover the API layer, middleware, idempotency, database utilities, push delivery, and developer-facing configuration best practices.

    @viames viames committed Feb 22, 2026