# Pleroma: A lightweight social networking server
-# Copyright © 2017-2020 Pleroma Authors <https://pleroma.social/>
+# Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
# SPDX-License-Identifier: AGPL-3.0-only
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