Return the file content for GET /api/pleroma/admin/instance_document/:document_name

docs/API/admin_api.md

@@ -1458,23 +1458,23 @@ Loads json generated from `config/descriptions.exs`.
 
 ## `GET /api/pleroma/admin/instance_document/:document_name`
 
-### Gets an instance document
+### Get an instance document
 
 - Authentication: required
 
 - Response:
 
-``` json
+Returns the content of the document
-{
+
-  "url": "https://example.com/instance/panel.html"
+```html
-}
+<h1>Instance panel</h1>
 ```
 
 ## `PATCH /api/pleroma/admin/instance_document/:document_name`
 - Params:
   - `file` (the file to be uploaded, using multipart form data.)
 
-### Updates an instance document
+### Update an instance document
 
 - Authentication: required
 

lib/pleroma/web/admin_api/controllers/instance_document_controller.ex

@@ -5,6 +5,7 @@
 defmodule Pleroma.Web.AdminAPI.InstanceDocumentController do
   use Pleroma.Web, :controller
 
+  alias Pleroma.Plugs.InstanceStatic
   alias Pleroma.Plugs.OAuthScopesPlug
   alias Pleroma.Web.InstanceDocument
 
@@ -18,8 +19,11 @@ defmodule Pleroma.Web.AdminAPI.InstanceDocumentController do
   plug(OAuthScopesPlug, %{scopes: ["write"], admin: true} when action in [:update, :delete])
 
   def show(conn, %{name: document_name}) do
-    with {:ok, url} <- InstanceDocument.get(document_name) do
+    with {:ok, url} <- InstanceDocument.get(document_name),
-      json(conn, %{"url" => url})
+         {:ok, content} <- File.read(InstanceStatic.file_path(url)) do
+      conn
+      |> put_resp_content_type("text/html")
+      |> send_resp(200, content)
     end
   end
 

lib/pleroma/web/api_spec/operations/admin/instance_document_operation.ex

@@ -26,7 +26,7 @@ defmodule Pleroma.Web.ApiSpec.Admin.InstanceDocumentOperation do
         | Helpers.admin_api_params()
       ],
       responses: %{
-        200 => Operation.response("InstanceDocument", "application/json", instance_document()),
+        200 => document_content(),
         400 => Operation.response("Bad Request", "application/json", ApiError),
         403 => Operation.response("Forbidden", "application/json", ApiError),
         404 => Operation.response("Not Found", "application/json", ApiError)
@@ -105,4 +105,11 @@ defmodule Pleroma.Web.ApiSpec.Admin.InstanceDocumentOperation do
       }
     }
   end
+
+  defp document_content do
+    Operation.response("InstanceDocumentContent", "text/html", %Schema{
+      type: :string,
+      example: "<h1>Instance panel</h1>"
+    })
+  end
 end

lib/pleroma/web/instance_document.ex

@@ -14,7 +14,7 @@ defmodule Pleroma.Web.InstanceDocument do
   @spec get(String.t()) :: {:ok, String.t()} | {:error, atom()}
   def get(document_name) do
     case Map.fetch(@instance_documents, document_name) do
-      {:ok, path} -> {:ok, Path.join(Endpoint.url(), path)}
+      {:ok, path} -> {:ok, path}
       _ -> {:error, :not_found}
     end
   end

test/web/admin_api/controllers/instance_document_controller_test.exs

@@ -33,10 +33,8 @@ defmodule Pleroma.Web.AdminAPI.InstanceDocumentControllerTest do
     test "return the instance document url", %{conn: conn} do
       conn = get(conn, "/api/pleroma/admin/instance_document/instance-panel")
 
-      assert %{"url" => url} = json_response_and_validate_schema(conn, 200)
+      assert content = html_response(conn, 200)
-      index = get(build_conn(), url)
+      assert String.contains?(content, @default_instance_panel)
-      response = html_response(index, 200)
-      assert String.contains?(response, @default_instance_panel)
     end
 
     test "it returns 403 if requested by a non-admin" do
@@ -91,9 +89,7 @@ defmodule Pleroma.Web.AdminAPI.InstanceDocumentControllerTest do
         conn
         |> get("/api/pleroma/admin/instance_document/instance-panel")
 
-      assert %{"url" => url} = json_response_and_validate_schema(conn_resp, 200)
+      assert html_response(conn_resp, 200) == "Custom instance panel"
-      index = get(build_conn(), url)
-      assert html_response(index, 200) == "Custom instance panel"
 
       conn
       |> delete("/api/pleroma/admin/instance_document/instance-panel")
@@ -103,10 +99,8 @@ defmodule Pleroma.Web.AdminAPI.InstanceDocumentControllerTest do
         conn
         |> get("/api/pleroma/admin/instance_document/instance-panel")
 
-      assert %{"url" => url} = json_response_and_validate_schema(conn_resp, 200)
+      assert content = html_response(conn_resp, 200)
-      index = get(build_conn(), url)
+      assert String.contains?(content, @default_instance_panel)
-      response = html_response(index, 200)
-      assert String.contains?(response, @default_instance_panel)
     end
   end
 end