{ "openapi": "3.0.0", "paths": { "/health": { "get": { "operationId": "HealthController_check", "parameters": [], "responses": { "200": { "description": "The Health Check is successful", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "ok" }, "info": { "type": "object", "example": { "database": { "status": "up" } }, "additionalProperties": { "type": "object", "properties": { "status": { "type": "string" } }, "additionalProperties": { "type": "string" } }, "nullable": true }, "error": { "type": "object", "example": {}, "additionalProperties": { "type": "object", "properties": { "status": { "type": "string" } }, "additionalProperties": { "type": "string" } }, "nullable": true }, "details": { "type": "object", "example": { "database": { "status": "up" } }, "additionalProperties": { "type": "object", "properties": { "status": { "type": "string" } }, "additionalProperties": { "type": "string" } } } } } } } }, "503": { "description": "The Health Check is not successful", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "error" }, "info": { "type": "object", "example": { "database": { "status": "up" } }, "additionalProperties": { "type": "object", "properties": { "status": { "type": "string" } }, "additionalProperties": { "type": "string" } }, "nullable": true }, "error": { "type": "object", "example": { "redis": { "status": "down", "message": "Could not connect" } }, "additionalProperties": { "type": "object", "properties": { "status": { "type": "string" } }, "additionalProperties": { "type": "string" } }, "nullable": true }, "details": { "type": "object", "example": { "database": { "status": "up" }, "redis": { "status": "down", "message": "Could not connect" } }, "additionalProperties": { "type": "object", "properties": { "status": { "type": "string" } }, "additionalProperties": { "type": "string" } } } } } } } } } } }, "/auth/login": { "post": { "operationId": "AuthController_login", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginDto" } } } }, "responses": { "201": { "description": "" } } } }, "/auth/forgot-password": { "post": { "operationId": "AuthController_forgotPassword", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForgotPasswordDto" } } } }, "responses": { "201": { "description": "" } } } }, "/auth/reset-password": { "post": { "operationId": "AuthController_resetPassword", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResetPasswordDto" } } } }, "responses": { "201": { "description": "" } } } }, "/auth/logout": { "post": { "operationId": "AuthController_logout", "parameters": [], "responses": { "201": { "description": "" } } } }, "/auth/sign-up": { "post": { "operationId": "AuthController_signUp", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignUpDto" } } } }, "responses": { "201": { "description": "" } } } }, "/auth/confirm-sign-up": { "post": { "operationId": "AuthController_verifyCode", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmSignUpDto" } } } }, "responses": { "201": { "description": "" } } } }, "/auth/delete": { "post": { "operationId": "AuthController_deleteUser", "parameters": [], "responses": { "201": { "description": "" } } } } }, "info": { "title": "@galaxyops/user-service", "description": "user service", "version": "1.1.5", "contact": {} }, "tags": [], "servers": [ { "url": "http://localhost:3000", "description": "Local" }, { "url": "https://auth.sandbox.nekosgate.com/", "description": "Sandbox" } ], "components": { "schemas": { "LoginDto": { "type": "object", "properties": { "email": { "type": "string", "default": "jdoe@example.com" }, "password": { "type": "string", "default": "password1234!" } }, "required": ["email", "password"] }, "ForgotPasswordDto": { "type": "object", "properties": { "username": { "type": "string", "default": "jdoe" }, "password": { "type": "string", "default": "password1234!" } }, "required": ["username", "password"] }, "ResetPasswordDto": { "type": "object", "properties": { "username": { "type": "string", "default": "jdoe" }, "code": { "type": "string", "default": "code1234!" }, "newPassword": { "type": "string", "default": "password1234!" } }, "required": ["username", "code", "newPassword"] }, "SignUpDto": { "type": "object", "properties": { "email": { "type": "string", "default": "jdoe@gmail.com" }, "password": { "type": "string", "default": "password1234!" } }, "required": ["email", "password"] }, "ConfirmSignUpDto": { "type": "object", "properties": { "email": { "type": "string", "default": "jdoe@gmail.com" }, "code": { "type": "string", "default": "1234567" } }, "required": ["email", "code"] } } } }