ash_json_api
▼
Project version
v1.4.30
v1.4.29
v1.4.28
v1.4.27
v1.4.26
v1.4.25
v1.4.24
v1.4.23
v1.4.22
v1.4.21
v1.4.20
v1.4.19
v1.4.18
v1.4.17
v1.4.16
v1.4.15
v1.4.13
v1.4.12
v1.4.11
v1.4.10
v1.4.9
v1.4.8
v1.4.7
v1.4.6
v1.4.5
v1.4.4
v1.4.3
v1.4.2
v1.4.1
v1.4.0
v1.3.8
v1.3.7
v1.3.6
v1.3.5
v1.3.4
v1.3.3
v1.3.2
v1.3.1
v1.3.0
v1.2.2
v1.2.1
v1.2.0
v1.1.2
v1.1.1
v1.1.0
v1.0.0
v1.0.0-rc.6
v1.0.0-rc.5
v1.0.0-rc.4
v1.0.0-rc.3
v1.0.0-rc.2
v1.0.0-rc.1
v1.0.0-rc.0
v0.34.2
v0.34.1
v0.34.0
v0.33.1
v0.33.0
v0.32.1
v0.32.0
v0.31.3
v0.31.2
v0.31.1
v0.31.0
v0.30.1
v0.30.0-rc.4
v0.30.0-rc.3
v0.30.0-rc.2
v0.30.0-rc.1
v0.30.0-rc.0
v0.29.1
v0.29.0
v0.28.6
v0.28.5
v0.28.4
v0.28.3
v0.28.2
v0.28.1
v0.28.0
v0.27.6
v0.27.5
v0.27.1
v0.27.0
v0.25.0
v0.24.4
v0.24.2
v0.24.1
v0.24.0
v0.23.0
v0.22.0
v0.21.0
v0.20.0
v0.19.0
v0.18.0
v0.17.0
v0.16.0
v0.15.0
v0.14.0
v0.13.0
v0.12.0
v0.11.1
v0.10.0
v0.9.0
v0.8.0
v0.6.0
v0.5.0
v0.4.0
v0.3.0
v0.2.4
v0.2.3
v0.2.1
v0.2.0
v0.1.5
v0.1.4
v0.1.3
v0.1.2
v0.1.1
v0.1.0
Pages
Modules
Mix
Tasks
API Reference
Modules
Mix Tasks
Home
Tutorials
Topics
Reference
Tutorials
Getting started with AshJsonApi
Installing AshJsonApi
Configure your Resources and Domain and expose actions
Define Routes
Run your API
Open API
Topics
What is AshJsonApi
Non-Spec query parameters
filter_included
sort_included
field_inputs
Open API
Use with Phoenix
Use with Plug
Customize values in the OpenAPI documentation
Generate spec files via CLI
Using this file in production
Known issues/limitations
Relationships
Relationship Manipulation Routes
Links
Self links to routes
Pagination links on index routes
Self links on individual entities
Related links
Upgrading to AshJsonApi to 1.0
Errors
Relationship Routes
Ash.Api is now Ash.Domain in Ash 3.0
Authorize with AshJsonApi
Setting the actor manually
Authenticating with AshJsonApi
The route
DSLs
AshJsonApi.Resource
json_api
AshJsonApi.Domain
json_api
About AshJsonApi
Change Log
v1.4.30 (2025-04-29)
v1.4.29 (2025-04-21)
v1.4.28 (2025-04-15)
v1.4.27 (2025-04-11)
v1.4.26 (2025-04-11)
v1.4.25 (2025-04-11)
v1.4.24 (2025-04-09)
v1.4.23 (2025-03-25)
v1.4.22 (2025-03-19)
v1.4.21 (2025-03-18)
v1.4.20 (2025-03-11)
v1.4.19 (2025-02-11)
v1.4.18 (2025-01-29)
v1.4.17 (2025-01-27)
v1.4.16 (2024-12-23)
v1.4.15 (2024-12-20)
v1.4.14 (2024-11-24)
v1.4.13 (2024-11-04)
v1.4.12 (2024-10-21)
v1.4.11 (2024-10-14)
v1.4.10 (2024-10-10)
v1.4.9 (2024-09-27)
v1.4.8 (2024-09-16)
v1.4.7 (2024-09-04)
v1.4.6 (2024-08-26)
v1.4.5 (2024-08-20)
v1.4.4 (2024-08-16)
v1.4.3 (2024-08-08)
v1.4.2 (2024-08-08)
v1.4.1 (2024-07-30)
v1.4.0 (2024-07-30)
v1.3.8 (2024-07-22)
v1.3.7 (2024-07-15)
v1.3.6 (2024-07-08)
v1.3.5 (2024-07-06)
v1.3.4 (2024-07-05)
v1.3.3 (2024-07-04)
v1.3.2 (2024-07-02)
v1.3.1 (2024-07-01)
v1.3.0 (2024-06-28)
v1.2.2 (2024-06-19)
v1.2.1 (2024-06-18)
v1.2.0 (2024-06-11)
v1.1.2 (2024-06-05)
v1.1.1 (2024-06-05)
v1.1.0 (2024-05-24)
v1.0.0
AshJsonApi
AshJsonApi
Summary
Functions
authorize?/1
log_errors?/1
prefix/1
router/1
serve_schema?/1
AshJsonApi.Domain
Summary
Functions
install/5
json_api/1
AshJsonApi.Resource
Summary
Functions
base_route/1
encode_primary_key/1
includes/1
install/5
json_api/1
only_primary_key?/2
primary_key_delimiter/1
primary_key_fields/1
route/3
routes/2
type/1
AshJsonApi.Router
Sections
Customizing request handling
Utilities
AshJsonApi.OpenApi
Sections
Example
Summary
Functions
define_filter?/2
paths/3
raw_filter_type/2
resource_filter_fields_fields_only/1
responses/0
schemas/1
spec/2
tags/1
tags/2
write_attributes/5
AshJsonApi.Test
Sections
Making Requests
Summary
Functions
assert_data_equals/2
assert_data_matches/2
assert_has_error/2
assert_has_matching_include/2
delete/3
get/3
multipart_post/4
patch/4
post/4
refute_has_matching_include/2
Introspection
AshJsonApi.Domain.Info
Summary
Functions
authorize?/1
group_by/1
include_nil_values?/1
log_errors?/1
prefix/1
router/1
routes/1
serve_schema?/1
show_raised_errors?/1
tag/1
AshJsonApi.Resource.Info
Summary
Functions
base_route/1
default_fields/1
derive_filter?/1
derive_sort?/1
include_nil_values?/1
includes/1
primary_key_delimiter/1
primary_key_fields/1
routes/2
type/1
AshJsonApi.Resource.Route
Summary
Types
t/0
Errors
AshJsonApi.Error
Summary
Types
t/0
Functions
class_to_status/1
format_log/1
new/1
to_json_api_errors/4
with_source_pointer/4
AshJsonApi.Error.InvalidBody
Summary
Functions
exception/1
AshJsonApi.Error.InvalidField
Summary
Functions
exception/1
AshJsonApi.Error.InvalidHeader
Summary
Functions
exception/1
AshJsonApi.Error.InvalidIncludes
Summary
Types
t/0
Functions
exception/1
AshJsonApi.Error.InvalidPagination
Summary
Functions
exception/1
AshJsonApi.Error.InvalidQuery
Summary
Functions
exception/1
AshJsonApi.Error.InvalidType
Summary
Functions
exception/1
AshJsonApi.Error.NotFound
Summary
Functions
exception/1
AshJsonApi.Error.UnacceptableMediaType
Summary
Functions
exception/1
AshJsonApi.Error.UnsupportedMediaType
Summary
Functions
exception/1
AshJsonApi.ToJsonApiError
Sections
Example
Summary
Types
t/0
Functions
to_json_api_error/1
Internals
AshJsonApi.Domain.BaseRoute
AshJsonApi.Domain.Verifiers.VerifyActions
AshJsonApi.Domain.Verifiers.VerifyHasType
AshJsonApi.Domain.Verifiers.VerifyQueryParams
AshJsonApi.Domain.Verifiers.VerifyRelationships
Summary
Functions
verify/1
AshJsonApi.Igniter
Summary
Functions
ash_json_api_routers/1
find_ash_json_api_router/2
setup_ash_json_api_router/2
setup_phoenix/2
setup_routes_alias/1
AshJsonApi.Plug.Parser
Sections
Examples
Protocol
Example HTTP Message
AshJsonApi.Resource.Verifiers.VerifyActions
AshJsonApi.Resource.Verifiers.VerifyHasType
AshJsonApi.Resource.Verifiers.VerifyIncludes
AshJsonApi.Resource.Verifiers.VerifyQueryParams
AshJsonApi.Resource.Verifiers.VerifyRelationships
Summary
Functions
verify/1
AshJsonApi.Type
Summary
Callbacks
json_schema/1
json_write_schema/1
Internals
mix ash_json_api.install
Summary
Functions
igniter/2
mix ash_json_api.routes
Summary
Functions
get_url_info/2
Search documentation of ash_json_api
Settings
AshJsonApi.Domain.Verifiers.VerifyQueryParams
(ash_json_api v1.4.30)
View Source
Verify query params are not reserved or shadowed by the route