Changelog

July 28, 2026 · View on GitHub

1.25.0

#418
- Support nested usage of JsonApiClient::Resource.with_headers

1.24.0

#416
- Relax faraday-gzip upper bound

1.23.0

#412
- Add support for faraday 2.x
- Drop support for Ruby < 3.0 (EOL)
- Drop support for activesupport < 6.0 (EOL)
- Remove deprecated faraday_middleware and add faraday-gzip (from #402)
#400 - Fix for multi-word custom endpoint and route format

1.22.0

#403 - Feature: Use the association options to lookup relationship class
#406 - Deep-merge nested additional_params

1.21.1

#404 - Expose NotFound json errors
#378 - Add the ability to create a subclass of JsonApiClient::Resource to have a modified id method

1.21.0

#395 - relaxing faraday dependency to anything less than 2.0

1.20.0

#389 - adding create!, update_attributes!, update! methods

1.19.0

#382 - Add extra error classes to hande server errors.
#386 - use HashWithIndifferentAccess

1.18.0

#372 - Fix handling of dashed-types associations correctly

1.17.1

#370 - bigdecimal 2 support

1.17.0

#364 - Relax faraday and faraday middleware versions

1.16.1

#361 - Call super from inherited method so that it will execute parent classes' implementations

1.16.0

#359 - Support gzip content encoding

1.15.0

#346 - add the option to have immutable resources
#357 - fix missing constant formatter

1.14.1

#353 - fix to support deserializing resources with relationships without those related resources being included in the response (issue #352).

1.14.0

#338 - implement hash and eql? for builder class
#351 - Remove rudimental last_result_set relationship from serializer

1.13.0

#348 - add NestedParamPaginator to address inconsistency in handling of pagination query string params (issue #347).

1.12.2

#350 - fix resource including with blank relationships response data

1.12.1

#349 - fix resource including for STI objects

1.12.0

#345 - track the real HTTP reason of ApiErrors

1.11.0

#344 - introduce safe singular resource fetching with raise_on_blank_find_param resource setting

1.10.0

#335 - access to assigned relationship

1.9.0

#328 - allow custom type for models
#326 - correct changes after initialize resource
- remove type from changes on initialize
- ensure that query builder doesn't propagate query values to resource attributes via #build method
#324 - add possibility to override status handling
- add status_handlers to JsonApiClient::Resource.connection_options
#330 - deletion use overridden primary key

1.8.0

#316 - Allow custom error messages
#305 - optional search relationship data in result set

1.7.0

#320 - fix passing relationships on create
- fix relationships passing to new and create methods
- fix false positive tests on create
- refactor tests on create/update to prevent false same positive tests in future
#315 - add shallow_path feature to belongs_to

add shallow_path options to belongs_to to use model w/ and w/o nesting in parent resource

v1.6.4

#314 - Mimic ActiveRecord behavior when destroying a resource:
- Add destroyed? method
- Do not clear resource attributes
- Return false on persisted? after being destroyed
- Return false on new_record? after being destroyed

v1.6.3

#312 - Don't raise on 422

v1.6.2

#311 - Raise JsonApiClient::Errors::ClientError for unhandled 4xx responses

v1.6.1

#297 - Fix test_helper
#298 - README update: arguments for custom connections run method
#306 - README update: pagination override examples
#307 - Symbolize params keys on model initialize
#304 - Optional add default to changes
#300 - Define methods for properties and associations getter/setter

v1.6.0

#281 - Optimize dynamic attribute deref
#280 - Fix custom headers inheritance
#287 - Allow pagination params to be nil
#284 - Fix filter to not filter out [] values
#285 - Add include params for create/update
#293 - Fix side-effects in scopes

v1.5.3

#266 - Fix default attributes being overridden
#267 - Fix custom pagination params
#271 - Fix assert_nil warnings
#275 - Add error messages when destroy fails
#277 - Correct handling of error source/pointer

v1.5.2

#264 - Enable sparse fieldsets for nested models
#263 - Fix initializing resource including relationships
#260 - Use formatter for belongs_to keys

v1.5.1

#236 - Escape nested route keys

v1.5.0

#239 - Configurable pagination params
#238 - Parse links after creating a resource
#230 - Unformat error source parameters via key formatter.
#228 - All schema types to be pluggable.

v1.4.0

#217 - Add decimal (BigDecimal) as a serializing type
#222 - Add last method for a resource and scope (similar to first)

v1.3.0

#208 - Fall back to error.detail for the error message #196
#206 - Autoload JsonApiClient::VERSION constant
#205 - RelationshipLinker now correctly uses the resource class' KeyFormatter
#203 - No longer raise KeyError when trying to paginate to a page that doesn't exist. Return nil instead

v1.2.0

#201 - Configurable key and path formatter on a per-resource basis
#190 - Allow hook for overriding the total_entries method on the default paginator
#199 - Clean up test warnings
#198 - Clean up test warnings
#187 - README update and cleanup around select for Query::Builder
#191 - Don't explode when parsing "data": null
#183 - select for Query::Builder can accept strings, symbols, arrays
#181 - Handle HTTP 409 - Conflict error

v1.1.1

#163 - Handle faraday connection options (proxy, ssl, etc)
#165 - Handle null data returned for associated resources

v1.1.0

#159 - Alias update method as update_attributes
#160 - Add .with_params to add arbitrary query params on find
#161 - Fixes pagination issues: #142 and #150
#162 - Fix faraday version dependency to ~> 0.9

v1.0.2

#152 - Pass rebuild flag to _build_connection
#140 - Handle 401 Not Authorized responses
#137 - Support for validation contexts

v1.0.1

#135 - Added support for common boolean typecasting
#119 - property should not add default value if default is nil
#129 - Resource save does not update anything but attributes
#131 - Handle error values explicitly set to null.

v1.0.0

initial release for 1.0 spec