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

feat: add ping account api

This commit is contained in:
Derrick Hammer 2024-03-13 12:32:08 -04:00
parent 13712d2501
commit d490ac55ce
Signed by: pcfreak30
GPG Key ID: C997C339BE476FF2
2 changed files with 230 additions and 216 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/account.ts
View File

@ -6,10 +6,10 @@ import {
OTPValidateRequest,
OTPVerifyRequest,
PasswordResetVerifyRequest,
postApiAuthPasswordResetRequest,
postApiAuthPasswordResetRequest, postApiAuthPing,
RegisterRequest,
VerifyEmailRequest,
} from "./account/generated/index.js";
} from './account/generated/index.js';
import {
postApiAuthLogin,
postApiAuthRegister,
@ -110,6 +110,12 @@ export default class AccountApi {
);
}
public async ping(): Promise<boolean> {
return this.checkSuccessBool(
await postApiAuthPing( this.buildOptions()),
);
}
private checkSuccessBool(ret: AxiosResponse<void>): boolean {
return ret.status === 200;
}

50
src/account/swagger.yaml
View File

@ -12,15 +12,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/LoginRequest"
$ref: '#/components/schemas/LoginRequest'
responses:
"200":
'200':
description: Successfully logged in
content:
application/json:
schema:
$ref: "#/components/schemas/LoginResponse"
"401":
$ref: '#/components/schemas/LoginResponse'
'401':
description: Unauthorized
/api/auth/register:
post:
@ -30,11 +30,11 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/RegisterRequest"
$ref: '#/components/schemas/RegisterRequest'
responses:
"200":
'200':
description: Successfully registered
"400":
'400':
description: Bad Request
/api/auth/verify-email:
post:
@ -44,20 +44,20 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/VerifyEmailRequest"
$ref: '#/components/schemas/VerifyEmailRequest'
responses:
"200":
'200':
description: Email verified successfully
/api/auth/otp/generate:
get:
summary: Generate OTP for two-factor authentication
responses:
"200":
'200':
description: OTP generated successfully
content:
application/json:
schema:
$ref: "#/components/schemas/OTPGenerateResponse"
$ref: '#/components/schemas/OTPGenerateResponse'
/api/auth/otp/verify:
post:
summary: Verify OTP for enabling two-factor authentication
@ -66,9 +66,9 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/OTPVerifyRequest"
$ref: '#/components/schemas/OTPVerifyRequest'
responses:
"200":
'200':
description: OTP verified successfully
/api/auth/otp/validate:
post:
@ -78,9 +78,9 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/OTPValidateRequest"
$ref: '#/components/schemas/OTPValidateRequest'
responses:
"200":
'200':
description: OTP validated successfully
/api/auth/otp/disable:
post:
@ -90,9 +90,9 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/OTPDisableRequest"
$ref: '#/components/schemas/OTPDisableRequest'
responses:
"200":
'200':
description: OTP disabled successfully
/api/auth/password-reset/request:
post:
@ -102,9 +102,9 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/PasswordResetRequest"
$ref: '#/components/schemas/PasswordResetRequest'
responses:
"200":
'200':
description: Password reset requested successfully
/api/auth/password-reset/confirm:
post:
@ -114,10 +114,18 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/PasswordResetVerifyRequest"
$ref: '#/components/schemas/PasswordResetVerifyRequest'
responses:
"200":
'200':
description: Password reset successfully
/api/auth/ping:
post:
summary: Auth check endpoint
responses:
'200':
description: Pong
'401':
description: Unauthorized
components:
schemas: