forked from AkkomaGang/akkoma
Merge branch 'fix/notifications-api' into 'develop'
Fix notifications mark as read API Closes #1800 See merge request pleroma/pleroma!2570
This commit is contained in:
commit
96650c55ae
3 changed files with 20 additions and 9 deletions
lib/pleroma/web
api_spec/operations
pleroma_api/controllers
test/web/pleroma_api/controllers
|
@ -8,6 +8,8 @@ defmodule Pleroma.Web.ApiSpec.PleromaNotificationOperation do
|
|||
alias Pleroma.Web.ApiSpec.NotificationOperation
|
||||
alias Pleroma.Web.ApiSpec.Schemas.ApiError
|
||||
|
||||
import Pleroma.Web.ApiSpec.Helpers
|
||||
|
||||
def open_api_operation(action) do
|
||||
operation = String.to_existing_atom("#{action}_operation")
|
||||
apply(__MODULE__, operation, [])
|
||||
|
@ -17,10 +19,14 @@ def mark_as_read_operation do
|
|||
%Operation{
|
||||
tags: ["Notifications"],
|
||||
summary: "Mark notifications as read. Query parameters are mutually exclusive.",
|
||||
parameters: [
|
||||
Operation.parameter(:id, :query, :string, "A single notification ID to read"),
|
||||
Operation.parameter(:max_id, :query, :string, "Read all notifications up to this id")
|
||||
],
|
||||
requestBody:
|
||||
request_body("Parameters", %Schema{
|
||||
type: :object,
|
||||
properties: %{
|
||||
id: %Schema{type: :integer, description: "A single notification ID to read"},
|
||||
max_id: %Schema{type: :integer, description: "Read all notifications up to this ID"}
|
||||
}
|
||||
}),
|
||||
security: [%{"oAuth" => ["write:notifications"]}],
|
||||
operationId: "PleromaAPI.NotificationController.mark_as_read",
|
||||
responses: %{
|
||||
|
|
|
@ -14,7 +14,7 @@ defmodule Pleroma.Web.PleromaAPI.NotificationController do
|
|||
|
||||
defdelegate open_api_operation(action), to: Pleroma.Web.ApiSpec.PleromaNotificationOperation
|
||||
|
||||
def mark_as_read(%{assigns: %{user: user}} = conn, %{id: notification_id}) do
|
||||
def mark_as_read(%{assigns: %{user: user}, body_params: %{id: notification_id}} = conn, _) do
|
||||
with {:ok, notification} <- Notification.read_one(user, notification_id) do
|
||||
render(conn, "show.json", notification: notification, for: user)
|
||||
else
|
||||
|
@ -25,7 +25,7 @@ def mark_as_read(%{assigns: %{user: user}} = conn, %{id: notification_id}) do
|
|||
end
|
||||
end
|
||||
|
||||
def mark_as_read(%{assigns: %{user: user}} = conn, %{max_id: max_id}) do
|
||||
def mark_as_read(%{assigns: %{user: user}, body_params: %{max_id: max_id}} = conn, _) do
|
||||
notifications =
|
||||
user
|
||||
|> Notification.set_read_up_to(max_id)
|
||||
|
|
|
@ -23,7 +23,8 @@ test "it marks a single notification as read", %{user: user1, conn: conn} do
|
|||
|
||||
response =
|
||||
conn
|
||||
|> post("/api/v1/pleroma/notifications/read?id=#{notification1.id}")
|
||||
|> put_req_header("content-type", "application/json")
|
||||
|> post("/api/v1/pleroma/notifications/read", %{id: notification1.id})
|
||||
|> json_response_and_validate_schema(:ok)
|
||||
|
||||
assert %{"pleroma" => %{"is_seen" => true}} = response
|
||||
|
@ -41,7 +42,8 @@ test "it marks multiple notifications as read", %{user: user1, conn: conn} do
|
|||
|
||||
[response1, response2] =
|
||||
conn
|
||||
|> post("/api/v1/pleroma/notifications/read?max_id=#{notification2.id}")
|
||||
|> put_req_header("content-type", "application/json")
|
||||
|> post("/api/v1/pleroma/notifications/read", %{max_id: notification2.id})
|
||||
|> json_response_and_validate_schema(:ok)
|
||||
|
||||
assert %{"pleroma" => %{"is_seen" => true}} = response1
|
||||
|
@ -54,7 +56,10 @@ test "it marks multiple notifications as read", %{user: user1, conn: conn} do
|
|||
test "it returns error when notification not found", %{conn: conn} do
|
||||
response =
|
||||
conn
|
||||
|> post("/api/v1/pleroma/notifications/read?id=22222222222222")
|
||||
|> put_req_header("content-type", "application/json")
|
||||
|> post("/api/v1/pleroma/notifications/read", %{
|
||||
id: 22_222_222_222_222
|
||||
})
|
||||
|> json_response_and_validate_schema(:bad_request)
|
||||
|
||||
assert response == %{"error" => "Cannot get notification"}
|
||||
|
|
Loading…
Reference in a new issue