Documentation Index
Fetch the complete documentation index at: https://docs.apivalk.com/llms.txt
Use this file to discover all available pages before exploring further.
Upgrade Guides
This section contains upgrade guides between major versions.v1 to v2
This section lists major changes and steps required to upgrade from Apivalk v1 to v2.Breaking Changes
- Renamed
MODE_EDITtoMODE_UPDATE: All occurrences ofMODE_EDITinAbstractPropertyCollectionand related security permissions (e.g.,asset:edittoasset:update) have been renamed. - Renamed “Ordering” to “Sorting”: The terminology and related classes/methods have been updated from “Ordering” to “Sorting” (e.g.,
Orderis nowSort). - Property System Refactor:
NumberPropertyhas been split intoIntegerPropertyandFloatProperty.StringPropertynow has specialized variants likeEnumProperty,DateProperty,DateTimeProperty,ByteProperty, andBinaryProperty.
New Features
- Resource System: Introduced
AbstractResourceand a CRUD controller hierarchy (Create,View,List,Update,Delete) to streamline resource management. - Modular Pagination: Added support for multiple pagination strategies (Cursor, Offset, Page) with a new
PaginatorFactory. - Comprehensive Filtering & Sorting: A new robust system for defining filters and sorts on routes, with automatic population from query parameters.
- Property Serializer: Introduced
PropertySerializerfor full round-trip serialization of properties, including validators. - Improved OpenAPI & DocBlock Generation: Enhanced generators to support the new resource system, pagination, filters, and sorts.
- Request Population Strategies: Refactored request population into a modular strategy collection.
Deprecation marks
This section will contain all features/elements which are deprecated and which will be removed in a certain upcoming version.Upcoming removes
| Title | Deprecated At | Remove at | Removed | GitHub Issue |
|---|---|---|---|---|
| Example | 12-11-2025 | v1.2.1 (~ January 2026) | ❌ | Link |
Removed deprecations
| Title | Deprecated At | Remove at | Removed | GitHub Issue |
|---|---|---|---|---|
| Example | 12-11-2025 | 1.1.2 | ✅ | Link |