v1.0.0-rc.1

⚠️ Breaking Changes

• Replace Resource::getId(object $model, Context $context): string method with
  Resource::id(): Id method, which returns an Id field instance to define ID
  schema, validation, and writability
• Change ErrorProvider::getJsonApiErrors(): array to
  ErrorProvider::getJsonApiError(): array (singular) - exceptions now
  represent a single error rather than potentially multiple errors. Wrap
  ErrorProviders in JsonApiErrorsException to represent multiple errors.
• Rename Exception\Concerns\SingleError trait to
  Exception\Concerns\JsonApiError and change its API:
  • setSource(?array $source): static → source(array $source): static
  • setMeta(?array $meta): static → meta(array $meta): static
  • setLinks(?array $links): static → links(array $links): static
• Custom deserializers on ToOne relationships now receive the resolved model
  rather than the raw relationship object, for consistency with ToMany
• Remove Pagination\Concerns\BuildsUrls trait (replaced by
  Context::currentUrl())
• Move Extension\Atomic to Extension\Atomic\Atomic
• Remove json_api_response() helper (use Context::createResponse() instead)
• Remove Context::queryParam() (use Context::parameter() for defined
  parameters, or Context::$request->getQueryParameters())

Added

• Major refactor of endpoints, query parameter validation, and OpenAPI schema
  generation
  • Allow endpoints and pagination implementations to define query parameters
    for validation and schema generation
  • Allow endpoints to define resource and relationship links
  • Introduce SchemaContext to store relevant context during schema
    generation
  • Make Show and Update aggregate separate *Resource and
    *Relationship endpoints
  • Refactor endpoint handlers and traits
• More comprehensive type schema support
  • Add nullable() method to Type classes, allowing sub-types (e.g. array
    items or object properties) to be nullable
  • Add Obj, Any, AnyOf, AllOf, OneOf, and Not types
  • Convert type validation errors to overridable exception classes
• Add Context::createResponse() method for building JSON:API responses with
  automatic jsonapi object inclusion
• Add JsonApi::meta() method for including meta information in the jsonapi
  object
• Add support for resource links:
  • Add Resource::links() method for defining custom resource-level links
  • Add Schema\Link class for defining rich link objects with metadata
• Add Page::$rangeTruncated parameter for cursor pagination range truncation
  support
• Add full support for JSON:API profiles:
  • Parse profile URIs from Accept header
  • Context::profileRequested(string $uri): bool - check if a profile was
    requested
  • Context::requestedProfiles(): array - get all requested profile URIs
  • Context::activateProfile(string $uri) - activate a profile for the
    response Content-Type header
  • Cursor pagination automatically activates the
    https://jsonapi.org/profiles/ethanresnick/cursor-pagination profile
• Add support for asynchronous processing following the
  JSON:API Asynchronous Processing
  recommendation
  • Add Create::async() method for responding with 202 Accepted
  • Add Show::seeOther() method for responding with 303 See Other
    redirects
• Add endpoint hooks for customizing responses and schema:
  • Add Endpoint::headers() method for defining custom response headers with
    Header schema class
  • Add Endpoint::response() method for defining custom response callbacks
  • Add Endpoint::schema() method for defining custom schema
  • Add Create::saved() and Update::saved() to register callbacks after
    the model/fields are saved, but before the response is serialized
• Add ability to customize error objects
  • Add specific exception classes for all errors
  • Add JsonApi::errors(array $overrides) method to register error object
    overrides, keyed by exception class name. detail values accept
    replacements using the :key syntax.
  • Add Exception\JsonApiErrorsException for representing multiple errors
• Add Context::currentUrl(array $params = []): string method for building URLs
  with query parameter overrides
• Add self link to Index endpoint document
• Add Id field class for customizing resource ID behavior, including:
  • Type constraints (string, integer, etc.)
  • Client-generated IDs via writableOnCreate()
  • Custom validation rules
  • Getter/setter callbacks
• Add linkageMeta() method to relationship fields for adding meta to resource
  identifier objects in linkage
• Add static Field::location(): string method to determine where fields appear
  in JSON:API documents (attributes, relationships, or root level for id)
• Add Context::$data to access resolved create/update data in callbacks

