summaryrefslogtreecommitdiff
path: root/packages/backend/src/server/api/endpoints/request-reset-password.ts
diff options
context:
space:
mode:
authorJohann150 <johann.galle@protonmail.com>2022-06-10 07:25:20 +0200
committerGitHub <noreply@github.com>2022-06-10 14:25:20 +0900
commit78df3dc484f5dd1601ee35d5735d4074d5b298e6 (patch)
tree4dc4cd7bcc5750eee73908224598549a6a509a96 /packages/backend/src/server/api/endpoints/request-reset-password.ts
parentUpdate CHANGELOG.md (diff)
downloadsharkey-78df3dc484f5dd1601ee35d5735d4074d5b298e6.tar.gz
sharkey-78df3dc484f5dd1601ee35d5735d4074d5b298e6.tar.bz2
sharkey-78df3dc484f5dd1601ee35d5735d4074d5b298e6.zip
enhance: improve documentation for `/users/` endpoints (#8790)
* docs: category & description for reset password * docs: category & description for testing * docs: descriptions for groups endpoints * docs: descriptions for drive file endpoints * docs: descriptions for sw endpoints * docs: descriptions for user list endpoints * docs: descriptions & result type for gallery posts * docs: descriptions & result type for user endpoints * docs: add return type for stats
Diffstat (limited to 'packages/backend/src/server/api/endpoints/request-reset-password.ts')
-rw-r--r--packages/backend/src/server/api/endpoints/request-reset-password.ts4
1 files changed, 4 insertions, 0 deletions
diff --git a/packages/backend/src/server/api/endpoints/request-reset-password.ts b/packages/backend/src/server/api/endpoints/request-reset-password.ts
index 046337f040..12ce7a9834 100644
--- a/packages/backend/src/server/api/endpoints/request-reset-password.ts
+++ b/packages/backend/src/server/api/endpoints/request-reset-password.ts
@@ -10,8 +10,12 @@ import { genId } from '@/misc/gen-id.js';
import { IsNull } from 'typeorm';
export const meta = {
+ tags: ['reset password'],
+
requireCredential: false,
+ description: 'Request a users password to be reset.',
+
limit: {
duration: ms('1hour'),
max: 3,