Packages
ash_json_api
1.3.3
1.7.1
1.7.0
1.6.6
1.6.5
1.6.4
1.6.3
1.6.2
1.6.1
1.6.0-rc.2
1.6.0-rc.1
1.6.0-rc.0
1.5.1
1.5.0
1.4.45
1.4.44
1.4.43
1.4.42
1.4.41
1.4.40
1.4.39
1.4.38
1.4.37
1.4.36
1.4.35
1.4.34
1.4.33
1.4.32
1.4.31
1.4.30
1.4.29
1.4.28
1.4.27
1.4.26
1.4.25
1.4.24
1.4.23
1.4.22
1.4.21
1.4.20
1.4.19
1.4.18
1.4.17
1.4.16
1.4.15
1.4.13
1.4.12
1.4.11
1.4.10
1.4.9
1.4.8
1.4.7
1.4.6
1.4.5
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.3.8
1.3.7
1.3.6
1.3.5
1.3.4
retired
1.3.3
1.3.2
1.3.1
1.3.0
1.2.2
1.2.1
1.2.0
1.1.2
1.1.1
1.1.0
1.0.0
1.0.0-rc.6
1.0.0-rc.5
1.0.0-rc.4
1.0.0-rc.3
1.0.0-rc.2
1.0.0-rc.1
1.0.0-rc.0
0.34.2
0.34.1
0.34.0
0.33.1
0.33.0
0.32.1
0.32.0
0.31.3
0.31.2
retired
0.31.1
0.31.0
0.30.1
0.30.0-rc.4
0.30.0-rc.3
0.30.0-rc.2
0.30.0-rc.1
0.30.0-rc.0
0.29.1
0.29.0
0.28.6
0.28.5
0.28.4
0.28.3
0.28.2
0.28.1
0.28.0
0.27.6
0.27.5
0.27.1
0.27.0
0.25.0
0.24.4
0.24.2
0.24.1
0.24.0
0.23.0
0.22.0
0.21.0
0.20.0
0.19.0
0.18.0
0.17.0
0.16.0
0.15.0
0.14.0
0.13.0
0.12.0
0.11.1
0.10.0
0.9.0
0.8.0
0.6.0
0.5.0
0.4.0
0.3.0
0.2.4
0.2.3
0.2.1
0.2.0
0.1.5
0.1.4
0.1.3
0.1.2
0.1.1
0.1.0
The JSON:API extension for the Ash Framework.
Current section
Files
Jump to
Current section
Files
ash_json_api
CHANGELOG.md
CHANGELOG.md
# Change Log
All notable changes to this project will be documented in this file.
See [Conventional Commits](Https://conventionalcommits.org) for commit guidelines.
<!-- changelog -->
## [v1.3.3](https://github.com/ash-project/ash_json_api/compare/v1.3.2...v1.3.3) (2024-07-04)
### Bug Fixes:
* ensure generic action bodies, both in & out are serialized properly
* properly fetch nested types
* show embedded types when used with `:struct`
* ensure `action.require_attributes` is stringified in json schema
* honor resource-level default_fields
## [v1.3.2](https://github.com/ash-project/ash_json_api/compare/v1.3.1...v1.3.2) (2024-07-02)
### Bug Fixes:
* properly require `success` in return-less actions
* typo when checking for resource's derive_filter? flag
* ensure that context is threaded through for all actions
* not all accepted attributes have to be public
* fix sort regex to be a valid regex
* don't use `anyOf` for nullability
* don't generate bodies for delete requests
* use `Enum.uniq` when uwnrapping any_of types
* detect all cases where a filter must be generated
### Improvements:
* use empty example for filter
* support for query parameters using `query_params` route option
## [v1.3.1](https://github.com/ash-project/ash_json_api/compare/v1.3.0...v1.3.1) (2024-07-01)
### Bug Fixes:
* use strings for enum values
* use `strings` for includes/sort properly, add regex for sort
## [v1.3.0](https://github.com/ash-project/ash_json_api/compare/v1.2.2...v1.3.0) (2024-06-28)
### Features:
- [calculations] add support for calculation inputs via field_inputs query param (#187)
- [routes] support generic actions with no returns in routes
- [routes] support `modify_conn/4`
- [routes] support `:read` actions in `:post` request
- [routes] generic action support for all basic route types
- [routes] new `route/3` type for arbitrary generic actions
- [AshJsonApi.Resource] support `derive_filter?` on both resource and route level
- [AshJsonApi.Resource] support `derive_sort?` on both resource and route level
### Improvements:
- [OpenApi] implement `Ash.Type.Map` json schema
- [OpenApi] support unions in schemas
- [OpenApi] use "any object" type for filter in json schema
- [OpenApi] fully specify filter in open api schema
- [OpenApi] show all sortable fields in json schema
- [OpenApi] Use resource descriptions in generated schema files if present (#184)
- [OpenApi] show embeds in json schema and openapi
- [errors] Add defimpl for NoSuchInput error (#181)
## [v1.2.2](https://github.com/ash-project/ash_json_api/compare/v1.2.1...v1.2.2) (2024-06-19)
### Bug Fixes:
- [include] properly still perform includes on record fetched from path
### Improvements:
- [OpenApi] newtype/enum support for json_schema as well
- [OpenApi] render enums as enums in open api
## [v1.2.1](https://github.com/ash-project/ash_json_api/compare/v1.2.0...v1.2.1) (2024-06-18)
### Bug Fixes:
- [routes] don't raise error including on get related endpoints
- [routes] validate relationships from routes at compile time
- [errors] don't show exceptions if `show_raised_errors?` is `false`
- [errors] add missing fields from `InvalidField`
- [OpenApi] don't expose `action.name` over api docs
- [AshJsonApi.Domain] resource comes from the route on domains
### Improvements:
- [routes] support `name` on `routes`, use in description and operationId
- [AshJsonApi.Resource] verify includes list at compile time
- [AshJsonApi.Domain] allow setting a `resource` second option on domain's `base_route` entity
## [v1.2.0](https://github.com/ash-project/ash_json_api/compare/v1.1.2...v1.2.0) (2024-06-11)
### Features:
- [AshJsonApi.Domain] add `base_route` constructor to domain router
### Bug Fixes:
- [AshJsonApi.Resource] properly reflect that `default: false` makes a non required attribute
- [AshJsonApi.Resource] non-public attributes can be accepted and required in 3.0
- [AshJsonApi.Resource] support `require_attributes` in json schema
- [AshJsonApi.Resource] ensure that resource-level default_fields are honored
### Improvements:
- [attributes] non-public attributes can be accepted in 3.0
## [v1.1.2](https://github.com/ash-project/ash_json_api/compare/v1.1.1...v1.1.2) (2024-06-05)
### Bug Fixes:
- [includes] ensure we don't drop includes (as a result of deduplicating them)
## [v1.1.1](https://github.com/ash-project/ash_json_api/compare/v1.1.0...v1.1.1) (2024-06-05)
### Bug Fixes:
- [includes] deduplicate includes list while building it
### Improvements:
- [metadata] add ability to supply custom route metadata (#152)
## [v1.1.0](https://github.com/ash-project/ash_json_api/compare/v1.0.0...v1.1.0) (2024-05-24)
### Features:
- [AshJsonApi.Domain] support routes defined on the domain
## [v1.0.0](https://github.com/ash-project/ash_json_api/compare/v1.0.0...v0.34.2)
This changelog has been restarted. See `/documentation/0.x-CHANGELOG.md` for previous changelogs.
### Breaking Changes:
- [AshJsonApi.Resource] relationship routes now depend on the action taking an argument with the same name as the relationship. See the upgrade for more.
- [AshJsonApi.ToJsonApiError] Introduced `AshJsonApi.ToJsonApiError` to convert errors to JSON API errors. This brings it more in line with other Ash extensions.
### Improvements:
- [AshJsonApi.Resource] create/update/destroy actions now use bulk operations
- [AshJsonApi.Router] router is now a dynamic hand-written router. This prevents compile time dependencies.
- [AshJsonApi.Error] honor path when building source pointers