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

chore: update swagger.yaml

This commit is contained in:
Derrick Hammer 2024-03-26 15:13:44 -04:00
parent 574ef1ddb1
commit c12b24b284
Signed by: pcfreak30
GPG Key ID: C997C339BE476FF2
1 changed files with 338 additions and 314 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

92
src/account/swagger.yaml
View File

@ -12,21 +12,21 @@ 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/logout:
post:
summary: Logout of account service
responses:
"200":
'200':
description: Successfully logged out
/api/auth/register:
post:
@ -36,11 +36,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/account/verify-email:
post:
@ -50,20 +50,26 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/VerifyEmailRequest"
$ref: '#/components/schemas/VerifyEmailRequest'
responses:
"200":
'200':
description: Email verified successfully
/api/account/verify-email/resend:
post:
summary: Resend email verification
responses:
'200':
description: Email verification resent 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/account/otp/verify:
post:
summary: Verify OTP for enabling two-factor authentication
@ -72,9 +78,9 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/OTPVerifyRequest"
$ref: '#/components/schemas/OTPVerifyRequest'
responses:
"200":
'200':
description: OTP verified successfully
/api/account/otp/validate:
post:
@ -84,9 +90,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:
@ -96,9 +102,9 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/OTPDisableRequest"
$ref: '#/components/schemas/OTPDisableRequest'
responses:
"200":
'200':
description: OTP disabled successfully
/api/account/password-reset/request:
post:
@ -108,9 +114,9 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/PasswordResetRequest"
$ref: '#/components/schemas/PasswordResetRequest'
responses:
"200":
'200':
description: Password reset requested successfully
/api/account/password-reset/confirm:
post:
@ -120,33 +126,33 @@ 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":
'200':
description: Pong
content:
application/json:
schema:
$ref: "#/components/schemas/PingResponse"
"401":
$ref: '#/components/schemas/PingResponse'
'401':
description: Unauthorized
/api/account:
get:
summary: Get account information
responses:
"200":
'200':
description: Account information retrieved successfully
content:
application/json:
schema:
$ref: "#/components/schemas/AccountInfoResponse"
"401":
$ref: '#/components/schemas/AccountInfoResponse'
'401':
description: Unauthorized
/api/account/update-email:
post:
@ -156,9 +162,9 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateEmailRequest"
$ref: '#/components/schemas/UpdateEmailRequest'
responses:
"200":
'200':
description: Email updated successfully
/api/account/update-password:
post:
@ -168,20 +174,31 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/UpdatePasswordRequest"
$ref: '#/components/schemas/UpdatePasswordRequest'
responses:
"200":
'200':
description: Password updated successfully
/api/upload-limit:
get:
summary: Get the basic file upload (POST) upload limit set by the portal
responses:
"200":
'200':
description: Upload limit retrieved successfully
content:
application/json:
schema:
$ref: "#/components/schemas/UploadLimitResponse"
$ref: '#/components/schemas/UploadLimitResponse'
/api/meta:
get:
summary: Get metadata about the portal
responses:
'200':
description: Metadata retrieved successfully
content:
application/json:
schema:
$ref: '#/components/schemas/MetaResponse'
components:
schemas:
@ -317,3 +334,10 @@ components:
type: number
required:
- limit
MetaResponse:
type: object
required:
- domain
properties:
domain:
type: string