Changed

• Various performance optimizations to improve serialization speed
• Improve OpenAPI schema generation to properly handle ID field constraints and
  avoid redundant properties

v1.0.0-beta.6

⚠️ Breaking Changes

• Change Resource\Paginatable::paginate() signature to accept the resolved
  offset and limit integers (plus the request context) and return the page of
  results instead of mutating the query in place
• New contract for custom Pagination implementations:
  • Add paginate(object $query, Context $context): Page method which should
    return a page of results
  • Remove meta and links methods; set this data in paginate via the
    Context object
• Resource\\Listable implementations must now provide defaultSort() and
  pagination() methods so defaults can be reused when listing related data
• Refactor Serializer so it is instantiated without a Context and expects
  the resource context to be provided to addPrimary() / addIncluded()

Added

• Add cursor pagination support via Endpoint\Index::cursorPaginate() and the
  Resource\CursorPaginatable contract, following the
  ethanresnick/cursor-pagination JSON:API profile
• Allow exceptions to attach meta and links members to the error response
• Add Context::$documentMeta and Context::$documentLinks as ArrayObject
  instances to allow callbacks to add meta information to the response document
• Support JSON:API relationship URLs via the Show endpoint, adding automatic
  self / related links, and paginated/filterable/sortable to-many responses
  when the related resource is Listable
• Allow the Update endpoint to handle PATCH / POST / DELETE requests to
  relationship URLs and return the updated relationship document
• Implement the Resource\Attachable contract and add ToMany::attachable(),
  validateAttach(), and validateDetach() helpers for controlling
  relationship mutation endpoints with attach/detach hooks
• Introduce Endpoint\ResourceEndpoint and Endpoint\RelationshipEndpoint so
  endpoints can contribute relationship and resource links during serialization

v1.0.0-beta.5

⚠️ Breaking Changes

• Tobyz\\JsonApiServer\\Laravel\\Filter\\EloquentFilter renamed to
  ColumnFilter.
• Remove the Has Laravel filter; use WhereExists instead.
• Remove the WhereDoesntHave Laravel filter; use the operator support on
  WhereHas instead.
• Remove Where::asNumber(); express numeric comparisons with operators such as
  filter[score][gt]=... or filter[score][lte]=....

Added

• Add support for boolean filter groups (filter[and], filter[or],
  filter[not]) for resources that implement the SupportsBooleanFilters
  interface
• Laravel: Add support for boolean filter groups to EloquentResource
• Laravel: Overhaul filter implementations to support operators like eq, ne,
  in, lt, lte, gt, gte, like, notlike, null, and notnull

v1.0.0-beta.4

Added

