aboutsummaryrefslogtreecommitdiff
path: root/lib/pleroma/web/api_spec/operations/chat_operation.ex
diff options
context:
space:
mode:
Diffstat (limited to 'lib/pleroma/web/api_spec/operations/chat_operation.ex')
-rw-r--r--lib/pleroma/web/api_spec/operations/chat_operation.ex81
1 files changed, 81 insertions, 0 deletions
diff --git a/lib/pleroma/web/api_spec/operations/chat_operation.ex b/lib/pleroma/web/api_spec/operations/chat_operation.ex
new file mode 100644
index 000000000..038ebb29d
--- /dev/null
+++ b/lib/pleroma/web/api_spec/operations/chat_operation.ex
@@ -0,0 +1,81 @@
+# 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.ChatOperation do
+ alias OpenApiSpex.Operation
+ alias OpenApiSpex.Schema
+
+ @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 create_operation do
+ %Operation{
+ tags: ["chat"],
+ summary: "Create a chat",
+ responses: %{
+ 200 =>
+ Operation.response("Chat", "application/json", %Schema{
+ type: :object,
+ description: "A created chat is returned",
+ properties: %{
+ id: %Schema{type: :integer}
+ }
+ })
+ }
+ }
+ end
+
+ def index_operation do
+ %Operation{
+ tags: ["chat"],
+ summary: "Get a list of chats that you participated in",
+ responses: %{
+ 200 =>
+ Operation.response("Chats", "application/json", %Schema{
+ type: :array,
+ description: "A list of chats",
+ items: %Schema{
+ type: :object,
+ description: "A chat"
+ }
+ })
+ }
+ }
+ end
+
+ def messages_operation do
+ %Operation{
+ tags: ["chat"],
+ summary: "Get the most recent messages of the chat",
+ responses: %{
+ 200 =>
+ Operation.response("Messages", "application/json", %Schema{
+ type: :array,
+ description: "A list of chat messages",
+ items: %Schema{
+ type: :object,
+ description: "A chat message"
+ }
+ })
+ }
+ }
+ end
+
+ def post_chat_message_operation do
+ %Operation{
+ tags: ["chat"],
+ summary: "Post a message to the chat",
+ responses: %{
+ 200 =>
+ Operation.response("Message", "application/json", %Schema{
+ type: :object,
+ description: "A chat message"
+ })
+ }
+ }
+ end
+end