Search
Phoenix API Toolkit
v3.1.2
v3.1.1
v3.1.0
v3.0.1
v3.0.0
v2.1.1
v2.0.0
v1.8.0
v1.7.0
v1.6.0
v1.5.0
v1.4.0
v1.3.0
v1.2.0
v1.1.0
v1.0.0
v0.16.0
v0.15.0
v0.14.0
v0.13.0
v0.12.0
v0.12.0-beta.2
v0.12.0-beta.1
v0.11.0
v0.10.0
v0.9.1
v0.9.0
v0.8.0
v0.7.0
v0.6.0
v0.5.0
v0.4.1
v0.4.0
v0.3.0
v0.2.0-alpha
v0.1.0
Pages
Modules
PhoenixApiToolkit.CacheBodyReader
Summary
Functions
cache_and_read_body/2
get_raw_request_body/1
PhoenixApiToolkit.Ecto.DynamicFilters
Sections
Example without standard filters
Example with standard filters and autogenerated docs
Generating documentation
Filter key types
Equal-to filters
Equal-to-any filters
Smaller-than filters
Greater-than-or-equal-to filters
String-starts-with filters
String-contains filters
List-contains filters
List-contains-any filters
List-contains-all filters
Order-by sorting
Limit filter
Offset filter
Filter-by-function filters
Summary
Types
extra_filter_definitions/0
filter/0
filter_definition/0
filter_definitions/0
Functions
generate_filter_docs/2
standard_filters/6
PhoenixApiToolkit.Ecto.Validators
Sections
Examples
Summary
Functions
default_change/3
map_if_valid/3
move_change/4
multifield_apply/3
validate_ilike_safe/2
validate_order_by/2
validate_plaintext/2
validate_searchable/4
validate_upload/3
validate_upload/4
PhoenixApiToolkit.GenericRequestValidator
Summary
Types
schema/0
Functions
get_entity_fields/1
path_param/1
query_order_by/3
query_pagination/4
resource_schema/2
PhoenixApiToolkit.Security.HmacPlug
Sections
Configuration options
Request body format example
Examples
PhoenixApiToolkit.Security.Oauth2Plug
Sections
Usage example
Results examples
Summary
Functions
process_jwks/1
PhoenixApiToolkit.Security.Plugs
Summary
Functions
ajax_csrf_protect/2
put_security_headers/2
require_content_type/2
set_forwarded_ip/2
verify_oauth2_aud/2
verify_oauth2_scope/2
PhoenixApiToolkit.TestHelpers
Summary
Types
gen_jwt_defaults/0
gen_jwt_opts/0
Functions
application_json/1
clean_volatile_fields/1
create_hmac_plug_body/4
gen_jwk/1
gen_jws/1
gen_jwt/2
gen_payload/1
put_ajax_csrf_header/1
put_hmac/3
put_jwt/2
put_query_params/2
put_raw_body/2
test_jwks/0
to_string_map/1
Exceptions
PhoenixApiToolkit.Security.AjaxCSRFError
PhoenixApiToolkit.Security.HmacVerificationError
PhoenixApiToolkit.Security.MissingContentTypeError
PhoenixApiToolkit.Security.Oauth2TokenVerificationError
Settings
View Source
PhoenixApiToolkit.Security.Oauth2TokenVerificationError
exception
(Phoenix API Toolkit v3.1.2)
Error raised when an Oauth2 token is invalid
×