[#2456] OpenAPI-related tweaks. Removed support for `with_relationships` param in...

[akkoma] / lib / pleroma / web / controller_helper.ex

diff --git a/lib/pleroma/web/controller_helper.ex b/lib/pleroma/web/controller_helper.ex
index ff94c6be0a524db62fd990b17b08e00660365e1f..5a1316a5f166f5871be0cb75e059de9299f96735 100644 (file)
--- a/lib/pleroma/web/controller_helper.ex
+++ b/lib/pleroma/web/controller_helper.ex
@@ -104,8 +104,16 @@ defmodule Pleroma.Web.ControllerHelper do
 
   def put_if_exist(map, key, value), do: Map.put(map, key, value)
 
-  def with_relationships?(params) do
-    # To do: change to `truthy_param?(params["with_relationships"])` once PleromaFE supports it
-    not explicitly_falsy_param?(params["with_relationships"])
+  @doc """
+  Returns true if request specifies to include embedded relationships in account objects.
+  May only be used in selected account-related endpoints; has no effect for status- or
+    notification-related endpoints.
+  """
+  # Intended for PleromaFE: https://git.pleroma.social/pleroma/pleroma-fe/-/issues/838
+  def embed_relationships?(params) do
+    # To do once OpenAPI transition mess is over: just `truthy_param?(params[:with_relationships])`
+    params
+    |> Map.get(:with_relationships, params["with_relationships"])
+    |> truthy_param?()
   end
 end