test
/
megahunt.test
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: add summaries to all openapi routes

This commit is contained in:
b1ek 2024-08-30 14:21:15 +10:00
parent a0332df101
commit 27e21f0ad0
Signed by: blek
GPG Key ID: 14546221E3595D0C
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
public/openapi.yml
View File

@ -9,6 +9,7 @@ tags:
paths: paths:
/api/users/register: /api/users/register:
put: put:
summary: Create new user
description: Create new user description: Create new user
tags: tags:
- Users - Users
@ -63,6 +64,7 @@ paths:
post: post:
tags: tags:
- Users - Users
summary: Log in with email and password
requestBody: requestBody:
content: content:
application/json: application/json:
@ -100,6 +102,7 @@ paths:
post: post:
tags: tags:
- Users - Users
summary: Reset a user's password
description: |- description: |-
I know its not secure because anyone can reset anyones password. But here's a counterpoint: its not required to be secure, and i dont care I know its not secure because anyone can reset anyones password. But here's a counterpoint: its not required to be secure, and i dont care
requestBody: requestBody:
@ -131,6 +134,7 @@ paths:
- Private routes - Private routes
security: security:
- session: [] - session: []
summary: List all users
responses: responses:
200: 200:
description: OK description: OK
@ -155,6 +159,7 @@ paths:
description: Must be a valid UUID description: Must be a valid UUID
tags: tags:
- Private routes - Private routes
summary: Get a user
security: security:
- session: [] - session: []
responses: responses:
@ -187,6 +192,7 @@ paths:
description: Must be a valid UUID description: Must be a valid UUID
tags: tags:
- Private routes - Private routes
summary: Edit a user
security: security:
- session: [] - session: []
responses: responses: