git.squeep.com Git - akkoma/blob - lib/pleroma/web/api_spec/schemas/status.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.Status do
   6   alias OpenApiSpex.Schema
   7   alias Pleroma.Web.ApiSpec.Schemas.Account
   8   alias Pleroma.Web.ApiSpec.Schemas.Attachment
   9   alias Pleroma.Web.ApiSpec.Schemas.Emoji
  10   alias Pleroma.Web.ApiSpec.Schemas.FlakeID
  11   alias Pleroma.Web.ApiSpec.Schemas.Poll
  12   alias Pleroma.Web.ApiSpec.Schemas.Tag
  13   alias Pleroma.Web.ApiSpec.Schemas.VisibilityScope
  14
  15   require OpenApiSpex
  16
  17   OpenApiSpex.schema(%{
  18     title: "Status",
  19     description: "Response schema for a status",
  20     type: :object,
  21     properties: %{
  22       account: %Schema{allOf: [Account], description: "The account that authored this status"},
  23       application: %Schema{
  24         description: "The application used to post this status",
  25         type: :object,
  26         nullable: true,
  27         properties: %{
  28           name: %Schema{type: :string},
  29           website: %Schema{type: :string, format: :uri}
  30         }
  31       },
  32       bookmarked: %Schema{type: :boolean, description: "Have you bookmarked this status?"},
  33       card: %Schema{
  34         type: :object,
  35         nullable: true,
  36         description: "Preview card for links included within status content",
  37         required: [:url, :title, :description, :type],
  38         properties: %{
  39           type: %Schema{
  40             type: :string,
  41             enum: ["link", "photo", "video", "rich"],
  42             description: "The type of the preview card"
  43           },
  44           provider_name: %Schema{
  45             type: :string,
  46             nullable: true,
  47             description: "The provider of the original resource"
  48           },
  49           provider_url: %Schema{
  50             type: :string,
  51             format: :uri,
  52             description: "A link to the provider of the original resource"
  53           },
  54           url: %Schema{type: :string, format: :uri, description: "Location of linked resource"},
  55           image: %Schema{
  56             type: :string,
  57             nullable: true,
  58             format: :uri,
  59             description: "Preview thumbnail"
  60           },
  61           title: %Schema{type: :string, description: "Title of linked resource"},
  62           description: %Schema{type: :string, description: "Description of preview"}
  63         }
  64       },
  65       content: %Schema{type: :string, format: :html, description: "HTML-encoded status content"},
  66       text: %Schema{
  67         type: :string,
  68         description: "Original unformatted content in plain text",
  69         nullable: true
  70       },
  71       created_at: %Schema{
  72         type: :string,
  73         format: "date-time",
  74         description: "The date when this status was created"
  75       },
  76       emojis: %Schema{
  77         type: :array,
  78         items: Emoji,
  79         description: "Custom emoji to be used when rendering status content"
  80       },
  81       favourited: %Schema{type: :boolean, description: "Have you favourited this status?"},
  82       favourites_count: %Schema{
  83         type: :integer,
  84         description: "How many favourites this status has received"
  85       },
  86       id: FlakeID,
  87       in_reply_to_account_id: %Schema{
  88         allOf: [FlakeID],
  89         nullable: true,
  90         description: "ID of the account being replied to"
  91       },
  92       in_reply_to_id: %Schema{
  93         allOf: [FlakeID],
  94         nullable: true,
  95         description: "ID of the status being replied"
  96       },
  97       language: %Schema{
  98         type: :string,
  99         nullable: true,
 100         description: "Primary language of this status"
 101       },
 102       media_attachments: %Schema{
 103         type: :array,
 104         items: Attachment,
 105         description: "Media that is attached to this status"
 106       },
 107       mentions: %Schema{
 108         type: :array,
 109         description: "Mentions of users within the status content",
 110         items: %Schema{
 111           type: :object,
 112           properties: %{
 113             id: %Schema{allOf: [FlakeID], description: "The account id of the mentioned user"},
 114             acct: %Schema{
 115               type: :string,
 116               description:
 117                 "The webfinger acct: URI of the mentioned user. Equivalent to `username` for local users, or `username@domain` for remote users."
 118             },
 119             username: %Schema{type: :string, description: "The username of the mentioned user"},
 120             url: %Schema{
 121               type: :string,
 122               format: :uri,
 123               description: "The location of the mentioned user's profile"
 124             }
 125           }
 126         }
 127       },
 128       muted: %Schema{
 129         type: :boolean,
 130         description: "Have you muted notifications for this status's conversation?"
 131       },
 132       pinned: %Schema{
 133         type: :boolean,
 134         description: "Have you pinned this status? Only appears if the status is pinnable."
 135       },
 136       pleroma: %Schema{
 137         type: :object,
 138         properties: %{
 139           content: %Schema{
 140             type: :object,
 141             additionalProperties: %Schema{type: :string},
 142             description:
 143               "A map consisting of alternate representations of the `content` property with the key being it's mimetype. Currently the only alternate representation supported is `text/plain`"
 144           },
 145           conversation_id: %Schema{
 146             type: :integer,
 147             description: "The ID of the AP context the status is associated with (if any)"
 148           },
 149           direct_conversation_id: %Schema{
 150             type: :integer,
 151             nullable: true,
 152             description:
 153               "The ID of the Mastodon direct message conversation the status is associated with (if any)"
 154           },
 155           emoji_reactions: %Schema{
 156             type: :array,
 157             description:
 158               "A list with emoji / reaction maps. Contains no information about the reacting users, for that use the /statuses/:id/reactions endpoint.",
 159             items: %Schema{
 160               type: :object,
 161               properties: %{
 162                 name: %Schema{type: :string},
 163                 count: %Schema{type: :integer},
 164                 me: %Schema{type: :boolean}
 165               }
 166             }
 167           },
 168           expires_at: %Schema{
 169             type: :string,
 170             format: "date-time",
 171             nullable: true,
 172             description:
 173               "A datetime (ISO 8601) that states when the post will expire (be deleted automatically), or empty if the post won't expire"
 174           },
 175           in_reply_to_account_acct: %Schema{
 176             type: :string,
 177             nullable: true,
 178             description: "The `acct` property of User entity for replied user (if any)"
 179           },
 180           local: %Schema{
 181             type: :boolean,
 182             description: "`true` if the post was made on the local instance"
 183           },
 184           spoiler_text: %Schema{
 185             type: :object,
 186             additionalProperties: %Schema{type: :string},
 187             description:
 188               "A map consisting of alternate representations of the `spoiler_text` property with the key being it's mimetype. Currently the only alternate representation supported is `text/plain`."
 189           },
 190           thread_muted: %Schema{
 191             type: :boolean,
 192             description: "`true` if the thread the post belongs to is muted"
 193           },
 194           parent_visible: %Schema{
 195             type: :boolean,
 196             description: "`true` if the parent post is visible to the user"
 197           }
 198         }
 199       },
 200       poll: %Schema{allOf: [Poll], nullable: true, description: "The poll attached to the status"},
 201       reblog: %Schema{
 202         allOf: [%OpenApiSpex.Reference{"$ref": "#/components/schemas/Status"}],
 203         nullable: true,
 204         description: "The status being reblogged"
 205       },
 206       reblogged: %Schema{type: :boolean, description: "Have you boosted this status?"},
 207       reblogs_count: %Schema{
 208         type: :integer,
 209         description: "How many boosts this status has received"
 210       },
 211       replies_count: %Schema{
 212         type: :integer,
 213         description: "How many replies this status has received"
 214       },
 215       sensitive: %Schema{
 216         type: :boolean,
 217         description: "Is this status marked as sensitive content?"
 218       },
 219       spoiler_text: %Schema{
 220         type: :string,
 221         description:
 222           "Subject or summary line, below which status content is collapsed until expanded"
 223       },
 224       tags: %Schema{type: :array, items: Tag},
 225       uri: %Schema{
 226         type: :string,
 227         format: :uri,
 228         description: "URI of the status used for federation"
 229       },
 230       url: %Schema{
 231         type: :string,
 232         nullable: true,
 233         format: :uri,
 234         description: "A link to the status's HTML representation"
 235       },
 236       visibility: %Schema{
 237         allOf: [VisibilityScope],
 238         description: "Visibility of this status"
 239       }
 240     },
 241     example: %{
 242       "account" => %{
 243         "acct" => "nick6",
 244         "avatar" => "http://localhost:4001/images/avi.png",
 245         "avatar_static" => "http://localhost:4001/images/avi.png",
 246         "bot" => false,
 247         "created_at" => "2020-04-07T19:48:51.000Z",
 248         "display_name" => "Test テスト User 6",
 249         "emojis" => [],
 250         "fields" => [],
 251         "followers_count" => 1,
 252         "following_count" => 0,
 253         "header" => "http://localhost:4001/images/banner.png",
 254         "header_static" => "http://localhost:4001/images/banner.png",
 255         "id" => "9toJCsKN7SmSf3aj5c",
 256         "is_locked" => false,
 257         "note" => "Tester Number 6",
 258         "pleroma" => %{
 259           "background_image" => nil,
 260           "is_confirmed" => true,
 261           "hide_favorites" => true,
 262           "hide_followers" => false,
 263           "hide_followers_count" => false,
 264           "hide_follows" => false,
 265           "hide_follows_count" => false,
 266           "is_admin" => false,
 267           "is_moderator" => false,
 268           "relationship" => %{
 269             "blocked_by" => false,
 270             "blocking" => false,
 271             "domain_blocking" => false,
 272             "endorsed" => false,
 273             "followed_by" => false,
 274             "following" => true,
 275             "id" => "9toJCsKN7SmSf3aj5c",
 276             "muting" => false,
 277             "muting_notifications" => false,
 278             "requested" => false,
 279             "showing_reblogs" => true,
 280             "subscribing" => false
 281           },
 282           "skip_thread_containment" => false,
 283           "tags" => []
 284         },
 285         "source" => %{
 286           "fields" => [],
 287           "note" => "Tester Number 6",
 288           "pleroma" => %{"actor_type" => "Person", "discoverable" => false},
 289           "sensitive" => false
 290         },
 291         "statuses_count" => 1,
 292         "url" => "http://localhost:4001/users/nick6",
 293         "username" => "nick6"
 294       },
 295       "application" => nil,
 296       "bookmarked" => false,
 297       "card" => nil,
 298       "content" => "foobar",
 299       "created_at" => "2020-04-07T19:48:51.000Z",
 300       "emojis" => [],
 301       "favourited" => false,
 302       "favourites_count" => 0,
 303       "id" => "9toJCu5YZW7O7gfvH6",
 304       "in_reply_to_account_id" => nil,
 305       "in_reply_to_id" => nil,
 306       "language" => nil,
 307       "media_attachments" => [],
 308       "mentions" => [],
 309       "muted" => false,
 310       "pinned" => false,
 311       "pleroma" => %{
 312         "content" => %{"text/plain" => "foobar"},
 313         "conversation_id" => 345_972,
 314         "direct_conversation_id" => nil,
 315         "emoji_reactions" => [],
 316         "expires_at" => nil,
 317         "in_reply_to_account_acct" => nil,
 318         "local" => true,
 319         "spoiler_text" => %{"text/plain" => ""},
 320         "thread_muted" => false
 321       },
 322       "poll" => nil,
 323       "reblog" => nil,
 324       "reblogged" => false,
 325       "reblogs_count" => 0,
 326       "replies_count" => 0,
 327       "sensitive" => false,
 328       "spoiler_text" => "",
 329       "tags" => [],
 330       "uri" => "http://localhost:4001/objects/0f5dad44-0e9e-4610-b377-a2631e499190",
 331       "url" => "http://localhost:4001/notice/9toJCu5YZW7O7gfvH6",
 332       "visibility" => "private"
 333     }
 334   })
 335 end