git.squeep.com Git - akkoma/blob - lib/pleroma/web/api_spec/schemas/status.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.Status do
   6   alias OpenApiSpex.Schema
   7   alias Pleroma.Web.ApiSpec.Schemas.Account
   8   alias Pleroma.Web.ApiSpec.Schemas.AccountEmoji
   9   alias Pleroma.Web.ApiSpec.Schemas.Poll
  10   alias Pleroma.Web.ApiSpec.Schemas.VisibilityScope
  11
  12   require OpenApiSpex
  13
  14   OpenApiSpex.schema(%{
  15     title: "Status",
  16     description: "Response schema for a status",
  17     type: :object,
  18     properties: %{
  19       account: Account,
  20       application: %Schema{
  21         type: :object,
  22         properties: %{
  23           name: %Schema{type: :string},
  24           website: %Schema{type: :string, nullable: true}
  25         }
  26       },
  27       bookmarked: %Schema{type: :boolean},
  28       card: %Schema{
  29         type: :object,
  30         nullable: true,
  31         properties: %{
  32           type: %Schema{type: :string},
  33           provider_name: %Schema{type: :string},
  34           provider_url: %Schema{type: :string},
  35           url: %Schema{type: :string},
  36           image: %Schema{type: :string},
  37           title: %Schema{type: :string},
  38           description: %Schema{type: :string}
  39         }
  40       },
  41       content: %Schema{type: :string},
  42       created_at: %Schema{type: :string, format: "date-time"},
  43       emojis: %Schema{type: :array, items: AccountEmoji},
  44       favourited: %Schema{type: :boolean},
  45       favourites_count: %Schema{type: :integer},
  46       id: %Schema{type: :string},
  47       in_reply_to_account_id: %Schema{type: :string, nullable: true},
  48       in_reply_to_id: %Schema{type: :string, nullable: true},
  49       language: %Schema{type: :string, nullable: true},
  50       media_attachments: %Schema{
  51         type: :array,
  52         items: %Schema{
  53           type: :object,
  54           properties: %{
  55             id: %Schema{type: :string},
  56             url: %Schema{type: :string},
  57             remote_url: %Schema{type: :string},
  58             preview_url: %Schema{type: :string},
  59             text_url: %Schema{type: :string},
  60             description: %Schema{type: :string},
  61             type: %Schema{type: :string, enum: ["image", "video", "audio", "unknown"]},
  62             pleroma: %Schema{
  63               type: :object,
  64               properties: %{mime_type: %Schema{type: :string}}
  65             }
  66           }
  67         }
  68       },
  69       mentions: %Schema{
  70         type: :array,
  71         items: %Schema{
  72           type: :object,
  73           properties: %{
  74             id: %Schema{type: :string},
  75             acct: %Schema{type: :string},
  76             username: %Schema{type: :string},
  77             url: %Schema{type: :string}
  78           }
  79         }
  80       },
  81       muted: %Schema{type: :boolean},
  82       pinned: %Schema{type: :boolean},
  83       pleroma: %Schema{
  84         type: :object,
  85         properties: %{
  86           content: %Schema{type: :object, additionalProperties: %Schema{type: :string}},
  87           conversation_id: %Schema{type: :integer},
  88           direct_conversation_id: %Schema{type: :string, nullable: true},
  89           emoji_reactions: %Schema{
  90             type: :array,
  91             items: %Schema{
  92               type: :object,
  93               properties: %{
  94                 name: %Schema{type: :string},
  95                 count: %Schema{type: :integer},
  96                 me: %Schema{type: :boolean}
  97               }
  98             }
  99           },
 100           expires_at: %Schema{type: :string, format: "date-time", nullable: true},
 101           in_reply_to_account_acct: %Schema{type: :string, nullable: true},
 102           local: %Schema{type: :boolean},
 103           spoiler_text: %Schema{type: :object, additionalProperties: %Schema{type: :string}},
 104           thread_muted: %Schema{type: :boolean}
 105         }
 106       },
 107       poll: %Schema{type: Poll, nullable: true},
 108       reblog: %Schema{
 109         allOf: [%OpenApiSpex.Reference{"$ref": "#/components/schemas/Status"}],
 110         nullable: true
 111       },
 112       reblogged: %Schema{type: :boolean},
 113       reblogs_count: %Schema{type: :integer},
 114       replies_count: %Schema{type: :integer},
 115       sensitive: %Schema{type: :boolean},
 116       spoiler_text: %Schema{type: :string},
 117       tags: %Schema{
 118         type: :array,
 119         items: %Schema{
 120           type: :object,
 121           properties: %{
 122             name: %Schema{type: :string},
 123             url: %Schema{type: :string}
 124           }
 125         }
 126       },
 127       uri: %Schema{type: :string},
 128       url: %Schema{type: :string},
 129       visibility: VisibilityScope
 130     },
 131     example: %{
 132       "JSON" => %{
 133         "account" => %{
 134           "acct" => "nick6",
 135           "avatar" => "http://localhost:4001/images/avi.png",
 136           "avatar_static" => "http://localhost:4001/images/avi.png",
 137           "bot" => false,
 138           "created_at" => "2020-04-07T19:48:51.000Z",
 139           "display_name" => "Test テスト User 6",
 140           "emojis" => [],
 141           "fields" => [],
 142           "followers_count" => 1,
 143           "following_count" => 0,
 144           "header" => "http://localhost:4001/images/banner.png",
 145           "header_static" => "http://localhost:4001/images/banner.png",
 146           "id" => "9toJCsKN7SmSf3aj5c",
 147           "locked" => false,
 148           "note" => "Tester Number 6",
 149           "pleroma" => %{
 150             "background_image" => nil,
 151             "confirmation_pending" => false,
 152             "hide_favorites" => true,
 153             "hide_followers" => false,
 154             "hide_followers_count" => false,
 155             "hide_follows" => false,
 156             "hide_follows_count" => false,
 157             "is_admin" => false,
 158             "is_moderator" => false,
 159             "relationship" => %{
 160               "blocked_by" => false,
 161               "blocking" => false,
 162               "domain_blocking" => false,
 163               "endorsed" => false,
 164               "followed_by" => false,
 165               "following" => true,
 166               "id" => "9toJCsKN7SmSf3aj5c",
 167               "muting" => false,
 168               "muting_notifications" => false,
 169               "requested" => false,
 170               "showing_reblogs" => true,
 171               "subscribing" => false
 172             },
 173             "skip_thread_containment" => false,
 174             "tags" => []
 175           },
 176           "source" => %{
 177             "fields" => [],
 178             "note" => "Tester Number 6",
 179             "pleroma" => %{"actor_type" => "Person", "discoverable" => false},
 180             "sensitive" => false
 181           },
 182           "statuses_count" => 1,
 183           "url" => "http://localhost:4001/users/nick6",
 184           "username" => "nick6"
 185         },
 186         "application" => %{"name" => "Web", "website" => nil},
 187         "bookmarked" => false,
 188         "card" => nil,
 189         "content" => "foobar",
 190         "created_at" => "2020-04-07T19:48:51.000Z",
 191         "emojis" => [],
 192         "favourited" => false,
 193         "favourites_count" => 0,
 194         "id" => "9toJCu5YZW7O7gfvH6",
 195         "in_reply_to_account_id" => nil,
 196         "in_reply_to_id" => nil,
 197         "language" => nil,
 198         "media_attachments" => [],
 199         "mentions" => [],
 200         "muted" => false,
 201         "pinned" => false,
 202         "pleroma" => %{
 203           "content" => %{"text/plain" => "foobar"},
 204           "conversation_id" => 345_972,
 205           "direct_conversation_id" => nil,
 206           "emoji_reactions" => [],
 207           "expires_at" => nil,
 208           "in_reply_to_account_acct" => nil,
 209           "local" => true,
 210           "spoiler_text" => %{"text/plain" => ""},
 211           "thread_muted" => false
 212         },
 213         "poll" => nil,
 214         "reblog" => nil,
 215         "reblogged" => false,
 216         "reblogs_count" => 0,
 217         "replies_count" => 0,
 218         "sensitive" => false,
 219         "spoiler_text" => "",
 220         "tags" => [],
 221         "uri" => "http://localhost:4001/objects/0f5dad44-0e9e-4610-b377-a2631e499190",
 222         "url" => "http://localhost:4001/notice/9toJCu5YZW7O7gfvH6",
 223         "visibility" => "private"
 224       }
 225     }
 226   })
 227 end