git.squeep.com Git - akkoma/blob - lib/pleroma/web/api_spec/operations/admin/status_operation.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.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
  13
  14   import Pleroma.Web.ApiSpec.Helpers
  15   import Pleroma.Web.ApiSpec.StatusOperation, only: [id_param: 0]
  16
  17   def open_api_operation(action) do
  18     operation = String.to_existing_atom("#{action}_operation")
  19     apply(__MODULE__, operation, [])
  20   end
  21
  22   def index_operation do
  23     %Operation{
  24       tags: ["Admin", "Statuses"],
  25       operationId: "AdminAPI.StatusController.index",
  26       security: [%{"oAuth" => ["read:statuses"]}],
  27       parameters: [
  28         Operation.parameter(
  29           :godmode,
  30           :query,
  31           %Schema{type: :boolean, default: false},
  32           "Allows to see private statuses"
  33         ),
  34         Operation.parameter(
  35           :local_only,
  36           :query,
  37           %Schema{type: :boolean, default: false},
  38           "Excludes remote statuses"
  39         ),
  40         Operation.parameter(
  41           :with_reblogs,
  42           :query,
  43           %Schema{type: :boolean, default: false},
  44           "Allows to see reblogs"
  45         ),
  46         Operation.parameter(
  47           :page,
  48           :query,
  49           %Schema{type: :integer, default: 1},
  50           "Page"
  51         ),
  52         Operation.parameter(
  53           :page_size,
  54           :query,
  55           %Schema{type: :integer, default: 50},
  56           "Number of statuses to return"
  57         )
  58       ],
  59       responses: %{
  60         200 =>
  61           Operation.response("Array of statuses", "application/json", %Schema{
  62             type: :array,
  63             items: status()
  64           })
  65       }
  66     }
  67   end
  68
  69   def show_operation do
  70     %Operation{
  71       tags: ["Admin", "Statuses"],
  72       summary: "Show Status",
  73       operationId: "AdminAPI.StatusController.show",
  74       parameters: [id_param()],
  75       security: [%{"oAuth" => ["read:statuses"]}],
  76       responses: %{
  77         200 => Operation.response("Status", "application/json", Status),
  78         404 => Operation.response("Not Found", "application/json", ApiError)
  79       }
  80     }
  81   end
  82
  83   def update_operation do
  84     %Operation{
  85       tags: ["Admin", "Statuses"],
  86       summary: "Change the scope of an individual reported status",
  87       operationId: "AdminAPI.StatusController.update",
  88       parameters: [id_param()],
  89       security: [%{"oAuth" => ["write:statuses"]}],
  90       requestBody: request_body("Parameters", update_request(), required: true),
  91       responses: %{
  92         200 => Operation.response("Status", "application/json", Status),
  93         400 => Operation.response("Error", "application/json", ApiError)
  94       }
  95     }
  96   end
  97
  98   def delete_operation do
  99     %Operation{
 100       tags: ["Admin", "Statuses"],
 101       summary: "Delete an individual reported status",
 102       operationId: "AdminAPI.StatusController.delete",
 103       parameters: [id_param()],
 104       security: [%{"oAuth" => ["write:statuses"]}],
 105       responses: %{
 106         200 => empty_object_response(),
 107         404 => Operation.response("Not Found", "application/json", ApiError)
 108       }
 109     }
 110   end
 111
 112   defp status do
 113     %Schema{
 114       anyOf: [
 115         Status,
 116         %Schema{
 117           type: :object,
 118           properties: %{
 119             account: %Schema{allOf: [Account, admin_account()]}
 120           }
 121         }
 122       ]
 123     }
 124   end
 125
 126   defp admin_account do
 127     %Schema{
 128       type: :object,
 129       properties: %{
 130         id: FlakeID,
 131         avatar: %Schema{type: :string},
 132         nickname: %Schema{type: :string},
 133         display_name: %Schema{type: :string},
 134         deactivated: %Schema{type: :boolean},
 135         local: %Schema{type: :boolean},
 136         roles: %Schema{
 137           type: :object,
 138           properties: %{
 139             admin: %Schema{type: :boolean},
 140             moderator: %Schema{type: :boolean}
 141           }
 142         },
 143         tags: %Schema{type: :string},
 144         confirmation_pending: %Schema{type: :string}
 145       }
 146     }
 147   end
 148
 149   defp update_request do
 150     %Schema{
 151       type: :object,
 152       properties: %{
 153         sensitive: %Schema{
 154           type: :boolean,
 155           description: "Mark status and attached media as sensitive?"
 156         },
 157         visibility: VisibilityScope
 158       },
 159       example: %{
 160         "visibility" => "private",
 161         "sensitive" => "false"
 162       }
 163     }
 164   end
 165 end