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

Compare commits

base: LumeWeb:1f69c9c1ccfefc47914be3b371a1046c303cddad
Branches Tags
LumeWeb:master
LumeWeb:develop
...
compare: LumeWeb:c12b24b284bd9b797c9e1cd79e7e053c3ffa46e1
Branches Tags
LumeWeb:develop
LumeWeb:master

1 Commits
1f69c9c1cc ... c12b24b284

Author SHA1 Message Date
Derrick Hammer c12b24b284
chore: update swagger.yaml 2024-03-26 15:13:44 -04:00
1 changed files with 338 additions and 314 deletions
Show Stats Expand all files Collapse all files

92
src/account/swagger.yaml
View File

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