From 27e21f0ad0adcd7ad905008f95555efba2c67aaa Mon Sep 17 00:00:00 2001 From: b1ek Date: Fri, 30 Aug 2024 14:21:15 +1000 Subject: [PATCH] docs: add summaries to all openapi routes --- public/openapi.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/public/openapi.yml b/public/openapi.yml index 1dbb455..56dee84 100644 --- a/public/openapi.yml +++ b/public/openapi.yml @@ -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: