aboutsummaryrefslogtreecommitdiffhomepage
path: root/openapi
diff options
context:
space:
mode:
authornsfisis <nsfisis@gmail.com>2024-08-11 13:28:13 +0900
committernsfisis <nsfisis@gmail.com>2024-08-11 14:18:34 +0900
commit97fdb23b7a1b75001a2ca53ea5ec76c52c57dde3 (patch)
tree7aa0a50700804083a1f8cff3659dbb9c922fd0c5 /openapi
parent729bd4e58ebfc1a46fa69f09179effe83b5b28cb (diff)
downloadphperkaigi-2025-albatross-97fdb23b7a1b75001a2ca53ea5ec76c52c57dde3.tar.gz
phperkaigi-2025-albatross-97fdb23b7a1b75001a2ca53ea5ec76c52c57dde3.tar.zst
phperkaigi-2025-albatross-97fdb23b7a1b75001a2ca53ea5ec76c52c57dde3.zip
refactor(backend): define OpenAPI spec of fortee login API
Diffstat (limited to 'openapi')
-rw-r--r--openapi/fortee.yaml38
1 files changed, 38 insertions, 0 deletions
diff --git a/openapi/fortee.yaml b/openapi/fortee.yaml
new file mode 100644
index 0000000..a27c721
--- /dev/null
+++ b/openapi/fortee.yaml
@@ -0,0 +1,38 @@
+openapi: 3.0.0
+info:
+ title: Albatross internal web API
+ version: 0.1.0
+paths:
+ /api/user/login:
+ post:
+ operationId: postLogin
+ summary: User login
+ requestBody:
+ required: true
+ content:
+ application/x-www-form-urlencoded:
+ schema:
+ type: object
+ properties:
+ username:
+ type: string
+ example: "john"
+ password:
+ type: string
+ example: "password123"
+ required:
+ - username
+ - password
+ responses:
+ '200':
+ description: Successfully authenticated
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ loggedIn:
+ type: boolean
+ example: true
+ required:
+ - loggedIn