diff options
| author | Johann150 <johann.galle@protonmail.com> | 2022-06-10 07:25:20 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-06-10 14:25:20 +0900 |
| commit | 78df3dc484f5dd1601ee35d5735d4074d5b298e6 (patch) | |
| tree | 4dc4cd7bcc5750eee73908224598549a6a509a96 /packages/backend/src/server/api/endpoints/users/pages.ts | |
| parent | Update CHANGELOG.md (diff) | |
| download | sharkey-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/users/pages.ts')
| -rw-r--r-- | packages/backend/src/server/api/endpoints/users/pages.ts | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/packages/backend/src/server/api/endpoints/users/pages.ts b/packages/backend/src/server/api/endpoints/users/pages.ts index b8b3e8192e..85d122c24f 100644 --- a/packages/backend/src/server/api/endpoints/users/pages.ts +++ b/packages/backend/src/server/api/endpoints/users/pages.ts @@ -4,6 +4,18 @@ import { makePaginationQuery } from '../../common/make-pagination-query.js'; export const meta = { tags: ['users', 'pages'], + + description: 'Show all pages this user created.', + + res: { + type: 'array', + optional: false, nullable: false, + items: { + type: 'object', + optional: false, nullable: false, + ref: 'Page', + }, + }, } as const; export const paramDef = { |