Git of dcc - anni/blob - lib/pleroma/web/api_spec/schemas/bookmark_folder.ex

   1 # Pleroma: A lightweight social networking server
   2 # Copyright © 2017-2024 Pleroma Authors <https://pleroma.social/>
   3 # SPDX-License-Identifier: AGPL-3.0-only
   4
   5 defmodule Pleroma.Web.ApiSpec.Schemas.BookmarkFolder do
   6   alias OpenApiSpex.Schema
   7   alias Pleroma.Web.ApiSpec.Schemas.FlakeID
   8
   9   require OpenApiSpex
  10
  11   OpenApiSpex.schema(%{
  12     title: "BookmarkFolder",
  13     description: "Response schema for a bookmark folder",
  14     type: :object,
  15     properties: %{
  16       id: FlakeID,
  17       name: %Schema{type: :string, description: "Folder name"},
  18       emoji: %Schema{type: :string, description: "Folder emoji", nullable: true}
  19     },
  20     example: %{
  21       "id" => "9toJCu5YZW7O7gfvH6",
  22       "name" => "Read later",
  23       "emoji" => nil
  24     }
  25   })
  26 end