summaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
authorLibravatar Vyr Cossont <VyrCossont@users.noreply.github.com>2024-05-29 03:57:44 -0700
committerLibravatar GitHub <noreply@github.com>2024-05-29 12:57:44 +0200
commit975e92b7f1fb92c2c0475e9ec65fd2521625252c (patch)
tree0621f1f2ed6d1846e1edae6551d5a2e158b758ca /docs/api
parent[feature] Debug admin endpoint to clear caches (#2940) (diff)
downloadgotosocial-975e92b7f1fb92c2c0475e9ec65fd2521625252c.tar.xz
[feature] Implement profile API (#2926)
* Implement profile API This Mastodon 4.2 extension provides capabilities missing from the existing Mastodon account update API: deleting an account's avatar or header. See: https://docs.joinmastodon.org/methods/profile/ * Move profile media methods to media processor * Remove check for moved account
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/swagger.yaml54
1 files changed, 54 insertions, 0 deletions
diff --git a/docs/api/swagger.yaml b/docs/api/swagger.yaml
index b86d4b9eb..7e61dcf1c 100644
--- a/docs/api/swagger.yaml
+++ b/docs/api/swagger.yaml
@@ -7276,6 +7276,60 @@ paths:
summary: Return an object of user preferences.
tags:
- preferences
+ /api/v1/profile/avatar:
+ delete:
+ description: If the account doesn't have an avatar, the call succeeds anyway.
+ operationId: accountAvatarDelete
+ produces:
+ - application/json
+ responses:
+ "200":
+ description: The updated account, including profile source information.
+ schema:
+ $ref: '#/definitions/account'
+ "400":
+ description: bad request
+ "401":
+ description: unauthorized
+ "403":
+ description: forbidden
+ "406":
+ description: not acceptable
+ "500":
+ description: internal server error
+ security:
+ - OAuth2 Bearer:
+ - admin
+ summary: Delete the authenticated account's avatar.
+ tags:
+ - accounts
+ /api/v1/profile/header:
+ delete:
+ description: If the account doesn't have a header, the call succeeds anyway.
+ operationId: accountHeaderDelete
+ produces:
+ - application/json
+ responses:
+ "200":
+ description: The updated account, including profile source information.
+ schema:
+ $ref: '#/definitions/account'
+ "400":
+ description: bad request
+ "401":
+ description: unauthorized
+ "403":
+ description: forbidden
+ "406":
+ description: not acceptable
+ "500":
+ description: internal server error
+ security:
+ - OAuth2 Bearer:
+ - admin
+ summary: Delete the authenticated account's header.
+ tags:
+ - accounts
/api/v1/reports:
get:
description: |-