summaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
authorLibravatar Vyr Cossont <VyrCossont@users.noreply.github.com>2023-07-27 01:30:39 -0700
committerLibravatar GitHub <noreply@github.com>2023-07-27 10:30:39 +0200
commit22ac4607a1c283a719eea95844e07513b8a67570 (patch)
tree61baf7949b62f84d2dff29c4d99614d946774f64 /docs/api
parent[performance] retry db queries on busy errors (#2025) (diff)
downloadgotosocial-22ac4607a1c283a719eea95844e07513b8a67570.tar.xz
[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>
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/swagger.yaml39
1 files changed, 39 insertions, 0 deletions
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).