improvement: add installers & extenders

improvement: automatically infer the `prefix` instead of relying on configuration

and use it always since its never wrong, preventing a common class of misconfigurations.

Author: zachdaniel

.tool-versions

@@ -1,2 +1,2 @@
-erlang 26.0.2
-elixir 1.15.4
+erlang 27.0.1
+elixir 1.17.2-otp-27

documentation/topics/open-api.md

@@ -126,6 +126,11 @@ mix openapi.spec.json --spec MyAppWeb.AshJsonApi
 mix openapi.spec.yaml --spec MyAppWeb.AshJsonApi
 ```
 
+> ### Setting a route prefix for generated files {: .warning}
+>
+> The route prefix in normal usage is automatically inferred, but when generating files
+> we will use the `prefix` option set in the `json_api` section of the relevant `Ash.Domain` module.
+
 To generate the YAML file you need to add the ymlr dependency.
 
 ```elixir
@@ -136,6 +141,13 @@ def deps do
 end
 ```
 
+You can also use the `--check` option to confirm that your checked in spec file(s) match.
+
+```sh
+mix openapi.spec.json --spec MyAppWeb.AshJsonApi --check
+mix openapi.spec.yaml --spec MyAppWeb.AshJsonApi --check
+```
+
 ## Known issues/limitations
 
 ### Swagger UI

documentation/tutorials/getting-started-with-ash-json-api.md

@@ -105,10 +105,6 @@ Add the following to your `config/config.exs`.
 config :mime, :types, %{
   "application/vnd.api+json" => ["json"]
 }
-
-config :mime, :extensions, %{
-  "json" => "application/vnd.api+json"
-}
 ```
 
 This configuration is required to support working with the JSON:API custom mime type.

lib/ash_json_api/controllers/delete.ex

@@ -16,7 +16,7 @@ defmodule AshJsonApi.Controllers.Delete do
     all_domains = options[:all_domains]
 
     conn
-    |> Request.from(resource, action, domain, all_domains, route)
+    |> Request.from(resource, action, domain, all_domains, route, options[:prefix])
     |> Helpers.destroy_record()
     |> Helpers.fetch_includes()
     |> Helpers.fetch_metadata()

lib/ash_json_api/controllers/delete_from_relationship.ex

@@ -41,7 +41,7 @@ defmodule AshJsonApi.Controllers.DeleteFromRelationship do
     end
 
     conn
-    |> Request.from(options[:resource], action, domain, all_domains, route)
+    |> Request.from(options[:resource], action, domain, all_domains, route, options[:prefix])
     |> Helpers.update_record(&Helpers.resource_identifiers(&1, argument))
     |> Helpers.fetch_metadata()
     |> Helpers.render_or_render_errors(conn, fn conn, request ->

lib/ash_json_api/controllers/generic_action_route.ex

@@ -16,7 +16,7 @@ defmodule AshJsonApi.Controllers.GenericActionRoute do
     all_domains = options[:all_domains]
 
     conn
-    |> Request.from(resource, action, domain, all_domains, route)
+    |> Request.from(resource, action, domain, all_domains, route, options[:prefix])
     |> Helpers.run_action()
     |> Helpers.render_or_render_errors(conn, fn conn, request ->
       status =

lib/ash_json_api/controllers/get.ex

@@ -16,7 +16,7 @@ defmodule AshJsonApi.Controllers.Get do
     all_domains = options[:all_domains]
 
     conn
-    |> Request.from(resource, action, domain, all_domains, route)
+    |> Request.from(resource, action, domain, all_domains, route, options[:prefix])
     |> Helpers.fetch_record_from_path()
     |> Helpers.fetch_includes()
     |> Helpers.fetch_metadata()

lib/ash_json_api/controllers/get_related.ex

@@ -17,7 +17,7 @@ defmodule AshJsonApi.Controllers.GetRelated do
     all_domains = options[:all_domains]
 
     conn
-    |> Request.from(resource, action, domain, all_domains, route)
+    |> Request.from(resource, action, domain, all_domains, route, options[:prefix])
     |> Helpers.fetch_related(options[:resource])
     |> Helpers.fetch_includes()
     |> Helpers.fetch_metadata()

lib/ash_json_api/controllers/get_relationship.ex

@@ -17,7 +17,7 @@ defmodule AshJsonApi.Controllers.GetRelationship do
     resource = relationship.destination
 
     conn
-    |> Request.from(resource, action, domain, all_domains, route)
+    |> Request.from(resource, action, domain, all_domains, route, options[:prefix])
     |> Helpers.fetch_related(options[:resource])
     |> Helpers.fetch_metadata()
     |> Helpers.render_or_render_errors(conn, fn conn, request ->

lib/ash_json_api/controllers/index.ex

@@ -17,7 +17,7 @@ defmodule AshJsonApi.Controllers.Index do
 
     if action.type == :read do
       conn
-      |> Request.from(resource, action, domain, all_domains, route)
+      |> Request.from(resource, action, domain, all_domains, route, options[:prefix])
       |> Helpers.fetch_pagination_parameters()
       |> Helpers.fetch_records()
       |> Helpers.fetch_includes()
@@ -33,7 +33,7 @@ defmodule AshJsonApi.Controllers.Index do
       end)
     else
       conn
-      |> Request.from(resource, action, domain, all_domains, route)
+      |> Request.from(resource, action, domain, all_domains, route, options[:prefix])
       |> Helpers.fetch_records()
       |> Helpers.fetch_includes()
       |> Helpers.fetch_metadata()