1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2020 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.Web.ApiSpec.Admin.ChatOperation do
6 alias OpenApiSpex.Operation
7 alias Pleroma.Web.ApiSpec.Schemas.ApiError
8 alias Pleroma.Web.ApiSpec.Schemas.Chat
9 alias Pleroma.Web.ApiSpec.Schemas.FlakeID
11 import Pleroma.Web.ApiSpec.Helpers
13 def open_api_operation(action) do
14 operation = String.to_existing_atom("#{action}_operation")
15 apply(__MODULE__, operation, [])
18 def delete_message_operation do
20 tags: ["admin", "chat"],
21 summary: "Delete an individual chat message",
22 operationId: "AdminAPI.ChatController.delete",
23 parameters: [id_param(), message_id_param()] ++ admin_api_params(),
24 security: [%{"oAuth" => ["write:chats"]}],
26 200 => empty_object_response(),
27 404 => Operation.response("Not Found", "application/json", ApiError)
32 def messages_operation do
34 tags: ["admin", "chat"],
35 summary: "Get the most recent messages of the chat",
36 operationId: "AdminAPI.ChatController.messages",
38 [Operation.parameter(:id, :path, :string, "The ID of the Chat")] ++
43 "The messages in the chat",
45 Pleroma.Web.ApiSpec.ChatOperation.chat_messages_response()
50 "oAuth" => ["read:chats"]
59 summary: "Create a chat",
60 operationId: "AdminAPI.ChatController.show",
88 Operation.parameter(:id, :path, FlakeID, "Chat ID",
89 example: "9umDrYheeY451cQnEe",
94 def message_id_param do
95 Operation.parameter(:message_id, :path, FlakeID, "Chat message ID",
96 example: "9umDrYheeY451cQnEe",