Download Latest Version v5.7.1 source code.tar.gz (1.4 MB)
Email in envelope

Get an email when there's a new version of JsonApiDotNetCore

Home / v5.6.0
Name Modified Size InfoDownloads / Week
Parent folder
README.md 2024-06-30 5.0 kB
v5.6.0 source code.tar.gz 2024-06-30 727.7 kB
v5.6.0 source code.zip 2024-06-30 1.5 MB
Totals: 3 Items   2.3 MB 0

New features and enhancements

Aside from a new logo (which was needed to enable dark mode on the documentation website), most of the changes involve unblocking our ongoing development of OpenAPI support for JSON:API. Please read the docs and give it a try (see the instructions for NSwag and Kiota), we'd love to hear your feedback. - The describedby top-level link has been added, whose visibility can be configured at various levels. Its value can be set by implementing IDocumentDescriptionLinkProvider. - Controller action methods have been enriched with [Required], pipeline methods with [DisallowNull] for id parameters. - A relaxed variant of the atomic operations media type can be used, to workaround deficiencies in OpenAPI client generators.

Breaking changes

  • When your project contains an atomic operations controller, earlier versions would always expose all operations for all resource types, despite the use of [Resource(GenerateControllerEndpoints = ...)] to constrain endpoints. The new behavior is to block operations whose endpoints are blocked using GenerateControllerEndpoints. If you're using custom controllers (or just want to override this default), implement IAtomicOperationFilter. To revert to the old behavior, use IAtomicOperationFilter.AlwaysEnabled.

Bugfixes

  • Fix crash on empty query string parameter name. For example: http://localhost:5065/people?=.
  • Fix percent-encoding of whitespace in response links. For example: ~equals(city,%27New York%27)~ equals(city,%27New%20York%27).
  • Return empty object ({}) instead of { "data": null } in atomic operation results.
  • Do not allow lid in atomic operations request when a client-generated ID is required.
  • Take options.UseRelativeLinks into account when rendering HTTP Location header.

Merged PRs

Full Changelog: https://github.com/json-api-dotnet/JsonApiDotNetCore/compare/v5.5.1...v5.6.0

Source: README.md, updated 2024-06-30