X-Git-Url: https://git.squeep.com/?a=blobdiff_plain;ds=sidebyside;f=lib%2Fpleroma%2Fweb%2Fapi_spec%2Fschemas%2Flist.ex;h=90f5ec987348fcdce0b4a48940acd112f5539ed9;hb=b6a72680e2a20e30fa4e9dbc3f4f60e4c51dd63f;hp=30fa7db936e2463ae4f3a7e8ab6ad899d19319be;hpb=736fead494f6140871919308e872bb6fe5b7a196;p=akkoma
diff --git a/lib/pleroma/web/api_spec/schemas/list.ex b/lib/pleroma/web/api_spec/schemas/list.ex
index 30fa7db93..90f5ec987 100644
--- a/lib/pleroma/web/api_spec/schemas/list.ex
+++ b/lib/pleroma/web/api_spec/schemas/list.ex
@@ -1,5 +1,5 @@
# Pleroma: A lightweight social networking server
-# Copyright © 2017-2020 Pleroma Authors
+# Copyright © 2017-2021 Pleroma Authors
# SPDX-License-Identifier: AGPL-3.0-only
defmodule Pleroma.Web.ApiSpec.Schemas.List do
@@ -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