docs: add summaries to all openapi routes
This commit is contained in:
parent
a0332df101
commit
27e21f0ad0
|
@ -9,6 +9,7 @@ tags:
|
|||
paths:
|
||||
/api/users/register:
|
||||
put:
|
||||
summary: Create new user
|
||||
description: Create new user
|
||||
tags:
|
||||
- Users
|
||||
|
@ -63,6 +64,7 @@ paths:
|
|||
post:
|
||||
tags:
|
||||
- Users
|
||||
summary: Log in with email and password
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
|
@ -100,6 +102,7 @@ paths:
|
|||
post:
|
||||
tags:
|
||||
- Users
|
||||
summary: Reset a user's password
|
||||
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
|
||||
requestBody:
|
||||
|
@ -131,6 +134,7 @@ paths:
|
|||
- Private routes
|
||||
security:
|
||||
- session: []
|
||||
summary: List all users
|
||||
responses:
|
||||
200:
|
||||
description: OK
|
||||
|
@ -155,6 +159,7 @@ paths:
|
|||
description: Must be a valid UUID
|
||||
tags:
|
||||
- Private routes
|
||||
summary: Get a user
|
||||
security:
|
||||
- session: []
|
||||
responses:
|
||||
|
@ -187,6 +192,7 @@ paths:
|
|||
description: Must be a valid UUID
|
||||
tags:
|
||||
- Private routes
|
||||
summary: Edit a user
|
||||
security:
|
||||
- session: []
|
||||
responses:
|
||||
|
|
Loading…
Reference in New Issue