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

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