Behaviour for customizing OpenAPI spec generation.

Implement this behaviour to add custom security schemes, feature flags, domain filtering, or any post-processing to generated specs.

Example

defmodule MyApp.OpenApi.SpecBuilder do
  @behaviour AshOaskit.SpecBuilder

  @impl true
  def spec(openapi_version, opts) do
    AshOaskit.spec(
      domains: opts[:domains],
      version: openapi_version,
      title: opts[:title],
      api_version: opts[:version]
    )
    |> add_security_schemes()
    |> add_feature_flags()
  end

  defp add_security_schemes(spec) do
    put_in(spec, ["components", "securitySchemes"], %{
      "bearerAuth" => %{
        "type" => "http",
        "scheme" => "bearer",
        "bearerFormat" => "JWT"
      }
    })
  end

  defp add_feature_flags(spec) do
    Map.put(spec, "x-features", %{"beta" => true})
  end
end

Usage with Router

use AshOaskit.Router,
  spec_builder: MyApp.OpenApi.SpecBuilder,
  open_api: "/openapi",
  title: "My API",
  domains: [MyApp.Blog]  # Passed to spec_builder