Fix descriptions for List API spec

[akkoma] / lib / pleroma / web / api_spec / schemas / list.ex

diff --git a/lib/pleroma/web/api_spec/schemas/list.ex b/lib/pleroma/web/api_spec/schemas/list.ex
index 30fa7db936e2463ae4f3a7e8ab6ad899d19319be..b7d1685c9281445a5ce943ef5211c95a234efb5f 100644 (file)
--- a/lib/pleroma/web/api_spec/schemas/list.ex
+++ b/lib/pleroma/web/api_spec/schemas/list.ex
@@ -9,17 +9,15 @@ defmodule Pleroma.Web.ApiSpec.Schemas.List do
 
   OpenApiSpex.schema(%{
     title: "List",
-    description: "Response schema for a list",
+    description: "Represents a list of users",
     type: :object,
     properties: %{
-      id: %Schema{type: :string},
-      title: %Schema{type: :string}
+      id: %Schema{type: :string, description: "The internal database ID of the list"},
+      title: %Schema{type: :string, description: "The user-defined title of the list"}
     },
     example: %{
-      "JSON" => %{
-        "id" => "123",
-        "title" => "my list"
-      }
+      "id" => "12249",
+      "title" => "Friends"
     }
   })
 end