diff options
| author |  tobi <31960611+tsmethurst@users.noreply.github.com> | 2021-10-14 14:26:04 +0200 |
|---|---|---|
| committer |  GitHub <noreply@github.com> | 2021-10-14 14:26:04 +0200 |
| commit | 107685e22e809123a31e6518249d14888767f0fe (patch) | |
| tree | 3a46ca8a095f7ec1a0ee65845364b498099b6954 /docs/api | |
| parent | go fmt (#278) (diff) | |
| download | gotosocial-107685e22e809123a31e6518249d14888767f0fe.tar.xz | |
User password change (#280)
* start passwordChangeHandler
* add user scope
* add user module / api path
* add password change request
* make comment clearer
* add user to processor
* required true
* add processor call to handler
* don't pass tc or channel
* change password func + tests
* add some first docs about password management
* update swagger docs
* add api tests
* go fmt
* test fixes
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/swagger.yaml | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/docs/api/swagger.yaml b/docs/api/swagger.yaml index 77a150a9a..72c543a3a 100644 --- a/docs/api/swagger.yaml +++ b/docs/api/swagger.yaml @@ -3362,6 +3362,51 @@ paths: summary: See public statuses/posts that your instance is aware of. tags: - timelines + /api/v1/user/password_change: + post: + consumes: + - application/json + - application/xml + - application/x-www-form-urlencoded + description: |- + The parameters can also be given in the body of the request, as JSON, if the content-type is set to 'application/json'. + The parameters can also be given in the body of the request, as XML, if the content-type is set to 'application/xml'. + operationId: userPasswordChange + parameters: + - description: User's previous password. + in: formData + name: old_password + required: true + type: string + x-go-name: OldPassword + - description: |- + Desired new password. + If the password does not have high enough entropy, it will be rejected. + See https://github.com/wagslane/go-password-validator + in: formData + name: new_password + required: true + type: string + x-go-name: NewPassword + produces: + - application/json + responses: + "200": + description: Change successful + "400": + description: bad request + "401": + description: unauthorized + "403": + description: forbidden + "500": + description: internal error + security: + - OAuth2 Bearer: + - write:user + summary: Change the password of authenticated user. + tags: + - user /users/{username}/statuses/{status}/replies: get: description: |- @@ -3437,12 +3482,14 @@ securityDefinitions: read:search: grant read access to searches read:statuses: grants read access to statuses read:streaming: grants read access to streaming api + read:user: grants read access to user-level info write: grants write access to everything write:accounts: grants write access to accounts write:blocks: grants write access to blocks write:follows: grants write access to follows write:media: grants write access to media write:statuses: grants write access to statuses + write:user: grants write access to user-level info tokenUrl: https://example.org/oauth/token type: oauth2 swagger: "2.0" |