Pleroma/lib/pleroma/web/api_spec/schemas/list.ex

24 lines
646 B
Elixir
Raw Normal View History

2020-05-05 15:05:34 +02:00
# Pleroma: A lightweight social networking server
# Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
2020-05-05 15:05:34 +02:00
# SPDX-License-Identifier: AGPL-3.0-only
defmodule Pleroma.Web.ApiSpec.Schemas.List do
alias OpenApiSpex.Schema
require OpenApiSpex
OpenApiSpex.schema(%{
title: "List",
2020-05-01 17:53:00 +02:00
description: "Represents a list of users",
2020-05-05 15:05:34 +02:00
type: :object,
properties: %{
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" => "12249",
"title" => "Friends"
}
})
end