Merge branch 'account-notes' into 'develop'
[akkoma] / lib / pleroma / web / api_spec / operations / account_operation.ex
index 6cedada2c84ca7d44a81d2a71f0c29b702df2ea0..8cd2e824d1e47d07eb5c1c24cefc7a869c043cc3 100644 (file)
@@ -226,6 +226,12 @@ defmodule Pleroma.Web.ApiSpec.AccountOperation do
                 type: :boolean,
                 description: "Receive this account's reblogs in home timeline? Defaults to true.",
                 default: true
+              },
+              notify: %Schema{
+                type: :boolean,
+                description:
+                  "Receive notifications for all statuses posted by the account? Defaults to false.",
+                default: false
               }
             }
           },
@@ -331,7 +337,7 @@ defmodule Pleroma.Web.ApiSpec.AccountOperation do
   def note_operation do
     %Operation{
       tags: ["Account actions"],
-      summary: "Create note",
+      summary: "Set a private note about a user.",
       operationId: "AccountController.note",
       security: [%{"oAuth" => ["follow", "write:accounts"]}],
       requestBody: request_body("Parameters", note_request()),
@@ -712,6 +718,7 @@ defmodule Pleroma.Web.ApiSpec.AccountOperation do
           "requested" => false,
           "domain_blocking" => false,
           "subscribing" => false,
+          "notifying" => false,
           "endorsed" => true
         },
         %{
@@ -727,6 +734,7 @@ defmodule Pleroma.Web.ApiSpec.AccountOperation do
           "requested" => true,
           "domain_blocking" => false,
           "subscribing" => false,
+          "notifying" => false,
           "endorsed" => false
         },
         %{
@@ -742,6 +750,7 @@ defmodule Pleroma.Web.ApiSpec.AccountOperation do
           "requested" => false,
           "domain_blocking" => true,
           "subscribing" => true,
+          "notifying" => true,
           "endorsed" => false
         }
       ]
@@ -794,7 +803,7 @@ defmodule Pleroma.Web.ApiSpec.AccountOperation do
       properties: %{
         comment: %Schema{
           type: :string,
-          description: "Account note body",
+          description: "Account note body"
         }
       },
       example: %{