From 22ac4607a1c283a719eea95844e07513b8a67570 Mon Sep 17 00:00:00 2001
From: Vyr Cossont <VyrCossont@users.noreply.github.com>
Date: Thu, 27 Jul 2023 01:30:39 -0700
Subject: [feature] Support setting private notes on accounts (#1982)

* Support setting private notes on accounts

* Reformat comment whitespace

* Add missing license headers

* Use apiutil.ParseID

* Rename Note model and cache to AccountNote

* Update golden cache config in test/envparsing.sh

* Rename gtsmodel/note.go to gtsmodel/accountnote.go

* Update AccountNote uniqueness constraint name

Now has same prefix as other indexes on this table.

---------

Co-authored-by: tobi <31960611+tsmethurst@users.noreply.github.com>
---
 docs/api/swagger.yaml | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)

(limited to 'docs/api')

diff --git a/docs/api/swagger.yaml b/docs/api/swagger.yaml
index eb9ec82ee..db1d136b8 100644
--- a/docs/api/swagger.yaml
+++ b/docs/api/swagger.yaml
@@ -2944,6 +2944,45 @@ paths:
             summary: See all lists of yours that contain requested account.
             tags:
                 - accounts
+    /api/v1/accounts/{id}/note:
+        post:
+            consumes:
+                - multipart/form-data
+            operationId: accountNote
+            parameters:
+                - description: The id of the account for which to set a note.
+                  in: path
+                  name: id
+                  required: true
+                  type: string
+                - default: ""
+                  description: The text of the note. Omit this parameter or send an empty string to clear the note.
+                  in: formData
+                  name: comment
+                  type: string
+            produces:
+                - application/json
+            responses:
+                "200":
+                    description: Your relationship to the account.
+                    schema:
+                        $ref: '#/definitions/accountRelationship'
+                "400":
+                    description: bad request
+                "401":
+                    description: unauthorized
+                "404":
+                    description: not found
+                "406":
+                    description: not acceptable
+                "500":
+                    description: internal server error
+            security:
+                - OAuth2 Bearer:
+                    - write:accounts
+            summary: Set a private note for an account with the given id.
+            tags:
+                - accounts
     /api/v1/accounts/{id}/statuses:
         get:
             description: The statuses will be returned in descending chronological order (newest first), with sequential IDs (bigger = newer).
-- 
cgit v1.2.3