LumeWeb
/
portal-sdk
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore: update account swagger.yaml

This commit is contained in:
Derrick Hammer 2024-03-17 09:29:02 -04:00
parent 713430f00f
commit 3c0510c272
Signed by: pcfreak30
GPG Key ID: C997C339BE476FF2
1 changed files with 251 additions and 245 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
src/account/swagger.yaml
View File

@ -12,16 +12,22 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/LoginRequest" $ref: '#/components/schemas/LoginRequest'
responses: responses:
"200": '200':
description: Successfully logged in description: Successfully logged in
content: content:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/LoginResponse" $ref: '#/components/schemas/LoginResponse'
"401": '401':
description: Unauthorized description: Unauthorized
/api/auth/logout:
post:
summary: Logout of account service
responses:
'200':
description: Successfully logged out
/api/auth/register: /api/auth/register:
post: post:
summary: Register a new account summary: Register a new account
@ -30,11 +36,11 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/RegisterRequest" $ref: '#/components/schemas/RegisterRequest'
responses: responses:
"200": '200':
description: Successfully registered description: Successfully registered
"400": '400':
description: Bad Request description: Bad Request
/api/auth/verify-email: /api/auth/verify-email:
post: post:
@ -44,20 +50,20 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/VerifyEmailRequest" $ref: '#/components/schemas/VerifyEmailRequest'
responses: responses:
"200": '200':
description: Email verified successfully description: Email verified successfully
/api/auth/otp/generate: /api/auth/otp/generate:
get: get:
summary: Generate OTP for two-factor authentication summary: Generate OTP for two-factor authentication
responses: responses:
"200": '200':
description: OTP generated successfully description: OTP generated successfully
content: content:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/OTPGenerateResponse" $ref: '#/components/schemas/OTPGenerateResponse'
/api/auth/otp/verify: /api/auth/otp/verify:
post: post:
summary: Verify OTP for enabling two-factor authentication summary: Verify OTP for enabling two-factor authentication
@ -66,9 +72,9 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/OTPVerifyRequest" $ref: '#/components/schemas/OTPVerifyRequest'
responses: responses:
"200": '200':
description: OTP verified successfully description: OTP verified successfully
/api/auth/otp/validate: /api/auth/otp/validate:
post: post:
@ -78,9 +84,9 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/OTPValidateRequest" $ref: '#/components/schemas/OTPValidateRequest'
responses: responses:
"200": '200':
description: OTP validated successfully description: OTP validated successfully
/api/auth/otp/disable: /api/auth/otp/disable:
post: post:
@ -90,9 +96,9 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/OTPDisableRequest" $ref: '#/components/schemas/OTPDisableRequest'
responses: responses:
"200": '200':
description: OTP disabled successfully description: OTP disabled successfully
/api/auth/password-reset/request: /api/auth/password-reset/request:
post: post:
@ -102,9 +108,9 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/PasswordResetRequest" $ref: '#/components/schemas/PasswordResetRequest'
responses: responses:
"200": '200':
description: Password reset requested successfully description: Password reset requested successfully
/api/auth/password-reset/confirm: /api/auth/password-reset/confirm:
post: post:
@ -114,33 +120,33 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/PasswordResetVerifyRequest" $ref: '#/components/schemas/PasswordResetVerifyRequest'
responses: responses:
"200": '200':
description: Password reset successfully description: Password reset successfully
/api/auth/ping: /api/auth/ping:
post: post:
summary: Auth check endpoint summary: Auth check endpoint
responses: responses:
"200": '200':
description: Pong description: Pong
content: content:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/PingResponse" $ref: '#/components/schemas/PingResponse'
"401": '401':
description: Unauthorized description: Unauthorized
/api/account: /api/account:
get: get:
summary: Get account information summary: Get account information
responses: responses:
"200": '200':
description: Account information retrieved successfully description: Account information retrieved successfully
content: content:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/AccountInfoResponse" $ref: '#/components/schemas/AccountInfoResponse'
"401": '401':
description: Unauthorized description: Unauthorized
components: components: