X-Git-Url: http://git.squeep.com/?a=blobdiff_plain;f=lib%2Fpleroma%2Fweb%2Fapi_spec%2Fschemas%2Flist.ex;h=b7d1685c9281445a5ce943ef5211c95a234efb5f;hb=086100e3b7cad827c0f377fdcc4ae9d3b66327c7;hp=f85fac2b854df866aa4900bed25caa4f53254661;hpb=f1ca917bb0d733445657e0be92440dedc2f8d3c6;p=akkoma diff --git a/lib/pleroma/web/api_spec/schemas/list.ex b/lib/pleroma/web/api_spec/schemas/list.ex index f85fac2b8..b7d1685c9 100644 --- a/lib/pleroma/web/api_spec/schemas/list.ex +++ b/lib/pleroma/web/api_spec/schemas/list.ex @@ -9,15 +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: %{ - "id" => "123", - "title" => "my list" + "id" => "12249", + "title" => "Friends" } }) end