akkoma/lib/pleroma/web/api_spec/schemas/tag.ex

# Pleroma: A lightweight social networking server
# Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
# SPDX-License-Identifier: AGPL-3.0-only

defmodule Pleroma.Web.ApiSpec.Schemas.Tag do
  alias OpenApiSpex.Schema

  require OpenApiSpex

  OpenApiSpex.schema(%{
    title: "Tag",
    description: "Represents a hashtag used within the content of a status",
    type: :object,
    properties: %{
      name: %Schema{type: :string, description: "The value of the hashtag after the # sign"},
      url: %Schema{
        type: :string,
        format: :uri,
        description: "A link to the hashtag on the instance"
      },
      following: %Schema{
        type: :boolean,
        description: "Whether the authenticated user is following the hashtag"
      },
      history: %Schema{
        type: :array,
        items: %Schema{type: :string},
        description:
          "A list of historical uses of the hashtag (not implemented, for compatibility only)"
      }
    },
    example: %{
      name: "cofe",
      url: "https://lain.com/tag/cofe",
      following: false
    }
  })
end