summaryrefslogtreecommitdiff
path: root/lib/pleroma/web/api_spec/operations/user_import_operation.ex
blob: 6292e20043773cc1ccc0f918ba2c9dd74b525675 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
# Pleroma: A lightweight social networking server
# Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
# SPDX-License-Identifier: AGPL-3.0-only

defmodule Pleroma.Web.ApiSpec.UserImportOperation do
  alias OpenApiSpex.Operation
  alias OpenApiSpex.Schema
  alias Pleroma.Web.ApiSpec.Schemas.ApiError

  import Pleroma.Web.ApiSpec.Helpers

  @spec open_api_operation(atom) :: Operation.t()
  def open_api_operation(action) do
    operation = String.to_existing_atom("#{action}_operation")
    apply(__MODULE__, operation, [])
  end

  def follow_operation do
    %Operation{
      tags: ["Data import"],
      summary: "Import follows",
      operationId: "UserImportController.follow",
      requestBody: request_body("Parameters", import_request(), required: true),
      responses: %{
        200 => ok_response(),
        500 => Operation.response("Error", "application/json", ApiError)
      },
      security: [%{"oAuth" => ["write:follow"]}]
    }
  end

  def blocks_operation do
    %Operation{
      tags: ["Data import"],
      summary: "Import blocks",
      operationId: "UserImportController.blocks",
      requestBody: request_body("Parameters", import_request(), required: true),
      responses: %{
        200 => ok_response(),
        500 => Operation.response("Error", "application/json", ApiError)
      },
      security: [%{"oAuth" => ["write:blocks"]}]
    }
  end

  def mutes_operation do
    %Operation{
      tags: ["Data import"],
      summary: "Import mutes",
      operationId: "UserImportController.mutes",
      requestBody: request_body("Parameters", import_request(), required: true),
      responses: %{
        200 => ok_response(),
        500 => Operation.response("Error", "application/json", ApiError)
      },
      security: [%{"oAuth" => ["write:mutes"]}]
    }
  end

  defp import_request do
    %Schema{
      type: :object,
      required: [:list],
      properties: %{
        list: %Schema{
          description:
            "STRING or FILE containing a whitespace-separated list of accounts to import.",
          anyOf: [
            %Schema{type: :string, format: :binary},
            %Schema{type: :string}
          ]
        }
      }
    }
  end

  defp ok_response do
    Operation.response("Ok", "application/json", %Schema{type: :string, example: "ok"})
  end
end