From 4c4b9ca5efd396f5902dbca425f7bc707721cd5a Mon Sep 17 00:00:00 2001 From: adjoly Date: Mon, 1 Sep 2025 19:00:47 +0200 Subject: [PATCH] =?UTF-8?q?=E3=80=8C=F0=9F=8E=89=E3=80=8D=20init:=20starte?= =?UTF-8?q?d=20writing=20doc=20for=20auth=20api?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- doc/auth/2fa.md | 0 doc/auth/login.md | 6 +++++ doc/auth/register.md | 52 ++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 58 insertions(+) create mode 100644 doc/auth/2fa.md create mode 100644 doc/auth/login.md create mode 100644 doc/auth/register.md diff --git a/doc/auth/2fa.md b/doc/auth/2fa.md new file mode 100644 index 0000000..e69de29 diff --git a/doc/auth/login.md b/doc/auth/login.md new file mode 100644 index 0000000..53f65cc --- /dev/null +++ b/doc/auth/login.md @@ -0,0 +1,6 @@ +# Login + +Abailable endpoints: +- `/login` +- `/login/google` +- `/login/google/callback` diff --git a/doc/auth/register.md b/doc/auth/register.md new file mode 100644 index 0000000..eaabc43 --- /dev/null +++ b/doc/auth/register.md @@ -0,0 +1,52 @@ +# Register + +Available endpoints: +- `/register` +- `/register/google` +- `/register/google/callback` + +Common return: +- 500 with response +```json +{ + "error": "Internal server error" +} +``` + +## `/register` + +Input needed : +```json +{ + "user": "", + "password": "" +} +``` + +Can return: +- 200 with response and cookie in header +```json +{ + "msg": "Register successfully" +} +``` +- 400 with response +```json +{ + "error": "" +} +``` + +## `/register/google` + +Does not take input + +Always return: +- redirect to the google auth url + +## `/register/google/callback` + +inputs are filled by google + +Can return: +- 400 with response