aboutsummaryrefslogtreecommitdiff
path: root/lib/pleroma/web/api_spec/operations/admin/chat_operation.ex
blob: a382bd35aba876d1a5cb832436e5d0639217ed0a (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
# Pleroma: A lightweight social networking server
# Copyright © 2017-2020 Pleroma Authors <https://pleroma.social/>
# SPDX-License-Identifier: AGPL-3.0-only

defmodule Pleroma.Web.ApiSpec.Admin.ChatOperation do
  alias OpenApiSpex.Operation
  alias Pleroma.Web.ApiSpec.Schemas.ApiError
  alias Pleroma.Web.ApiSpec.Schemas.FlakeID

  import Pleroma.Web.ApiSpec.Helpers

  def open_api_operation(action) do
    operation = String.to_existing_atom("#{action}_operation")
    apply(__MODULE__, operation, [])
  end

  def delete_message_operation do
    %Operation{
      tags: ["admin", "chat"],
      summary: "Delete an individual chat message",
      operationId: "AdminAPI.ChatController.delete",
      parameters: [id_param(), message_id_param()] ++ admin_api_params(),
      security: [%{"oAuth" => ["write:chats"]}],
      responses: %{
        200 => empty_object_response(),
        404 => Operation.response("Not Found", "application/json", ApiError)
      }
    }
  end

  def messages_operation do
    %Operation{
      tags: ["admin", "chat"],
      summary: "Get the most recent messages of the chat",
      operationId: "AdminAPI.ChatController.messages",
      parameters:
        [Operation.parameter(:id, :path, :string, "The ID of the Chat")] ++
          pagination_params(),
      responses: %{
        200 =>
          Operation.response(
            "The messages in the chat",
            "application/json",
            Pleroma.Web.ApiSpec.ChatOperation.chat_messages_response()
          )
      },
      security: [
        %{
          "oAuth" => ["read:chats"]
        }
      ]
    }
  end

  def id_param do
    Operation.parameter(:id, :path, FlakeID, "Chat ID",
      example: "9umDrYheeY451cQnEe",
      required: true
    )
  end

  def message_id_param do
    Operation.parameter(:message_id, :path, FlakeID, "Chat message ID",
      example: "9umDrYheeY451cQnEe",
      required: true
    )
  end
end