Releases: json-api-dotnet/JsonApiDotNetCore
v5.0.0-pre1
New features and enhancements
First of all, this release is a refresher to embrace the latest technologies. We've updated to ASP.NET 6 with EF Core 6 and adopted nullable reference types. We've switched to System.Text.Json. And we're now leveraging EF Core's built-in many-to-many relationships. Lastly, ASP.NET controllers can be auto-generated using source generators. Aside from these changes, pagination links at secondary endpoints got better. We've added various performance optimizations. And improved error responses on invalid input. And quite some bug fixes too!
Note: See our updated documentation, as well as updated examples in our codebase.
Upgrading from v4 instead? Be sure to check out our migration guide.
Breaking changes
- When using
[Resource], this now automatically generates a controller class. Replace with[Resource(GenerateControllerEndpoints = JsonApiEndpoints.None)]to turn that off. - The experimental Resource Hooks feature has finally been removed.
- The switch to System.Text.Json introduced breaks as well, see here and here.
- Short-hand interfaces were removed too.
- Remaining breaks are listed here, here and here.
Merged PRs
- Removed Resource Hooks by @bart-degreed in #1036
- Updated dependencies to .NET 5 with EF Core 5 by @bart-degreed in #1022
- Updated roadmap for v5.x by @bart-degreed in #1034
- Native many to many by @bart-degreed in #1037
- Refactorings by @bart-degreed in #1038
- Instrumented code to measure execution time of the various layers by @bart-degreed in #1023
- Optimized RemoveFromToManyRelationship endpoint by @bart-degreed in #1039
- Feature/allow leading space by @sgryphon in #1041
- Rename JsonApiDotNetCoreExampleTests -> JsonApiDotNetCoreTests by @maurei in #1069
- Removing dependency on JsonApiDotNetCoreExample project in test projects by @maurei in #1068
- Updated PostgreSQL to v13.4 by @bart-degreed in #1072
- Removed temporary workaround to start postgres service in cibuild by @bart-degreed in #1083
- Restored docs for HasManyThrough, which was removed in #1037 by @bart-degreed in #1084
- Use System.Text.Json by @bart-degreed in #1075
- Corrected example in docs by @bart-degreed in #1087
- Redesign conversion between JSON objects and ASP.NET models by @bart-degreed in #1091
- Remove short-hand interfaces for TId is int by @bart-degreed in #1093
- Nullable reference types by @bart-degreed in #1095
- Secondary paging by @bart-degreed in #1100
- Resource Graph validations by @bart-degreed in #1101
- Fix code cleanup by @bart-degreed in #1107
- Various fixes and improvements by @bart-degreed in #1114
- Auto-generated JSON:API controllers using source generators by @bart-degreed in #1117
- Update to .NET 6 with EF Core 6 by @bart-degreed in #1122
- Added tests for blobs by @bart-degreed in #1125
- Move resource annotations into separate package by @bart-degreed in #1127
New Contributors
Full Changelog: v4.2.0...v5.0.0-pre1
Contributors
Assets 2
v4.2.0
New features
See the notes for v4.2.0-beta. The most prominent one: new extensibility points for business logic, documented here and here.
This replaces the experimental Resource Hooks, which we intend to remove in the next major version.
Breaking changes
We had to take a few binary-breaking changes in obscure places. Just recompiling your project should be sufficient in nearly all cases. See our versioning policy.
Closed issues
- Consecutive exception hides original error (#1017)
- Bugs around empty included[] in response (#991)
- Adding extra includes from IResourceDefinition.OnApplyIncludes() does not work (#989)
- Sending an empty fields parameter results in error (#996)
- Makes the hashing algorithm used for ETags pluggable (#1007)
v4.2.0-beta
We're releasing a beta because we want to verify we've done the new business rules extensibility points on IResourceDefinition right (see here and here). Please give it a try and let us know by creating an issue, so we can adapt. Once released, we cannot take breaking changes anymore.
New features
- Rewrite of
LinkBuilderto use ASP.NET Core routing to render links (#987) - New business logic extensibility points on
IResourceDefinition(#977) - New option to emit JSON:API version in response documents (#992)
- ETag support to save network bandwidth (#933)
- Allow condition on has() filter function (#985)
Breaking changes
We had to take a few binary breaking changes in obscure places. Just recompiling your project should be sufficient in nearly all cases.
Closed issues
v4.1.1
New features
- Support for bulk/batch requests (json:api atomic:operations) (#930)
Breaking changes
We had to take a few binary breaking changes in obscure places. Just recompiling your project should be sufficient in nearly all cases.
Closed issues
v4.1.0
NuGet issues prevented us from publishing this version, so we created v4.1.1 instead.
v4.0.4
v4.0.3
v4.0.2
v4.0.1
v4.0.0
Introduction
We're back! Almost 2 years since the last stable release, a lot has changed.
The original author was no longer able to maintain the project.
Long story short: @bart-degreed and @maurei have taken over and are fully committed to bringing this project to the next level.
Are you building an API from scratch? Our documentation is the place to get started.
Upgrading from v3 instead? Be sure to check out our migration guide.
The release notes of earlier pre-release v4 versions contain detailed lists of changes since v3. To summarize, these are the highlights:
- Works with .NET Core 3.1/5 and Entity Framework Core 3.1/5
- New advanced filtering capabilities (old syntax is still available)
- Enhanced support for usage of the existing query string parameters
- Flexible annotations to control what is permitted per resource attribute
- Increased compliance with the JSON:API specification
- Improved handling of create/update/delete of resources and relationships
- Added support for POST and DELETE on relationship endpoints
- Change tracking on POST/PATCH requests reduces the size of response messages
- Vastly improved request validation with clear error messages
- Built for scale: default page size, options to control maximum page size and number, maximum include depth
- Improved support for custom logging and error handling
- Eager Loading enables to unconditionally include unexposed related entities
- A limited set of services can now be injected in resources
- Up-to-date documentation, including auto-generated examples
- SourceLink enables to step into our NuGet library during debug by downloading sources from GitHub
- Well over a thousand automated tests (mostly integration)
- Lots and lots of bugfixes
Removed features:
- Entity-Resource separation (motivation here).
- Bulk operations, because json:api has retracted its experimental specification.
As a replacement, they recently finished Atomic Operations, which we intend to implement in one of the next versions.
Finally, a big thanks to all community contributors!
Release notes
New features
(none)
Breaking changes
- Changed the usage of
fieldsquery string parameter to be json:api spec compliant. It now requires a resource type between brackets instead of a relationship path. The value can contain both attributes and relationships.
Closed issues
- Small refactorings (#893)
- Changes usage of fields parameter to be json:api spec compliant (#904)
- Fixed: hide duplicate stacktrace for ModelState errors (#905)
- Fixed: write content type on invalid Accept headers (#903)
- Wrong totalResourceCount when using resource definition filter (#881)
- Minor fixes in content negotiation (#897)
- Refactored JsonApiException to contain a list of errors (#894)