aboutsummaryrefslogtreecommitdiff
path: root/lib/pleroma/web/api_spec/schemas/bookmark_folder.ex
blob: e8b4f43b736f29e51a17e1e00b398ce70ea2cabf (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# Pleroma: A lightweight social networking server
# Copyright © 2017-2024 Pleroma Authors <https://pleroma.social/>
# SPDX-License-Identifier: AGPL-3.0-only

defmodule Pleroma.Web.ApiSpec.Schemas.BookmarkFolder do
  alias OpenApiSpex.Schema
  alias Pleroma.Web.ApiSpec.Schemas.FlakeID

  require OpenApiSpex

  OpenApiSpex.schema(%{
    title: "BookmarkFolder",
    description: "Response schema for a bookmark folder",
    type: :object,
    properties: %{
      id: FlakeID,
      name: %Schema{type: :string, description: "Folder name"},
      emoji: %Schema{type: :string, description: "Folder emoji", nullable: true}
    },
    example: %{
      "id" => "9toJCu5YZW7O7gfvH6",
      "name" => "Read later",
      "emoji" => nil
    }
  })
end