logo

pleroma

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

instance_operation.ex (11524B)

    

  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.InstanceOperation do
  6.   alias OpenApiSpex.Operation
  7.   alias OpenApiSpex.Schema
  9.   def open_api_operation(action) do
  10.     operation = String.to_existing_atom("#{action}_operation")
  11.     apply(__MODULE__, operation, [])
  12.   end
  14.   def show_operation do
  15.     %Operation{
  16.       tags: ["Instance misc"],
  17.       summary: "Retrieve instance information",
  18.       description: "Information about the server",
  19.       operationId: "InstanceController.show",
  20.       responses: %{
  21.         200 => Operation.response("Instance", "application/json", instance())
  22.       }
  23.     }
  24.   end
  26.   def show2_operation do
  27.     %Operation{
  28.       tags: ["Instance misc"],
  29.       summary: "Retrieve instance information",
  30.       description: "Information about the server",
  31.       operationId: "InstanceController.show2",
  32.       responses: %{
  33.         200 => Operation.response("Instance", "application/json", instance2())
  34.       }
  35.     }
  36.   end
  38.   def peers_operation do
  39.     %Operation{
  40.       tags: ["Instance misc"],
  41.       summary: "Retrieve list of known instances",
  42.       operationId: "InstanceController.peers",
  43.       responses: %{
  44.         200 => Operation.response("Array of domains", "application/json", array_of_domains())
  45.       }
  46.     }
  47.   end
  49.   defp instance do
  50.     %Schema{
  51.       type: :object,
  52.       properties: %{
  53.         uri: %Schema{type: :string, description: "The domain name of the instance"},
  54.         title: %Schema{type: :string, description: "The title of the website"},
  55.         description: %Schema{
  56.           type: :string,
  57.           description: "Admin-defined description of the Pleroma site"
  58.         },
  59.         version: %Schema{
  60.           type: :string,
  61.           description: "The version of Pleroma installed on the instance"
  62.         },
  63.         email: %Schema{
  64.           type: :string,
  65.           description: "An email that may be contacted for any inquiries",
  66.           format: :email
  67.         },
  68.         urls: %Schema{
  69.           type: :object,
  70.           description: "URLs of interest for clients apps",
  71.           properties: %{
  72.             streaming_api: %Schema{
  73.               type: :string,
  74.               description: "Websockets address for push streaming"
  75.             }
  76.           }
  77.         },
  78.         stats: %Schema{
  79.           type: :object,
  80.           description: "Statistics about how much information the instance contains",
  81.           properties: %{
  82.             user_count: %Schema{
  83.               type: :integer,
  84.               description: "Users registered on this instance"
  85.             },
  86.             status_count: %Schema{
  87.               type: :integer,
  88.               description: "Statuses authored by users on instance"
  89.             },
  90.             domain_count: %Schema{
  91.               type: :integer,
  92.               description: "Domains federated with this instance"
  93.             }
  94.           }
  95.         },
  96.         thumbnail: %Schema{
  97.           type: :string,
  98.           description: "Banner image for the website",
  99.           nullable: true
  100.         },
  101.         languages: %Schema{
  102.           type: :array,
  103.           items: %Schema{type: :string},
  104.           description: "Primary languages of the website and its staff"
  105.         },
  106.         registrations: %Schema{type: :boolean, description: "Whether registrations are enabled"},
  107.         # Extra (not present in Mastodon):
  108.         max_toot_chars: %Schema{
  109.           type: :integer,
  110.           description: ": Posts character limit (CW/Subject included in the counter)"
  111.         },
  112.         poll_limits: %Schema{
  113.           type: :object,
  114.           description: "A map with poll limits for local polls",
  115.           properties: %{
  116.             max_options: %Schema{
  117.               type: :integer,
  118.               description: "Maximum number of options."
  119.             },
  120.             max_option_chars: %Schema{
  121.               type: :integer,
  122.               description: "Maximum number of characters per option."
  123.             },
  124.             min_expiration: %Schema{
  125.               type: :integer,
  126.               description: "Minimum expiration time (in seconds)."
  127.             },
  128.             max_expiration: %Schema{
  129.               type: :integer,
  130.               description: "Maximum expiration time (in seconds)."
  131.             }
  132.           }
  133.         },
  134.         upload_limit: %Schema{
  135.           type: :integer,
  136.           description: "File size limit of uploads (except for avatar, background, banner)"
  137.         },
  138.         avatar_upload_limit: %Schema{type: :integer, description: "The title of the website"},
  139.         background_upload_limit: %Schema{type: :integer, description: "The title of the website"},
  140.         banner_upload_limit: %Schema{type: :integer, description: "The title of the website"},
  141.         background_image: %Schema{
  142.           type: :string,
  143.           format: :uri,
  144.           description: "The background image for the website"
  145.         }
  146.       },
  147.       example: %{
  148.         "avatar_upload_limit" => 2_000_000,
  149.         "background_upload_limit" => 4_000_000,
  150.         "background_image" => "/static/image.png",
  151.         "banner_upload_limit" => 4_000_000,
  152.         "description" => "Pleroma: An efficient and flexible fediverse server",
  153.         "email" => "lain@lain.com",
  154.         "languages" => ["en"],
  155.         "max_toot_chars" => 5000,
  156.         "poll_limits" => %{
  157.           "max_expiration" => 31_536_000,
  158.           "max_option_chars" => 200,
  159.           "max_options" => 20,
  160.           "min_expiration" => 0
  161.         },
  162.         "registrations" => false,
  163.         "stats" => %{
  164.           "domain_count" => 2996,
  165.           "status_count" => 15_802,
  166.           "user_count" => 5
  167.         },
  168.         "thumbnail" => "https://lain.com/instance/thumbnail.jpeg",
  169.         "title" => "lain.com",
  170.         "upload_limit" => 16_000_000,
  171.         "uri" => "https://lain.com",
  172.         "urls" => %{
  173.           "streaming_api" => "wss://lain.com"
  174.         },
  175.         "version" => "2.7.2 (compatible; Pleroma 2.0.50-536-g25eec6d7-develop)"
  176.       }
  177.     }
  178.   end
  180.   defp instance2 do
  181.     %Schema{
  182.       type: :object,
  183.       properties: %{
  184.         domain: %Schema{type: :string, description: "The domain name of the instance"},
  185.         title: %Schema{type: :string, description: "The title of the website"},
  186.         version: %Schema{
  187.           type: :string,
  188.           description: "The version of Pleroma installed on the instance"
  189.         },
  190.         source_url: %Schema{
  191.           type: :string,
  192.           description: "The version of Pleroma installed on the instance"
  193.         },
  194.         description: %Schema{
  195.           type: :string,
  196.           description: "Admin-defined description of the Pleroma site"
  197.         },
  198.         usage: %Schema{
  199.           type: :object,
  200.           description: "Instance usage statistics",
  201.           properties: %{
  202.             users: %Schema{
  203.               type: :object,
  204.               description: "User count statistics",
  205.               properties: %{
  206.                 active_month: %Schema{
  207.                   type: :integer,
  208.                   description: "Monthly active users"
  209.                 }
  210.               }
  211.             }
  212.           }
  213.         },
  214.         email: %Schema{
  215.           type: :string,
  216.           description: "An email that may be contacted for any inquiries",
  217.           format: :email
  218.         },
  219.         urls: %Schema{
  220.           type: :object,
  221.           description: "URLs of interest for clients apps",
  222.           properties: %{}
  223.         },
  224.         stats: %Schema{
  225.           type: :object,
  226.           description: "Statistics about how much information the instance contains",
  227.           properties: %{
  228.             user_count: %Schema{
  229.               type: :integer,
  230.               description: "Users registered on this instance"
  231.             },
  232.             status_count: %Schema{
  233.               type: :integer,
  234.               description: "Statuses authored by users on instance"
  235.             },
  236.             domain_count: %Schema{
  237.               type: :integer,
  238.               description: "Domains federated with this instance"
  239.             }
  240.           }
  241.         },
  242.         thumbnail: %Schema{
  243.           type: :object,
  244.           properties: %{
  245.             url: %Schema{
  246.               type: :string,
  247.               description: "Banner image for the website",
  248.               nullable: true
  249.             }
  250.           }
  251.         },
  252.         languages: %Schema{
  253.           type: :array,
  254.           items: %Schema{type: :string},
  255.           description: "Primary languages of the website and its staff"
  256.         },
  257.         registrations: %Schema{
  258.           type: :object,
  259.           description: "Registrations-related configuration",
  260.           properties: %{
  261.             enabled: %Schema{
  262.               type: :boolean,
  263.               description: "Whether registrations are enabled"
  264.             },
  265.             approval_required: %Schema{
  266.               type: :boolean,
  267.               description: "Whether users need to be manually approved by admin"
  268.             }
  269.           }
  270.         },
  271.         configuration: %Schema{
  272.           type: :object,
  273.           description: "Instance configuration",
  274.           properties: %{
  275.             urls: %Schema{
  276.               type: :object,
  277.               properties: %{
  278.                 streaming: %Schema{
  279.                   type: :string,
  280.                   description: "Websockets address for push streaming"
  281.                 }
  282.               }
  283.             },
  284.             statuses: %Schema{
  285.               type: :object,
  286.               description: "A map with poll limits for local statuses",
  287.               properties: %{
  288.                 max_characters: %Schema{
  289.                   type: :integer,
  290.                   description: "Posts character limit (CW/Subject included in the counter)"
  291.                 },
  292.                 max_media_attachments: %Schema{
  293.                   type: :integer,
  294.                   description: "Media attachment limit"
  295.                 }
  296.               }
  297.             },
  298.             media_attachments: %Schema{
  299.               type: :object,
  300.               description: "A map with poll limits for media attachments",
  301.               properties: %{
  302.                 image_size_limit: %Schema{
  303.                   type: :integer,
  304.                   description: "File size limit of uploaded images"
  305.                 },
  306.                 video_size_limit: %Schema{
  307.                   type: :integer,
  308.                   description: "File size limit of uploaded videos"
  309.                 }
  310.               }
  311.             },
  312.             polls: %Schema{
  313.               type: :object,
  314.               description: "A map with poll limits for local polls",
  315.               properties: %{
  316.                 max_options: %Schema{
  317.                   type: :integer,
  318.                   description: "Maximum number of options."
  319.                 },
  320.                 max_characters_per_option: %Schema{
  321.                   type: :integer,
  322.                   description: "Maximum number of characters per option."
  323.                 },
  324.                 min_expiration: %Schema{
  325.                   type: :integer,
  326.                   description: "Minimum expiration time (in seconds)."
  327.                 },
  328.                 max_expiration: %Schema{
  329.                   type: :integer,
  330.                   description: "Maximum expiration time (in seconds)."
  331.                 }
  332.               }
  333.             }
  334.           }
  335.         }
  336.       }
  337.     }
  338.   end
  340.   defp array_of_domains do
  341.     %Schema{
  342.       type: :array,
  343.       items: %Schema{type: :string},
  344.       example: ["pleroma.site", "lain.com", "bikeshed.party"]
  345.     }
  346.   end
  347. end