Beefox/akkoma
1
0
Fork 0
forked from AkkomaGang/akkoma
Code Issues Pull requests Projects Releases Packages Wiki Activity

update api spec for custom emoji reaction

Browse source
This commit is contained in:
FloatingGhost 2022-06-25 15:45:10 +01:00
parent cac39ef817
commit 45b7d18871
1 changed files with 35 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
lib/pleroma/web/api_spec/operations/emoji_reaction_operation.ex
View file

@ -43,10 +43,14 @@ def index_operation do
def create_operation do def create_operation do
%Operation{ %Operation{
tags: ["Emoji reactions"], tags: ["Emoji reactions"],
summary: "React to a post with a unicode emoji", summary: "React to a post with either a unicode or custom emoji",
parameters: [ parameters: [
Operation.parameter(:id, :path, FlakeID, "Status ID", required: true), Operation.parameter(:id, :path, FlakeID, "Status ID", required: true),
Operation.parameter(:emoji, :path, :string, "A single character unicode emoji", Operation.parameter(
:emoji,
:path,
:string,
"A single character unicode emoji, or a \:shortcode\: format emoji name",
required: true required: true
) )
], ],
@ -62,10 +66,14 @@ def create_operation do
def delete_operation do def delete_operation do
%Operation{ %Operation{
tags: ["Emoji reactions"], tags: ["Emoji reactions"],
summary: "Remove a reaction to a post with a unicode emoji", summary: "Remove a reaction to a post with either a unicode or custom emoji",
parameters: [ parameters: [
Operation.parameter(:id, :path, FlakeID, "Status ID", required: true), Operation.parameter(:id, :path, FlakeID, "Status ID", required: true),
Operation.parameter(:emoji, :path, :string, "A single character unicode emoji", Operation.parameter(
:emoji,
:path,
:string,
"A single character unicode emoji, or a \:shortcode\: format emoji name",
required: true required: true
) )
], ],
@ -81,7 +89,7 @@ defp array_of_reactions_response do
Operation.response("Array of Emoji reactions", "application/json", %Schema{ Operation.response("Array of Emoji reactions", "application/json", %Schema{
type: :array, type: :array,
items: emoji_reaction(), items: emoji_reaction(),
example: [emoji_reaction().example] example: emoji_reaction().example
}) })
end end
@ -93,18 +101,34 @@ defp emoji_reaction do
name: %Schema{type: :string, description: "Emoji"}, name: %Schema{type: :string, description: "Emoji"},
count: %Schema{type: :integer, description: "Count of reactions with this emoji"}, count: %Schema{type: :integer, description: "Count of reactions with this emoji"},
me: %Schema{type: :boolean, description: "Did I react with this emoji?"}, me: %Schema{type: :boolean, description: "Did I react with this emoji?"},
url: %Schema{
type: :string,
description: "URL of the emoji if it's custom - otherwise null",
nullable: true,
format: "url"
},
accounts: %Schema{ accounts: %Schema{
type: :array, type: :array,
items: Account, items: Account,
description: "Array of accounts reacted with this emoji" description: "Array of accounts reacted with this emoji"
} }
}, },
example: %{ example: [
%{
"name" => "😱", "name" => "😱",
"count" => 1, "count" => 1,
"me" => false, "me" => false,
"url" => nil,
"accounts" => [Account.schema().example]
},
%{
"name" => "dinosaur",
"count" => 1,
"me" => false,
"url" => "https://akkoma.dev/emoji/dinosaur.png",
"accounts" => [Account.schema().example] "accounts" => [Account.schema().example]
} }
]
} }
end end
end end