git.squeep.com Git - akkoma/blob - lib/pleroma/web/api_spec/schemas/account.ex

   1 # Pleroma: A lightweight social networking server
   2 # Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
   3 # SPDX-License-Identifier: AGPL-3.0-only
   4
   5 defmodule Pleroma.Web.ApiSpec.Schemas.Account do
   6   alias OpenApiSpex.Schema
   7   alias Pleroma.Web.ApiSpec.Schemas.AccountField
   8   alias Pleroma.Web.ApiSpec.Schemas.AccountRelationship
   9   alias Pleroma.Web.ApiSpec.Schemas.ActorType
  10   alias Pleroma.Web.ApiSpec.Schemas.Emoji
  11   alias Pleroma.Web.ApiSpec.Schemas.FlakeID
  12   alias Pleroma.Web.ApiSpec.Schemas.VisibilityScope
  13
  14   require OpenApiSpex
  15
  16   OpenApiSpex.schema(%{
  17     title: "Account",
  18     description: "Response schema for an account",
  19     type: :object,
  20     properties: %{
  21       acct: %Schema{type: :string},
  22       avatar_static: %Schema{type: :string, format: :uri},
  23       avatar: %Schema{type: :string, format: :uri},
  24       bot: %Schema{type: :boolean},
  25       created_at: %Schema{type: :string, format: "date-time"},
  26       display_name: %Schema{type: :string},
  27       emojis: %Schema{type: :array, items: Emoji},
  28       fields: %Schema{type: :array, items: AccountField},
  29       follow_requests_count: %Schema{type: :integer},
  30       followers_count: %Schema{type: :integer},
  31       following_count: %Schema{type: :integer},
  32       header_static: %Schema{type: :string, format: :uri},
  33       header: %Schema{type: :string, format: :uri},
  34       id: FlakeID,
  35       locked: %Schema{type: :boolean},
  36       note: %Schema{type: :string, format: :html},
  37       statuses_count: %Schema{type: :integer},
  38       url: %Schema{type: :string, format: :uri},
  39       username: %Schema{type: :string},
  40       pleroma: %Schema{
  41         type: :object,
  42         properties: %{
  43           ap_id: %Schema{type: :string},
  44           also_known_as: %Schema{type: :array, items: %Schema{type: :string}},
  45           allow_following_move: %Schema{
  46             type: :boolean,
  47             description: "whether the user allows automatically follow moved following accounts"
  48           },
  49           background_image: %Schema{type: :string, nullable: true, format: :uri},
  50           is_confirmed: %Schema{
  51             type: :boolean,
  52             description:
  53               "whether the user account is waiting on email confirmation to be activated"
  54           },
  55           hide_favorites: %Schema{type: :boolean},
  56           hide_followers_count: %Schema{
  57             type: :boolean,
  58             description: "whether the user has follower stat hiding enabled"
  59           },
  60           hide_followers: %Schema{
  61             type: :boolean,
  62             description: "whether the user has follower hiding enabled"
  63           },
  64           hide_follows_count: %Schema{
  65             type: :boolean,
  66             description: "whether the user has follow stat hiding enabled"
  67           },
  68           hide_follows: %Schema{
  69             type: :boolean,
  70             description: "whether the user has follow hiding enabled"
  71           },
  72           is_admin: %Schema{
  73             type: :boolean,
  74             description: "whether the user is an admin of the local instance"
  75           },
  76           is_moderator: %Schema{
  77             type: :boolean,
  78             description: "whether the user is a moderator of the local instance"
  79           },
  80           skip_thread_containment: %Schema{type: :boolean},
  81           tags: %Schema{
  82             type: :array,
  83             items: %Schema{type: :string},
  84             description:
  85               "List of tags being used for things like extra roles or moderation(ie. marking all media as nsfw all)."
  86           },
  87           unread_conversation_count: %Schema{
  88             type: :integer,
  89             description: "The count of unread conversations. Only returned to the account owner."
  90           },
  91           notification_settings: %Schema{
  92             type: :object,
  93             properties: %{
  94               block_from_strangers: %Schema{type: :boolean},
  95               hide_notification_contents: %Schema{type: :boolean}
  96             }
  97           },
  98           relationship: %Schema{allOf: [AccountRelationship], nullable: true},
  99           settings_store: %Schema{
 100             type: :object,
 101             description:
 102               "A generic map of settings for frontends. Opaque to the backend. Only returned in `verify_credentials` and `update_credentials`"
 103           },
 104           favicon: %Schema{
 105             type: :string,
 106             format: :uri,
 107             nullable: true,
 108             description: "Favicon image of the user's instance"
 109           }
 110         }
 111       },
 112       source: %Schema{
 113         type: :object,
 114         properties: %{
 115           fields: %Schema{type: :array, items: AccountField},
 116           note: %Schema{
 117             type: :string,
 118             description:
 119               "Plaintext version of the bio without formatting applied by the backend, used for editing the bio."
 120           },
 121           privacy: VisibilityScope,
 122           sensitive: %Schema{type: :boolean},
 123           pleroma: %Schema{
 124             type: :object,
 125             properties: %{
 126               actor_type: ActorType,
 127               discoverable: %Schema{
 128                 type: :boolean,
 129                 description:
 130                   "whether the user allows indexing / listing of the account by external services (search engines etc.)."
 131               },
 132               no_rich_text: %Schema{
 133                 type: :boolean,
 134                 description:
 135                   "whether the HTML tags for rich-text formatting are stripped from all statuses requested from the API."
 136               },
 137               show_role: %Schema{
 138                 type: :boolean,
 139                 description:
 140                   "whether the user wants their role (e.g admin, moderator) to be shown"
 141               }
 142             }
 143           }
 144         }
 145       }
 146     },
 147     example: %{
 148       "acct" => "foobar",
 149       "avatar" => "https://mypleroma.com/images/avi.png",
 150       "avatar_static" => "https://mypleroma.com/images/avi.png",
 151       "bot" => false,
 152       "created_at" => "2020-03-24T13:05:58.000Z",
 153       "display_name" => "foobar",
 154       "emojis" => [],
 155       "fields" => [],
 156       "follow_requests_count" => 0,
 157       "followers_count" => 0,
 158       "following_count" => 1,
 159       "header" => "https://mypleroma.com/images/banner.png",
 160       "header_static" => "https://mypleroma.com/images/banner.png",
 161       "id" => "9tKi3esbG7OQgZ2920",
 162       "locked" => false,
 163       "note" => "cofe",
 164       "pleroma" => %{
 165         "allow_following_move" => true,
 166         "background_image" => nil,
 167         "is_confirmed" => false,
 168         "hide_favorites" => true,
 169         "hide_followers" => false,
 170         "hide_followers_count" => false,
 171         "hide_follows" => false,
 172         "hide_follows_count" => false,
 173         "is_admin" => false,
 174         "is_moderator" => false,
 175         "skip_thread_containment" => false,
 176         "unread_conversation_count" => 0,
 177         "tags" => [],
 178         "notification_settings" => %{
 179           "block_from_strangers" => false,
 180           "hide_notification_contents" => false
 181         },
 182         "relationship" => %{
 183           "blocked_by" => false,
 184           "blocking" => false,
 185           "domain_blocking" => false,
 186           "endorsed" => false,
 187           "followed_by" => false,
 188           "following" => false,
 189           "id" => "9tKi3esbG7OQgZ2920",
 190           "muting" => false,
 191           "muting_notifications" => false,
 192           "note" => "",
 193           "requested" => false,
 194           "showing_reblogs" => true,
 195           "subscribing" => false,
 196           "notifying" => false
 197         },
 198         "settings_store" => %{
 199           "pleroma-fe" => %{}
 200         }
 201       },
 202       "source" => %{
 203         "fields" => [],
 204         "note" => "foobar",
 205         "pleroma" => %{
 206           "actor_type" => "Person",
 207           "discoverable" => false,
 208           "no_rich_text" => false,
 209           "show_role" => true
 210         },
 211         "privacy" => "public",
 212         "sensitive" => false
 213       },
 214       "statuses_count" => 0,
 215       "url" => "https://mypleroma.com/users/foobar",
 216       "username" => "foobar"
 217     }
 218   })
 219 end