pleroma

commit: 432599311d3aab8829ed2cc7f795a1662e7a8f82
parent bd52e2aec7f07da3bc3609f72f7f1bf5969c9baf
Author: marcin mikołajczak <git@mkljczk.pl>
Date:   Sat,  5 Feb 2022 19:13:30 +0100

Add GET /api/v1/instance/rules

Signed-off-by: marcin mikołajczak <git@mkljczk.pl>

Diffstat:
M
lib/pleroma/web/api_spec/operations/admin/rule_operation.ex
2
+-
M
lib/pleroma/web/api_spec/operations/instance_operation.ex
27
++++++++++++++++++++++++++-
M
lib/pleroma/web/mastodon_api/controllers/instance_controller.ex
5
+++++
M
lib/pleroma/web/mastodon_api/views/instance_view.ex
4
++++
M
lib/pleroma/web/router.ex
1
+

5 files changed, 37 insertions(+), 2 deletions(-)
diff --git a/lib/pleroma/web/api_spec/operations/admin/rule_operation.ex b/lib/pleroma/web/api_spec/operations/admin/rule_operation.ex
@@ -17,7 +17,7 @@ defmodule Pleroma.Web.ApiSpec.Admin.RuleOperation do
   def index_operation do
     %Operation{
       tags: ["Instance rule managment"],
-      summary: "Retrieve a list of instance rules",
+      summary: "Retrieve list of instance rules",
       operationId: "AdminAPI.RuleController.index",
       security: [%{"oAuth" => ["admin:read"]}],
       responses: %{
diff --git a/lib/pleroma/web/api_spec/operations/instance_operation.ex b/lib/pleroma/web/api_spec/operations/instance_operation.ex
@@ -34,6 +34,17 @@ defmodule Pleroma.Web.ApiSpec.InstanceOperation do
     }
   end
 
+  def rules_operation do
+    %Operation{
+      tags: ["Instance"],
+      summary: "Retrieve list of instance rules",
+      operationId: "InstanceController.rules",
+      responses: %{
+        200 => Operation.response("Array of domains", "application/json", array_of_rules())
+      }
+    }
+  end
+
   defp instance do
     %Schema{
       type: :object,
@@ -160,7 +171,8 @@ defmodule Pleroma.Web.ApiSpec.InstanceOperation do
         "urls" => %{
           "streaming_api" => "wss://lain.com"
         },
-        "version" => "2.7.2 (compatible; Pleroma 2.0.50-536-g25eec6d7-develop)"
+        "version" => "2.7.2 (compatible; Pleroma 2.0.50-536-g25eec6d7-develop)",
+        "rules" => array_of_rules()
       }
     }
   end
@@ -172,4 +184,17 @@ defmodule Pleroma.Web.ApiSpec.InstanceOperation do
       example: ["pleroma.site", "lain.com", "bikeshed.party"]
     }
   end
+
+  defp array_of_rules do
+    %Schema{
+      type: :array,
+      items: %Schema{
+        type: :object,
+        properties: %{
+          id: %Schema{type: :integer},
+          text: %Schema{type: :string}
+        }
+      }
+    }
+  end
 end
diff --git a/lib/pleroma/web/mastodon_api/controllers/instance_controller.ex b/lib/pleroma/web/mastodon_api/controllers/instance_controller.ex
@@ -20,4 +20,9 @@ defmodule Pleroma.Web.MastodonAPI.InstanceController do
   def peers(conn, _params) do
     json(conn, Pleroma.Stats.get_peers())
   end
+
+  @doc "GET /api/v1/instance/rules"
+  def rules(conn, _params) do
+    render(conn, "rules.json")
+  end
 end
diff --git a/lib/pleroma/web/mastodon_api/views/instance_view.ex b/lib/pleroma/web/mastodon_api/views/instance_view.ex
@@ -58,6 +58,10 @@ defmodule Pleroma.Web.MastodonAPI.InstanceView do
     }
   end
 
+  def render("rules.json", _) do
+    rules()
+  end
+
   def features do
     [
       "pleroma_api",
diff --git a/lib/pleroma/web/router.ex b/lib/pleroma/web/router.ex
@@ -606,6 +606,7 @@ defmodule Pleroma.Web.Router do
 
     get("/instance", InstanceController, :show)
     get("/instance/peers", InstanceController, :peers)
+    get("/instance/rules", InstanceController, :rules)
 
     get("/statuses", StatusController, :index)
     get("/statuses/:id", StatusController, :show)