1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.Web.ApiSpec.Admin.StatusOperation do
6 alias OpenApiSpex.Operation
7 alias OpenApiSpex.Schema
8 alias Pleroma.Web.ApiSpec.Schemas.Account
9 alias Pleroma.Web.ApiSpec.Schemas.ApiError
10 alias Pleroma.Web.ApiSpec.Schemas.FlakeID
11 alias Pleroma.Web.ApiSpec.Schemas.Status
12 alias Pleroma.Web.ApiSpec.Schemas.VisibilityScope
14 import Pleroma.Web.ApiSpec.Helpers
15 import Pleroma.Web.ApiSpec.StatusOperation, only: [id_param: 0]
17 def open_api_operation(action) do
18 operation = String.to_existing_atom("#{action}_operation")
19 apply(__MODULE__, operation, [])
22 def index_operation do
24 tags: ["Status administration"],
25 operationId: "AdminAPI.StatusController.index",
26 summary: "Get all statuses",
27 security: [%{"oAuth" => ["admin:read:statuses"]}],
32 %Schema{type: :boolean, default: false},
33 "Allows to see private statuses"
38 %Schema{type: :boolean, default: false},
39 "Excludes remote statuses"
44 %Schema{type: :boolean, default: false},
45 "Allows to see reblogs"
50 %Schema{type: :integer, default: 1},
56 %Schema{type: :integer, default: 50},
57 "Number of statuses to return"
63 Operation.response("Array of statuses", "application/json", %Schema{
73 tags: ["Status adminitration)"],
74 summary: "Get status",
75 operationId: "AdminAPI.StatusController.show",
76 parameters: [id_param() | admin_api_params()],
77 security: [%{"oAuth" => ["admin:read:statuses"]}],
79 200 => Operation.response("Status", "application/json", status()),
80 404 => Operation.response("Not Found", "application/json", ApiError)
85 def update_operation do
87 tags: ["Status adminitration)"],
88 summary: "Change the scope of a status",
89 operationId: "AdminAPI.StatusController.update",
90 parameters: [id_param() | admin_api_params()],
91 security: [%{"oAuth" => ["admin:write:statuses"]}],
92 requestBody: request_body("Parameters", update_request(), required: true),
94 200 => Operation.response("Status", "application/json", Status),
95 400 => Operation.response("Error", "application/json", ApiError)
100 def delete_operation do
102 tags: ["Status adminitration)"],
103 summary: "Delete status",
104 operationId: "AdminAPI.StatusController.delete",
105 parameters: [id_param() | admin_api_params()],
106 security: [%{"oAuth" => ["admin:write:statuses"]}],
108 200 => empty_object_response(),
109 404 => Operation.response("Not Found", "application/json", ApiError)
121 account: %Schema{allOf: [Account, admin_account()]}
133 avatar: %Schema{type: :string},
134 nickname: %Schema{type: :string},
135 display_name: %Schema{type: :string},
136 is_active: %Schema{type: :boolean},
137 local: %Schema{type: :boolean},
141 admin: %Schema{type: :boolean},
142 moderator: %Schema{type: :boolean}
145 tags: %Schema{type: :string},
146 is_confirmed: %Schema{type: :string}
151 defp update_request do
157 description: "Mark status and attached media as sensitive?"
159 visibility: VisibilityScope
162 "visibility" => "private",
163 "sensitive" => "false"