logo

pleroma

My custom branche(s) on git.pleroma.social/pleroma/pleroma git clone https://hacktivis.me/git/pleroma.git

status.ex (14105B)

    

  1. # Pleroma: A lightweight social networking server
  2. # Copyright © 2017-2022 Pleroma Authors <https://pleroma.social/>
  3. # SPDX-License-Identifier: AGPL-3.0-only
  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
  15.   require OpenApiSpex
  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.       edited_at: %Schema{
  77.         type: :string,
  78.         format: "date-time",
  79.         nullable: true,
  80.         description: "The date when this status was last edited"
  81.       },
  82.       emojis: %Schema{
  83.         type: :array,
  84.         items: Emoji,
  85.         description: "Custom emoji to be used when rendering status content"
  86.       },
  87.       favourited: %Schema{type: :boolean, description: "Have you favourited this status?"},
  88.       favourites_count: %Schema{
  89.         type: :integer,
  90.         description: "How many favourites this status has received"
  91.       },
  92.       id: FlakeID,
  93.       in_reply_to_account_id: %Schema{
  94.         allOf: [FlakeID],
  95.         nullable: true,
  96.         description: "ID of the account being replied to"
  97.       },
  98.       in_reply_to_id: %Schema{
  99.         allOf: [FlakeID],
  100.         nullable: true,
  101.         description: "ID of the status being replied"
  102.       },
  103.       language: %Schema{
  104.         type: :string,
  105.         nullable: true,
  106.         description: "Primary language of this status"
  107.       },
  108.       media_attachments: %Schema{
  109.         type: :array,
  110.         items: Attachment,
  111.         description: "Media that is attached to this status"
  112.       },
  113.       mentions: %Schema{
  114.         type: :array,
  115.         description: "Mentions of users within the status content",
  116.         items: %Schema{
  117.           type: :object,
  118.           properties: %{
  119.             id: %Schema{allOf: [FlakeID], description: "The account id of the mentioned user"},
  120.             acct: %Schema{
  121.               type: :string,
  122.               description:
  123.                 "The webfinger acct: URI of the mentioned user. Equivalent to `username` for local users, or `username@domain` for remote users."
  124.             },
  125.             username: %Schema{type: :string, description: "The username of the mentioned user"},
  126.             url: %Schema{
  127.               type: :string,
  128.               format: :uri,
  129.               description: "The location of the mentioned user's profile"
  130.             }
  131.           }
  132.         }
  133.       },
  134.       muted: %Schema{
  135.         type: :boolean,
  136.         description: "Have you muted notifications for this status's conversation?"
  137.       },
  138.       pinned: %Schema{
  139.         type: :boolean,
  140.         description: "Have you pinned this status? Only appears if the status is pinnable."
  141.       },
  142.       pleroma: %Schema{
  143.         type: :object,
  144.         properties: %{
  145.           content: %Schema{
  146.             type: :object,
  147.             additionalProperties: %Schema{
  148.               type: :string,
  149.               description: "Alternate representation in the MIME type specified",
  150.               extensions: %{"x-additionalPropertiesName": "MIME type"}
  151.             },
  152.             description:
  153.               "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`"
  154.           },
  155.           context: %Schema{
  156.             type: :string,
  157.             description: "The thread identifier the status is associated with"
  158.           },
  159.           conversation_id: %Schema{
  160.             type: :integer,
  161.             deprecated: true,
  162.             description:
  163.               "The ID of the AP context the status is associated with (if any); deprecated, please use `context` instead"
  164.           },
  165.           direct_conversation_id: %Schema{
  166.             type: :integer,
  167.             nullable: true,
  168.             description:
  169.               "The ID of the Mastodon direct message conversation the status is associated with (if any)"
  170.           },
  171.           emoji_reactions: %Schema{
  172.             type: :array,
  173.             description:
  174.               "A list with emoji / reaction maps. Contains no information about the reacting users, for that use the /statuses/:id/reactions endpoint.",
  175.             items: %Schema{
  176.               type: :object,
  177.               properties: %{
  178.                 name: %Schema{type: :string},
  179.                 count: %Schema{type: :integer},
  180.                 me: %Schema{type: :boolean}
  181.               }
  182.             }
  183.           },
  184.           expires_at: %Schema{
  185.             type: :string,
  186.             format: "date-time",
  187.             nullable: true,
  188.             description:
  189.               "A datetime (ISO 8601) that states when the post will expire (be deleted automatically), or empty if the post won't expire"
  190.           },
  191.           in_reply_to_account_acct: %Schema{
  192.             type: :string,
  193.             nullable: true,
  194.             description: "The `acct` property of User entity for replied user (if any)"
  195.           },
  196.           quote: %Schema{
  197.             allOf: [%OpenApiSpex.Reference{"$ref": "#/components/schemas/Status"}],
  198.             nullable: true,
  199.             description: "Quoted status (if any)"
  200.           },
  201.           quote_id: %Schema{
  202.             nullable: true,
  203.             allOf: [FlakeID],
  204.             description: "ID of the status being quoted, if any"
  205.           },
  206.           quote_url: %Schema{
  207.             type: :string,
  208.             format: :uri,
  209.             nullable: true,
  210.             description: "URL of the quoted status"
  211.           },
  212.           quote_visible: %Schema{
  213.             type: :boolean,
  214.             description: "`true` if the quoted post is visible to the user"
  215.           },
  216.           quotes_count: %Schema{
  217.             type: :integer,
  218.             description: "How many statuses quoted this status"
  219.           },
  220.           local: %Schema{
  221.             type: :boolean,
  222.             description: "`true` if the post was made on the local instance"
  223.           },
  224.           spoiler_text: %Schema{
  225.             type: :object,
  226.             additionalProperties: %Schema{
  227.               type: :string,
  228.               description: "Alternate representation in the MIME type specified",
  229.               extensions: %{"x-additionalPropertiesName": "MIME type"}
  230.             },
  231.             description:
  232.               "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`."
  233.           },
  234.           thread_muted: %Schema{
  235.             type: :boolean,
  236.             description: "`true` if the thread the post belongs to is muted"
  237.           },
  238.           parent_visible: %Schema{
  239.             type: :boolean,
  240.             description: "`true` if the parent post is visible to the user"
  241.           },
  242.           pinned_at: %Schema{
  243.             type: :string,
  244.             format: "date-time",
  245.             nullable: true,
  246.             description:
  247.               "A datetime (ISO 8601) that states when the post was pinned or `null` if the post is not pinned"
  248.           }
  249.         }
  250.       },
  251.       poll: %Schema{allOf: [Poll], nullable: true, description: "The poll attached to the status"},
  252.       reblog: %Schema{
  253.         allOf: [%OpenApiSpex.Reference{"$ref": "#/components/schemas/Status"}],
  254.         nullable: true,
  255.         description: "The status being reblogged"
  256.       },
  257.       reblogged: %Schema{type: :boolean, description: "Have you boosted this status?"},
  258.       reblogs_count: %Schema{
  259.         type: :integer,
  260.         description: "How many boosts this status has received"
  261.       },
  262.       replies_count: %Schema{
  263.         type: :integer,
  264.         description: "How many replies this status has received"
  265.       },
  266.       sensitive: %Schema{
  267.         type: :boolean,
  268.         description: "Is this status marked as sensitive content?"
  269.       },
  270.       spoiler_text: %Schema{
  271.         type: :string,
  272.         description:
  273.           "Subject or summary line, below which status content is collapsed until expanded"
  274.       },
  275.       tags: %Schema{type: :array, items: Tag},
  276.       uri: %Schema{
  277.         type: :string,
  278.         format: :uri,
  279.         description: "URI of the status used for federation"
  280.       },
  281.       url: %Schema{
  282.         type: :string,
  283.         nullable: true,
  284.         format: :uri,
  285.         description: "A link to the status's HTML representation"
  286.       },
  287.       visibility: %Schema{
  288.         allOf: [VisibilityScope],
  289.         description: "Visibility of this status"
  290.       }
  291.     },
  292.     example: %{
  293.       "account" => %{
  294.         "acct" => "nick6",
  295.         "avatar" => "http://localhost:4001/images/avi.png",
  296.         "avatar_static" => "http://localhost:4001/images/avi.png",
  297.         "bot" => false,
  298.         "created_at" => "2020-04-07T19:48:51.000Z",
  299.         "display_name" => "Test テスト User 6",
  300.         "emojis" => [],
  301.         "fields" => [],
  302.         "followers_count" => 1,
  303.         "following_count" => 0,
  304.         "header" => "http://localhost:4001/images/banner.png",
  305.         "header_static" => "http://localhost:4001/images/banner.png",
  306.         "id" => "9toJCsKN7SmSf3aj5c",
  307.         "is_locked" => false,
  308.         "note" => "Tester Number 6",
  309.         "pleroma" => %{
  310.           "background_image" => nil,
  311.           "is_confirmed" => true,
  312.           "hide_favorites" => true,
  313.           "hide_followers" => false,
  314.           "hide_followers_count" => false,
  315.           "hide_follows" => false,
  316.           "hide_follows_count" => false,
  317.           "is_admin" => false,
  318.           "is_moderator" => false,
  319.           "relationship" => %{
  320.             "blocked_by" => false,
  321.             "blocking" => false,
  322.             "domain_blocking" => false,
  323.             "endorsed" => false,
  324.             "followed_by" => false,
  325.             "following" => true,
  326.             "id" => "9toJCsKN7SmSf3aj5c",
  327.             "muting" => false,
  328.             "muting_notifications" => false,
  329.             "note" => "",
  330.             "requested" => false,
  331.             "showing_reblogs" => true,
  332.             "subscribing" => false,
  333.             "notifying" => false
  334.           },
  335.           "skip_thread_containment" => false,
  336.           "tags" => []
  337.         },
  338.         "source" => %{
  339.           "fields" => [],
  340.           "note" => "Tester Number 6",
  341.           "pleroma" => %{"actor_type" => "Person", "discoverable" => false},
  342.           "sensitive" => false
  343.         },
  344.         "statuses_count" => 1,
  345.         "url" => "http://localhost:4001/users/nick6",
  346.         "username" => "nick6"
  347.       },
  348.       "application" => nil,
  349.       "bookmarked" => false,
  350.       "card" => nil,
  351.       "content" => "foobar",
  352.       "created_at" => "2020-04-07T19:48:51.000Z",
  353.       "emojis" => [],
  354.       "favourited" => false,
  355.       "favourites_count" => 0,
  356.       "id" => "9toJCu5YZW7O7gfvH6",
  357.       "in_reply_to_account_id" => nil,
  358.       "in_reply_to_id" => nil,
  359.       "language" => nil,
  360.       "media_attachments" => [],
  361.       "mentions" => [],
  362.       "muted" => false,
  363.       "pinned" => false,
  364.       "pleroma" => %{
  365.         "content" => %{"text/plain" => "foobar"},
  366.         "context" => "http://localhost:4001/objects/8b4c0c80-6a37-4d2a-b1b9-05a19e3875aa",
  367.         "conversation_id" => 345_972,
  368.         "direct_conversation_id" => nil,
  369.         "emoji_reactions" => [],
  370.         "expires_at" => nil,
  371.         "in_reply_to_account_acct" => nil,
  372.         "local" => true,
  373.         "spoiler_text" => %{"text/plain" => ""},
  374.         "thread_muted" => false,
  375.         "quotes_count" => 0
  376.       },
  377.       "poll" => nil,
  378.       "reblog" => nil,
  379.       "reblogged" => false,
  380.       "reblogs_count" => 0,
  381.       "replies_count" => 0,
  382.       "sensitive" => false,
  383.       "spoiler_text" => "",
  384.       "tags" => [],
  385.       "uri" => "http://localhost:4001/objects/0f5dad44-0e9e-4610-b377-a2631e499190",
  386.       "url" => "http://localhost:4001/notice/9toJCu5YZW7O7gfvH6",
  387.       "visibility" => "private"
  388.     }
  389.   })
  390. end