Merge branch 'fix/reverse-proxy-no-body-connection-leak' into 'develop'

[akkoma] / lib / pleroma / web / api_spec / helpers.ex

diff --git a/lib/pleroma/web/api_spec/helpers.ex b/lib/pleroma/web/api_spec/helpers.ex
index 859e45b57ed67fc2069e82788e863f230ebbd4c8..2a7f1a706bc737d1ed829fb6bf7d1c3bf015acf1 100644 (file)
--- a/lib/pleroma/web/api_spec/helpers.ex
+++ b/lib/pleroma/web/api_spec/helpers.ex
@@ -29,6 +29,10 @@ defmodule Pleroma.Web.ApiSpec.Helpers do
     }
   end
 
+  def admin_api_params do
+    [Operation.parameter(:admin_token, :query, :string, "Allows authorization via admin token.")]
+  end
+
   def pagination_params do
     [
       Operation.parameter(:max_id, :query, :string, "Return items older than this ID"),
@@ -39,6 +43,12 @@ defmodule Pleroma.Web.ApiSpec.Helpers do
         :string,
         "Return the newest items newer than this ID"
       ),
+      Operation.parameter(
+        :offset,
+        :query,
+        %Schema{type: :integer, default: 0},
+        "Return items past this number of items"
+      ),
       Operation.parameter(
         :limit,
         :query,
@@ -49,7 +59,12 @@ defmodule Pleroma.Web.ApiSpec.Helpers do
   end
 
   def with_relationships_param do
-    Operation.parameter(:with_relationships, :query, BooleanLike, "Include relationships")
+    Operation.parameter(
+      :with_relationships,
+      :query,
+      BooleanLike,
+      "Embed relationships into accounts."
+    )
   end
 
   def empty_object_response do
@@ -59,4 +74,8 @@ defmodule Pleroma.Web.ApiSpec.Helpers do
   def empty_array_response do
     Operation.response("Empty array", "application/json", %Schema{type: :array, example: []})
   end
+
+  def no_content_response do
+    Operation.response("No Content", "application/json", %Schema{type: :string, example: ""})
+  end
 end