X-Git-Url: http://git.squeep.com/?a=blobdiff_plain;f=lib%2Fpleroma%2Fweb%2Fapi_spec%2Fschemas%2Flist.ex;h=90f5ec987348fcdce0b4a48940acd112f5539ed9;hb=f917285b72dbc770be40478e1a55973f29d5db7d;hp=f85fac2b854df866aa4900bed25caa4f53254661;hpb=6c26feed01b2e836e7ebdefe9683ddb03cb57757;p=akkoma diff --git a/lib/pleroma/web/api_spec/schemas/list.ex b/lib/pleroma/web/api_spec/schemas/list.ex index f85fac2b8..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,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