logo

pleroma

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

instance_operation.ex (13144B)

    

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