Element API

• Element API now requires Craft 4.3.0+ or 5.0.0+.
• Endpoints are no longer cached beyond the lowest expiry date in the results. (#187)

• Added Craft 5 compatibility. (#186)
• Updated Fractal to 0.20. (#183)

Fixed

• Fixed changelog.

Fixed

• Fixed an issue where EVENT_BEFORE_SEND_DATA wasn't returning data. (#165)

Added

• Added Craft 4 compatibility.

Removed

• Removed craft\elementapi\resources\EntryResource. (#108)

Fixed

• Fixed an error that occurred on Live Preview requests, for endpoints with a cache key defined. (#158)

Fixed

• Fixed a bug where an invalid response code would be returned if the one endpoint config setting was used and Craft could not find a matching element. (#157)

Fixed

• Fixed a bug where endpoint callables weren’t getting called for OPTIONS requests. (#156)

Fixed

• Fixed a bug where custom cache durations were getting ignored. (#153)

Fixed

• Fixed an “Header may not contain more than a single header” error that could occur if a different exception had occurred. (#115)
• Fixed a bug where most exceptions were resulting in 404 responses rather than 500s.
• Fixed a bug where the cacheKey setting would cause an error on non-cached endpoints. (#152)

Added

• Added the cacheKey endpoint configuration setting. (#145)
• Added the contentType endpoint configuration setting.

Changed

• Element API now requires Craft 3.6 or later.
• API endpoints now send X-Robots-Tag: none headers. (#124)
• OPTIONS requests now return an empty response. (#128)
• JSON Feed endpoints now set the version to https://jsonfeed.org/version/1.1.
• JSON Feed endpoints now use the application/feed+json content type by default.
• Error responses no longer contain the exception message, unless the exception thrown was an instance of yii\base\UserException. (#130)

Fixed

• Fixed a bug where API endpoints were returning cached responses for Live Preview requests. (#143)
• Fixed a bug where endpoints whose route params didn’t align with the endpoint arguments would return a misleading 404 message. (#137)

Added

• It’s now possible to invalidate Element API caches via the Caches utility and the invalidate-tags/element-api command. (#136)

Changed

• Element API now requires Craft CMS 3.5 or later.
• Endpoint responses are now cached by default, and are invalidated automatically when relevant elements are saved or deleted.
• Exceptions thrown while resolving endpoints are now logged. (#117)

Fixed

• Fixed a bug where non-200 responses were getting cached. (#130)

Added

• Added the callback endpoint config setting, which enables JSONP output. (#96)

Changed

• The defaults setting can now be set to a callable. (#98)
• criteria endpoint settings can now specify an offset. (#99)
• Updated Fractal to 0.18. (#109)

Deprecated

• Deprecated craft\elementapi\resources\EntryResource. (#108)

Fixed

• Fixed a bug where field types that return objects were getting converted to arrays by the default element transformer. Now their serialized value is used instead. (#75)

Changed

• The generateTransformsBeforePageLoad Craft config setting is now automatically enabled for all Element API endpoints. (#81)

Fixed

• Fixed a bug where it wasn’t possible to set cache, serializer, jsonOptions, pretty, includes, and excludes endpoint config options in the defaults array. (#69)

Changed

• The cache key now takes into account the current site id. (#76)

Changed

• PHP 7.2 compatibility.

Added

• Added support for fetching entry drafts & versions.
• Added craft\elementapi\resources\EntryResource.

Changed

• Exceptions are now represented as JSON responses, with error.code and error.message properties.
• Renamed craft\elementapi\ElementResourceAdapter to craft\elementapi\resources\ElementResource.
• craft\elementapi\resources\ElementResource::getElementQuery() and getTransformer() are now protected methods.

Fixed

• Fixed a deprecation error that occurred on Craft 3 Beta 25 and later. (craftcms/cms#1983)

Changed

• Craft 3 Beta 24 compatibility.

You will need to rename your Element API config file to element-api.php when updating to Craft 3 Beta 20+ and Element API 2.4.1+.

Changed

• Craft 3 Beta 20 compatibility.

Added

• Added the include and exclude endpoint config settings. (#42)

Added

• Added the cache endpoint config setting.

Added

• Added a JSON Feed V1 serializer.
• Added the meta endpoint config setting.
• Added the serializer endpoint config setting.
• Added the jsonOptions endpoint config setting.
• Added the pretty endpoint config setting.

Changed

• Updated Fractal to 0.16.

Fixed

• Fixed a bug where pagination URLs contained an extra pattern query param.

Added

• Added support for a resourceKey endpoint config setting (default is 'data').

Fixed

• Fixed the changelog and download URLs.

Fixed

• Fixed a PHP error that occurred when paginating results. (#36)

Changed

• Craft 3 Beta 8 compatibility.

Added

• Craft 3 compatibility.
• It’s now possible to provide custom resource adapter classes, which could be associated with other things besides elements.
• Added craft\elementapi\ResourceAdapterInterface.
• Added craft\elementapi\ElementResourceAdapter.

Deprecated

• Deprecated the first endpoint config setting. Use one instead.

Added

• Added the include and exclude endpoint config settings. (#41)

Added

• Added the cache endpoint config setting.

Fixed

• Fixed a bug where endpoint were sending JSON headers even if an exception occurred and the HTML error view was returned. (#39)

Added

• Added a JSON Feed V1 serializer.
• Added the meta endpoint config setting.
• Added the serializer endpoint config setting.
• Added the jsonOptions endpoint config setting.

Changed

• Updated Fractal to 0.16.

Added

• Added support for a resourceKey endpoint config setting (default is 'data').

Changed

• Pagination URLs will now honor any existing query string parameters.

Added

• Added the elementApi.onBeforeSendData event.

Changed

• Updated to take advantage of new Craft 2.5 plugin features.

Initial release.