X-Git-Url: http://git.squeep.com/?a=blobdiff_plain;f=lib%2Fpleroma%2Fweb%2Fapi_spec%2Foperations%2Fnotification_operation.ex;h=b4a20e5e5652f3d96a1cb31def7cf8cbd69e6c82;hb=0f132b802dde7f217ecb07767e0d34e3edb517b7;hp=264a530d286f5be7b4898a522be58eace0bae329;hpb=cbce88007672dc810cb345bb9872a009cbdc93d8;p=akkoma diff --git a/lib/pleroma/web/api_spec/operations/notification_operation.ex b/lib/pleroma/web/api_spec/operations/notification_operation.ex index 264a530d2..b4a20e5e5 100644 --- a/lib/pleroma/web/api_spec/operations/notification_operation.ex +++ b/lib/pleroma/web/api_spec/operations/notification_operation.ex @@ -1,5 +1,5 @@ # Pleroma: A lightweight social networking server -# Copyright © 2017-2020 Pleroma Authors +# Copyright © 2017-2021 Pleroma Authors # SPDX-License-Identifier: AGPL-3.0-only defmodule Pleroma.Web.ApiSpec.NotificationOperation do @@ -22,7 +22,7 @@ defmodule Pleroma.Web.ApiSpec.NotificationOperation do def index_operation do %Operation{ tags: ["Notifications"], - summary: "Get all notifications", + summary: "Retrieve a list of notifications", description: "Notifications concerning the user. This API returns Link headers containing links to the next/previous page. However, the links can also be constructed dynamically using query params and `id` values.", operationId: "NotificationController.index", @@ -74,7 +74,7 @@ defmodule Pleroma.Web.ApiSpec.NotificationOperation do def show_operation do %Operation{ tags: ["Notifications"], - summary: "Get a single notification", + summary: "Retrieve a notification", description: "View information about a notification with a given ID.", operationId: "NotificationController.show", security: [%{"oAuth" => ["read:notifications"]}], @@ -99,7 +99,7 @@ defmodule Pleroma.Web.ApiSpec.NotificationOperation do def dismiss_operation do %Operation{ tags: ["Notifications"], - summary: "Dismiss a single notification", + summary: "Dismiss a notification", description: "Clear a single notification from the server.", operationId: "NotificationController.dismiss", parameters: [id_param()], @@ -108,24 +108,6 @@ defmodule Pleroma.Web.ApiSpec.NotificationOperation do } end - def dismiss_via_body_operation do - %Operation{ - tags: ["Notifications"], - summary: "Dismiss a single notification", - deprecated: true, - description: "Clear a single notification from the server.", - operationId: "NotificationController.dismiss_via_body", - requestBody: - request_body( - "Parameters", - %Schema{type: :object, properties: %{id: %Schema{type: :string}}}, - required: true - ), - security: [%{"oAuth" => ["write:notifications"]}], - responses: %{200 => empty_object_response()} - } - end - def destroy_multiple_operation do %Operation{ tags: ["Notifications"], @@ -192,10 +174,10 @@ defmodule Pleroma.Web.ApiSpec.NotificationOperation do "reblog", "mention", "pleroma:emoji_reaction", - "pleroma:chat_mention", "pleroma:report", "move", - "follow_request" + "follow_request", + "poll" ], description: """ The type of event that resulted in the notification. @@ -207,7 +189,6 @@ defmodule Pleroma.Web.ApiSpec.NotificationOperation do - `poll` - A poll you have voted in or created has ended - `move` - Someone moved their account - `pleroma:emoji_reaction` - Someone reacted with emoji to your status - - `pleroma:chat_mention` - Someone mentioned you in a chat message - `pleroma:report` - Someone was reported """ }