CHANGELOG.md

Changelog

NEXT

...

1.7.1 (2024-02-23)

• Fix bug where underscore/dasherize misses single characters by @protestContest in beam-community#316
• Transform relationship keys with shallow field transformation options (#314) by @protestContest in beam-community#315

Full Changelog: https://github.com/beam-community/jsonapi/compare/1.7.0...1.7.1

1.7.0 (2024-02-15)

What's Changed

• Add options to transform field keys non-recursively (#132) by @protestContest in beam-community#310

Full Changelog: https://github.com/beam-community/jsonapi/compare/1.6.3...1.7.0

1.6.3 (2023-08-03)

What's Changed

• Nested query filter fixes by @TylerPachal in beam-community#302

Full Changelog: https://github.com/beam-community/jsonapi/compare/1.6.2...1.6.3

1.6.2 (2023-07-03)

What's Changed

• Error handling fixed per beam-community#294.

Full Changelog: https://github.com/beam-community/jsonapi/compare/1.6.1...1.6.2

1.6.1 (2023-06-26)

What's Changed

The features of #270 were broken in two ways that this release fixes.

1. The @spec for the relationships callback for JSONAPI.View actually did not allow for the various new structures a relationships callback is allowed to return under the above PR.
2. The PR was intended to support (among other more general purposes) remapping of an attribute field to a relationship -- this is niche, but sometimes quite useful. The above PR and its tests failed to fully realize that goal by missing one small detail (lost in a merge conflict resolution, as it turns out).

Full Changelog: https://github.com/beam-community/jsonapi/compare/1.6.0...1.6.1

1.6.0 (2023-06-12)

What's Changed

• Add support for a JSON:API includes allowlist. by @mattpolzin in beam-community#292

Full Changelog: https://github.com/beam-community/jsonapi/compare/1.5.1...1.6.0

1.5.1 (2023-05-19)

What's Changed

• Change camelize behavior by @TylerPachal in beam-community#293

Specifically, already-camilized strings will no longer be turned to all-lowercase by the :camelize transformation; they will be left alone.

Full Changelog: https://github.com/beam-community/jsonapi/compare/1.5.0...1.5.1

1.5.0 (2023-01-25)

What's Changed

Improvements

• Integration between UnderscoreParameters and QueryParser by @TylerPachal in beam-community#282
• Response body for content type error by @TylerPachal in beam-community#276
• Fix typos by @kianmeng in beam-community#275
• Add c:JSONAPI.View.get_field/3 by @whatyouhide in beam-community#273
• Support renaming of relationships by @mattpolzin in beam-community#270

New Contributors

• @kianmeng made their first contribution in beam-community#275
• @whatyouhide made their first contribution in beam-community#273
• @TylerPachal made their first contribution in beam-community#276

Full Changelog: https://github.com/beam-community/jsonapi/compare/1.4.0...v1.5.0

1.4.0 (2022-11-05)

Full Changelog: https://github.com/beam-community/jsonapi/compare/1.3.0...v1.4.0

1.3.0 (2020-03-21)

Added

• Add Deserializer Plug

Changed

• Continuous Integration with Github actions.
• "self" URL can include query parameters

Contributors

A healthy Covid-19 safe foot-tap to: @CostantiniMatteo, @lucacorti, @snewcomer, and @jherdman

1.2.3 (2020-01-28)

Added

N/A

Changed

• Fixed documentation typo
• Added query parameters to links
• Added installation instructions

Contributors

Big ups to @jgelens, @komlanvi, @ryanlabouve

1.2.2 (2019-09-28)

Added

N/A

Changed

• Removed Elixir 1.5 from the Build Matrix
• Fixed underscoring camelCase params

1.2.1 (2019-06-27)

Added

N/A

Changed

• Updated example pagination code
• Fixed sparse fieldset compliance for relationships
• Error status codes in error responses should be Strings
• Fixed a problem with "self" pagination link

Contributors

A fist bump of appreciation to @lucacorti, @leepfrog, @jasondew, and @thebrianemory.

1.2.0 (2019-04-29)

Added

• Pagination has had a massive overhaul. Docs have been updated. Please file issues should you run into any problems. You may wish to review the pull request for more details.
• More typespecs
• EnsureSpec Plug now sets the JSON:API response content type for you. This means you need not manually include the ResponseContentType Plug in your pipeline should you already have EnsureSpec in play. Please see the documentation for ResponseContentType should you wish to override it for a specific end-point.

Changed

• Ex Doc was updated to leverage some of its fancy new features.
• EnsureSpec pipeline checks to ensure that a PATCH request has an ID
• Documentation improvements

Contributors

Much love to: @0urobor0s, @kbaird, @lucacorti, @strzibny

1.1.0 (2019-02-23)

Added

• Various typespec changes
• The :namespace option is globally configurable
• Fully support sparse fieldsets

Changed

• Removed Config.required_fields
• Documentation improvements

Fixes

• Credo is set to use strict option
• FormatRequired Plug accepts a legal RIO payload
• Report on missing data type as such

Contributors

Much love to @kbaird, and @zamith.

1.0.0 (2019-01-27)

Hot on the heels of 0.9.0, 1.0.0 is here! Please remember to upgrade to 0.9.0 first. You'll find the upgrade path much easier.

• Added run Dialyzer on CI
• Fixed bad includes result in HTTP 500 response
• Removed all deprecated code
• Added camelCase field support for JSON:API v1.1
• Added support for arbitrary links
• Added Elixir 1.8 to the build matrix

0.9.0 (2019-01-18)

This is the last release before 1.0. As such this release will feature a number of deprecations that you'll want to either resolve before upgrading. Should you have any trouble with these deprecations please file an issue.

• Added Expand Build Matrix Again
• Added Refactor String Manipulation Utility Module
• Internal Move QueryParser Test
• Added Expand Build Matrix
• Added Add Plug to Transform Parameters
• Fixed Namespace Deprecation module
• Internal Consolidate Plug Locations
• Fixed Set Content-Type for errors
• Internal Improve Application.env handling in tests
• Fixed Update regexes for underscore and dash
• Internal Remove leading is_ from is_data_loaded?
• Fixed Remove warning about hidden being undefined
• Added Allows for conditionally hiding fields
• Fixed Omit non-Object meta

v0.7.0-0.8.0 (2018-06-13)

(Sorry I missed 0.7.0)

• Added Support for configuring your JSON Library, and defaulted to Jason going forward.
• Fixed Fix nesting for includes
• Added Removing Top Level if configured
• Fixed Check headers according to spec
• Added Add to view custom attribute
• Added updates plug to allow data with only relationships enhancement
• Added include meta as top level document member
• Added Apply optional dash-to-underscore to include keys
• Fixed Do not build relationships section for not loaded relationships
• Fixed change try/rescue to function_exported? and update docs
• Fixed Dasherize keys in relationship urls
• Added Allows the view to add links
• Fixed Serialize empty relationship
• Fixed Handle dashed include for top-level relationship

v0.6.0 (2017-11-17)

• Added Optional Data Links.
• Added Paging Support
• Added Option to replace underscores with dahses

v0.5.1 (2017-07-07)

• Added plug to make verifying requests and their errors easier

v0.5.0 (2017-07-07)

• Added support for meta fields
• Added support for custom hosts
• Added support for hidden attributes in views
• Added support conversion of underscore to dashes.
• Fixed issue with index.json
• Now uses Credo

v0.4.2 (2017-04-17)

• Updated codebase for elixir 1.4
• Updated poison dep to 3.0
• Fixed failing travis tests

v0.4.0 (2016-12-02)

• Removed PhoenixView

v0.1.0 (2015-06-?)

• Made params optional

v0.0.2 (2015-06-22)

• Made paging optional

v0.0.1 (2015-06-21)

• Support for basic JSONAPI Docs. Links support still missing