• Add support for generating OpenAPI Definitions
• Add CollectionAction and ResourceAction endpoints
• Allow including relationships by default (#96 by @SychO9)
• Add support for conditional linkage (#110 by @SychO9)
• Add Enum support to Str type
• Add the ability to make a field sparse by default
• Add the ability to add after callbacks to the Create endpoint
• Add the ability to pass a condition to writableOnCreate
• Add Relationship::notIncludable()
• Allow psr/http-message v2
• Laravel: Add ToOne and ToMany subclasses which support constraining relationship queries (#103 by @SychO9)
• Laravel: Support array of abilities in can helper

Changed

• Laravel: EloquentCollection queries now keep the resource's Eloquent\Builder instead of converting to the base Query\Builder
• Laravel: Apply EloquentResource scope when applying WhereHas filter

Fixed

• Fix error when request body data.attributes is null (#98 by @SychO9)
• Fix support for nested includes on polymorphic relationships
• Fix multipleOf bugs (#114 by @bertramakers)
• Fix error when using Context::withRequest (#107 by @SychO9)
• The self link for a resource now only appears if the Show endpoint is present in a collection
• Laravel: Support dynamically resolved relationships (#100 by @SychO9)
• Laravel: Fix serialization for MorphTo relationships (#97 by @SychO9)
• Laravel: Only attempt to preload related EloquentResources
• Laravel: Fix error parameter name in WhereBelongsTo filter
• Laravel: Fix limiting ToMany relation results (#112 by @SychO9)

v1.0.0-beta.3

⚠️ Breaking Changes

• Drop Interface suffix from various interfaces:
  • Resource class renamed to AbstractResource
  • ResourceInterface renamed to Resource
  • CollectionInterface renamed to Collection
  • ErrorProviderInterface renamed to ErrorProvider
  • PaginationInterface renamed to Pagination
  • EndpointInterface renamed to Endpoint
  • TypeInterface renamed to Type

Fixed

• Call user-defined serializer before type serializer (#91)
• Fix finding resource when creating polymorphic relationship (#93)
• Prevent relationship value from being retrieved if it won't be used (not included and no linkage)

v1.0.0-beta.2

⚠️ Breaking Changes

• Types are now their own construct instead of being subclasses of Attribute. See the Attributes documentation for more information.
• Removed support for defining polymorphic relationships by passing a map of model classes to resource types. You should use heterogeneous collections instead. See the Relationships documentation for more information.

Added

• Add support for heterogeneous collections
• Add Arr type for defining array attributes (#88 by @bertramakers)
• Laravel: Allow WhereHas field to be specified manually

Fixed

• When creating a resource, set the context model prior to field validation
• Fix error when updating a resource with a conflicting ID (#85)
• Laravel: Fix Has filter not working without a scope
• Laravel: Don't apply relationship loading constraints if there aren't any

v1.0.0-beta.1

Added

• Add Str::enum() method (#75 by @bertramakers)
• Allow literal values in Field::default() method (#80 by @bertramakers)

Fixed

• Fix Number properties not being initialized
• Fix validators not being run for null values
• Fix DateTime values containing milliseconds not being accepted
• Fix nested filters not receiving correct resource in context
• Laravel: Fix EloquentResource sometimes using incorrect relation name when setting value
• Laravel: Convert DateTime values to Laravel app's storage timezone
• Laravel: Validate that WhereBelongsTo filter input is a list

v1.0.0-alpha.2

Added

• Finish Laravel integration
• Add basic field schema configuration in preparation for OpenAPI generation
• Add Context::$query to access the query used in the Index endpoint
• Add Context::fieldRequested() and Context::sortRequested() methods
• Add BooleanDateTime attribute for exposing internal date-time values as booleans
• Improve error sources in Bad Request errors
• Add a performance benchmark

Changed

• Add void return type to Filter::apply() signature

Fixed

• Fix typed attribute values being deserialized and always passing validation
• Fix visibility callback result not being cast to a boolean
• Fix Integer incorrectly not extending Number
• Fix empty to-many relationships not being present in the response at all
• Fix TypeError when removing non-nullable to-one relationship
  (#74)

v1.0.0-alpha.1

Read the new docs

• New class-based API. More ergonomic for managing large resource definitions and
  inheriting/overriding behavior. Complex fields can be extracted into their own classes and
  reused across resources.

• Typed attributes. Implementations of typed attributes are provided to match the data types
  in the OpenAPI specification. Attributes can be marked as required and nullable.

• Customizable endpoints. Each endpoint is now opt-in for each resource and can be configured
  and implemented separately. Also adds the ability for custom endpoints to be added.

• Restructured internals. The codebase is cleaner and easier to reason about, especially the
  serialization process.

Still to come:

• Implementation of Laravel stuff (currently it is documented but not implemented)
• Ability to generate OpenAPI definitions
• Additional attribute types (array, object)
• Benchmarks (it should probably be a bit faster)

v0.2.0-beta.2

Added

• Content-Type validation and Accept negotation
• Include jsonapi object with version member in response
• Validate implementation-specific query parameters according to specification
• Added Location header to 201 Created responses
• Improved error repsonses when creating and updating resources
• Context::filter() method to get the value of a filter
• ResourceType::applyScope(), applyFilter() and applySort() methods
• ResourceType::url() method to get the URL for a model
• Forbidden error details for CRUD actions, useful when running Atomic Operations
• JsonApi::getExtensions() method to get all registered extensions
• ConflictException class

Changed

• Renamed $linkage parameter in AdapterInterface methods to $linkageOnly
• Renamed Type::newModel() to model() to be consistent with Adapter

Fixed

• Properly respond with meta information added to Context instance