{ "components": { "securitySchemes": { "adminBearerAuth": { "bearerFormat": "JWT", "description": "Administrator access token passed through the Authorization header.", "scheme": "bearer", "type": "http" }, "bearerAuth": { "bearerFormat": "JWT", "description": "User access token passed through the Authorization header.", "scheme": "bearer", "type": "http" }, "wsQueryToken": { "description": "Query token supported by the realtime WebSocket gateway.", "in": "query", "name": "token", "type": "apiKey" }, "xAdminToken": { "description": "Alternative administrator token header supported by the platform.", "in": "header", "name": "X-Admin-Token", "type": "apiKey" } } }, "info": { "description": "A modern OpenAPI reference generated from the Gin router and designed for high-concurrency service evolution.", "title": "Aegis API Reference", "version": "1.0.0" }, "openapi": "3.1.0", "paths": { "/": { "get": { "description": "Auto-generated reference for `GET /`.", "operationId": "get__root", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET", "tags": [ "API" ] } }, "/announcements": { "get": { "description": "Auto-generated reference for `GET /announcements`.", "operationId": "get__announcements", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Announcements", "tags": [ "API" ] } }, "/api/admin/app/email-config/channel": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/email-config/channel`.", "operationId": "post__api__admin__app__email_dash_config__channel", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config_name": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config_name": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Email Config Channel", "tags": [ "Admin" ] } }, "/api/admin/app/email-config/create": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/email-config/create`.", "operationId": "post__api__admin__app__email_dash_config__create", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "clear_secrets": { "items": { "type": "string" }, "type": "array" }, "config_id": { "format": "int64", "type": "integer" }, "config_name": { "type": "string" }, "description": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "is_default": { "nullable": true, "type": "boolean" }, "provider": { "type": "string" }, "replace_settings": { "type": "boolean" }, "secrets": { "additionalProperties": { "type": "string" }, "type": "object" }, "settings": { "additionalProperties": { "type": "string" }, "type": "object" }, "smtp_from": { "type": "string" }, "smtp_from_name": { "type": "string" }, "smtp_host": { "type": "string" }, "smtp_insecure_skip_verify": { "nullable": true, "type": "boolean" }, "smtp_password": { "type": "string" }, "smtp_port": { "type": "integer" }, "smtp_reply_to": { "type": "string" }, "smtp_tls": { "nullable": true, "type": "boolean" }, "smtp_user": { "type": "string" }, "zeabur_api_key": { "type": "string" }, "zeabur_base_url": { "type": "string" }, "zeabur_from": { "type": "string" }, "zeabur_from_name": { "type": "string" }, "zeabur_reply_to": { "type": "string" }, "zeabur_tags": { "additionalProperties": { "type": "string" }, "type": "object" }, "zeabur_webhook_secret": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "clear_secrets": { "items": { "type": "string" }, "type": "array" }, "config_id": { "format": "int64", "type": "integer" }, "config_name": { "type": "string" }, "description": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "is_default": { "nullable": true, "type": "boolean" }, "provider": { "type": "string" }, "replace_settings": { "type": "boolean" }, "secrets": { "additionalProperties": { "type": "string" }, "type": "object" }, "settings": { "additionalProperties": { "type": "string" }, "type": "object" }, "smtp_from": { "type": "string" }, "smtp_from_name": { "type": "string" }, "smtp_host": { "type": "string" }, "smtp_insecure_skip_verify": { "nullable": true, "type": "boolean" }, "smtp_password": { "type": "string" }, "smtp_port": { "type": "integer" }, "smtp_reply_to": { "type": "string" }, "smtp_tls": { "nullable": true, "type": "boolean" }, "smtp_user": { "type": "string" }, "zeabur_api_key": { "type": "string" }, "zeabur_base_url": { "type": "string" }, "zeabur_from": { "type": "string" }, "zeabur_from_name": { "type": "string" }, "zeabur_reply_to": { "type": "string" }, "zeabur_tags": { "additionalProperties": { "type": "string" }, "type": "object" }, "zeabur_webhook_secret": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Email Config Create", "tags": [ "Admin" ] } }, "/api/admin/app/email-config/delete": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/email-config/delete`.", "operationId": "post__api__admin__app__email_dash_config__delete", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Email Config Delete", "tags": [ "Admin" ] } }, "/api/admin/app/email-config/deliveries": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/email-config/deliveries`.", "operationId": "post__api__admin__app__email_dash_config__deliveries", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config_id": { "format": "int64", "type": "integer" }, "keyword": { "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "provider": { "type": "string" }, "purpose": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config_id": { "format": "int64", "type": "integer" }, "keyword": { "type": "string" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "provider": { "type": "string" }, "purpose": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Email Config Deliveries", "tags": [ "Admin" ] } }, "/api/admin/app/email-config/detail": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/email-config/detail`.", "operationId": "post__api__admin__app__email_dash_config__detail", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Email Config Detail", "tags": [ "Admin" ] } }, "/api/admin/app/email-config/list": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/email-config/list`.", "operationId": "post__api__admin__app__email_dash_config__list", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Email Config List", "tags": [ "Admin" ] } }, "/api/admin/app/email-config/providers": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/email-config/providers`.", "operationId": "post__api__admin__app__email_dash_config__providers", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Email Config Providers", "tags": [ "Admin" ] } }, "/api/admin/app/email-config/stats": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/email-config/stats`.", "operationId": "post__api__admin__app__email_dash_config__stats", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Email Config Stats", "tags": [ "Admin" ] } }, "/api/admin/app/email-config/test": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/email-config/test`.", "operationId": "post__api__admin__app__email_dash_config__test", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config_id": { "format": "int64", "type": "integer" }, "test_email": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config_id": { "format": "int64", "type": "integer" }, "test_email": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Email Config Test", "tags": [ "Admin" ] } }, "/api/admin/app/email-config/update": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/email-config/update`.", "operationId": "post__api__admin__app__email_dash_config__update", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "clear_secrets": { "items": { "type": "string" }, "type": "array" }, "config_id": { "format": "int64", "type": "integer" }, "config_name": { "type": "string" }, "description": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "is_default": { "nullable": true, "type": "boolean" }, "provider": { "type": "string" }, "replace_settings": { "type": "boolean" }, "secrets": { "additionalProperties": { "type": "string" }, "type": "object" }, "settings": { "additionalProperties": { "type": "string" }, "type": "object" }, "smtp_from": { "type": "string" }, "smtp_from_name": { "type": "string" }, "smtp_host": { "type": "string" }, "smtp_insecure_skip_verify": { "nullable": true, "type": "boolean" }, "smtp_password": { "type": "string" }, "smtp_port": { "type": "integer" }, "smtp_reply_to": { "type": "string" }, "smtp_tls": { "nullable": true, "type": "boolean" }, "smtp_user": { "type": "string" }, "zeabur_api_key": { "type": "string" }, "zeabur_base_url": { "type": "string" }, "zeabur_from": { "type": "string" }, "zeabur_from_name": { "type": "string" }, "zeabur_reply_to": { "type": "string" }, "zeabur_tags": { "additionalProperties": { "type": "string" }, "type": "object" }, "zeabur_webhook_secret": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "clear_secrets": { "items": { "type": "string" }, "type": "array" }, "config_id": { "format": "int64", "type": "integer" }, "config_name": { "type": "string" }, "description": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "is_default": { "nullable": true, "type": "boolean" }, "provider": { "type": "string" }, "replace_settings": { "type": "boolean" }, "secrets": { "additionalProperties": { "type": "string" }, "type": "object" }, "settings": { "additionalProperties": { "type": "string" }, "type": "object" }, "smtp_from": { "type": "string" }, "smtp_from_name": { "type": "string" }, "smtp_host": { "type": "string" }, "smtp_insecure_skip_verify": { "nullable": true, "type": "boolean" }, "smtp_password": { "type": "string" }, "smtp_port": { "type": "integer" }, "smtp_reply_to": { "type": "string" }, "smtp_tls": { "nullable": true, "type": "boolean" }, "smtp_user": { "type": "string" }, "zeabur_api_key": { "type": "string" }, "zeabur_base_url": { "type": "string" }, "zeabur_from": { "type": "string" }, "zeabur_from_name": { "type": "string" }, "zeabur_reply_to": { "type": "string" }, "zeabur_tags": { "additionalProperties": { "type": "string" }, "type": "object" }, "zeabur_webhook_secret": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Email Config Update", "tags": [ "Admin" ] } }, "/api/admin/app/payment-config/create": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/payment-config/create`.", "operationId": "post__api__admin__app__payment_dash_config__create", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config_data": { "additionalProperties": {}, "type": "object" }, "config_id": { "format": "int64", "type": "integer" }, "config_name": { "type": "string" }, "description": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "is_default": { "nullable": true, "type": "boolean" }, "payment_method": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config_data": { "additionalProperties": {}, "type": "object" }, "config_id": { "format": "int64", "type": "integer" }, "config_name": { "type": "string" }, "description": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "is_default": { "nullable": true, "type": "boolean" }, "payment_method": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Payment Config Create", "tags": [ "Admin" ] } }, "/api/admin/app/payment-config/delete": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/payment-config/delete`.", "operationId": "post__api__admin__app__payment_dash_config__delete", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Payment Config Delete", "tags": [ "Admin" ] } }, "/api/admin/app/payment-config/detail": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/payment-config/detail`.", "operationId": "post__api__admin__app__payment_dash_config__detail", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Payment Config Detail", "tags": [ "Admin" ] } }, "/api/admin/app/payment-config/epay/init": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/payment-config/epay/init`.", "operationId": "post__api__admin__app__payment_dash_config__epay__init", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "epay_config": { "additionalProperties": {}, "type": "object" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "epay_config": { "additionalProperties": {}, "type": "object" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Payment Config Epay Init", "tags": [ "Admin" ] } }, "/api/admin/app/payment-config/list": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/payment-config/list`.", "operationId": "post__api__admin__app__payment_dash_config__list", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "enabled_only": { "type": "boolean" }, "payment_method": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "enabled_only": { "type": "boolean" }, "payment_method": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Payment Config List", "tags": [ "Admin" ] } }, "/api/admin/app/payment-config/methods": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/payment-config/methods`.", "operationId": "post__api__admin__app__payment_dash_config__methods", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Payment Config Methods", "tags": [ "Admin" ] } }, "/api/admin/app/payment-config/orders/detail": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/payment-config/orders/detail`.", "operationId": "post__api__admin__app__payment_dash_config__orders__detail", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "order_no": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "order_no": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Payment Config Orders Detail", "tags": [ "Admin" ] } }, "/api/admin/app/payment-config/orders/list": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/payment-config/orders/list`.", "operationId": "post__api__admin__app__payment_dash_config__orders__list", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "keyword": { "type": "string" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "payment_method": { "type": "string" }, "status": { "type": "string" }, "user_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "keyword": { "type": "string" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "payment_method": { "type": "string" }, "status": { "type": "string" }, "user_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Payment Config Orders List", "tags": [ "Admin" ] } }, "/api/admin/app/payment-config/orders/receipt": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/payment-config/orders/receipt`.", "operationId": "post__api__admin__app__payment_dash_config__orders__receipt", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "documentType": { "type": "string" }, "locale": { "type": "string" }, "order_no": { "type": "string" }, "timezone": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "documentType": { "type": "string" }, "locale": { "type": "string" }, "order_no": { "type": "string" }, "timezone": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Payment Config Orders Receipt", "tags": [ "Admin" ] } }, "/api/admin/app/payment-config/orders/receipt/email": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/payment-config/orders/receipt/email`.", "operationId": "post__api__admin__app__payment_dash_config__orders__receipt__email", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "documentType": { "type": "string" }, "email": { "type": "string" }, "locale": { "type": "string" }, "order_no": { "type": "string" }, "timezone": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "documentType": { "type": "string" }, "email": { "type": "string" }, "locale": { "type": "string" }, "order_no": { "type": "string" }, "timezone": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Payment Config Orders Receipt Email", "tags": [ "Admin" ] } }, "/api/admin/app/payment-config/receipt/options": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/payment-config/receipt/options`.", "operationId": "post__api__admin__app__payment_dash_config__receipt__options", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Payment Config Receipt Options", "tags": [ "Admin" ] } }, "/api/admin/app/payment-config/refunds/create": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/payment-config/refunds/create`.", "operationId": "post__api__admin__app__payment_dash_config__refunds__create", "requestBody": { "content": { "application/json": { "schema": { "properties": { "amount": { "type": "string" }, "appid": { "format": "int64", "type": "integer" }, "order_no": { "type": "string" }, "reason": { "type": "string" }, "reverse_fulfillment": { "nullable": true, "type": "boolean" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "amount": { "type": "string" }, "appid": { "format": "int64", "type": "integer" }, "order_no": { "type": "string" }, "reason": { "type": "string" }, "reverse_fulfillment": { "nullable": true, "type": "boolean" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Payment Config Refunds Create", "tags": [ "Admin" ] } }, "/api/admin/app/payment-config/refunds/list": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/payment-config/refunds/list`.", "operationId": "post__api__admin__app__payment_dash_config__refunds__list", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "keyword": { "type": "string" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "payment_method": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "keyword": { "type": "string" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "payment_method": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Payment Config Refunds List", "tags": [ "Admin" ] } }, "/api/admin/app/payment-config/refunds/order": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/payment-config/refunds/order`.", "operationId": "post__api__admin__app__payment_dash_config__refunds__order", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "order_no": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "order_no": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Payment Config Refunds Order", "tags": [ "Admin" ] } }, "/api/admin/app/payment-config/refunds/refundable": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/payment-config/refunds/refundable`.", "operationId": "post__api__admin__app__payment_dash_config__refunds__refundable", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "order_no": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "order_no": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Payment Config Refunds Refundable", "tags": [ "Admin" ] } }, "/api/admin/app/payment-config/refunds/sync": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/payment-config/refunds/sync`.", "operationId": "post__api__admin__app__payment_dash_config__refunds__sync", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "refund_no": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "refund_no": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Payment Config Refunds Sync", "tags": [ "Admin" ] } }, "/api/admin/app/payment-config/test": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/payment-config/test`.", "operationId": "post__api__admin__app__payment_dash_config__test", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Payment Config Test", "tags": [ "Admin" ] } }, "/api/admin/app/payment-config/update": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/payment-config/update`.", "operationId": "post__api__admin__app__payment_dash_config__update", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config_data": { "additionalProperties": {}, "type": "object" }, "config_id": { "format": "int64", "type": "integer" }, "config_name": { "type": "string" }, "description": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "is_default": { "nullable": true, "type": "boolean" }, "payment_method": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config_data": { "additionalProperties": {}, "type": "object" }, "config_id": { "format": "int64", "type": "integer" }, "config_name": { "type": "string" }, "description": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "is_default": { "nullable": true, "type": "boolean" }, "payment_method": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Payment Config Update", "tags": [ "Admin" ] } }, "/api/admin/app/role-application/batch-review": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/role-application/batch-review`.", "operationId": "post__api__admin__app__role_dash_application__batch_dash_review", "requestBody": { "content": { "application/json": { "schema": { "properties": { "action": { "type": "string" }, "appid": { "format": "int64", "type": "integer" }, "ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "reviewReason": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "action": { "type": "string" }, "appid": { "format": "int64", "type": "integer" }, "ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "reviewReason": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Role Application Batch Review", "tags": [ "Admin" ] } }, "/api/admin/app/role-application/detail": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/role-application/detail`.", "operationId": "post__api__admin__app__role_dash_application__detail", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Role Application Detail", "tags": [ "Admin" ] } }, "/api/admin/app/role-application/list": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/role-application/list`.", "operationId": "post__api__admin__app__role_dash_application__list", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "keyword": { "type": "string" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "priority": { "type": "string" }, "requestedRole": { "type": "string" }, "sortBy": { "type": "string" }, "sortOrder": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "keyword": { "type": "string" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "priority": { "type": "string" }, "requestedRole": { "type": "string" }, "sortBy": { "type": "string" }, "sortOrder": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Role Application List", "tags": [ "Admin" ] } }, "/api/admin/app/role-application/review": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/role-application/review`.", "operationId": "post__api__admin__app__role_dash_application__review", "requestBody": { "content": { "application/json": { "schema": { "properties": { "action": { "type": "string" }, "appid": { "format": "int64", "type": "integer" }, "id": { "format": "int64", "type": "integer" }, "reviewReason": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "action": { "type": "string" }, "appid": { "format": "int64", "type": "integer" }, "id": { "format": "int64", "type": "integer" }, "reviewReason": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Role Application Review", "tags": [ "Admin" ] } }, "/api/admin/app/role-application/statistics": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/role-application/statistics`.", "operationId": "post__api__admin__app__role_dash_application__statistics", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Role Application Statistics", "tags": [ "Admin" ] } }, "/api/admin/app/site/audit": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/site/audit`.", "operationId": "post__api__admin__app__site__audit", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "reason": { "type": "string" }, "siteId": { "format": "int64", "type": "integer" }, "status": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "reason": { "type": "string" }, "siteId": { "format": "int64", "type": "integer" }, "status": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Site Audit", "tags": [ "Admin" ] } }, "/api/admin/app/site/audit-list": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/site/audit-list`.", "operationId": "post__api__admin__app__site__audit_dash_list", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "category": { "type": "string" }, "keyword": { "type": "string" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "sortBy": { "type": "string" }, "sortOrder": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "category": { "type": "string" }, "keyword": { "type": "string" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "sortBy": { "type": "string" }, "sortOrder": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Site Audit List", "tags": [ "Admin" ] } }, "/api/admin/app/site/audit-stats": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/site/audit-stats`.", "operationId": "post__api__admin__app__site__audit_dash_stats", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Site Audit Stats", "tags": [ "Admin" ] } }, "/api/admin/app/site/batch-audit": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/site/batch-audit`.", "operationId": "post__api__admin__app__site__batch_dash_audit", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "reason": { "type": "string" }, "siteIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "reason": { "type": "string" }, "siteIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Site Batch Audit", "tags": [ "Admin" ] } }, "/api/admin/app/site/delete": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/site/delete`.", "operationId": "post__api__admin__app__site__delete", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Site Delete", "tags": [ "Admin" ] } }, "/api/admin/app/site/detail": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/site/detail`.", "operationId": "post__api__admin__app__site__detail", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Site Detail", "tags": [ "Admin" ] } }, "/api/admin/app/site/list": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/site/list`.", "operationId": "post__api__admin__app__site__list", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "category": { "type": "string" }, "keyword": { "type": "string" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "sortBy": { "type": "string" }, "sortOrder": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "category": { "type": "string" }, "keyword": { "type": "string" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "sortBy": { "type": "string" }, "sortOrder": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Site List", "tags": [ "Admin" ] } }, "/api/admin/app/site/toggle-pin": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/site/toggle-pin`.", "operationId": "post__api__admin__app__site__toggle_dash_pin", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "id": { "format": "int64", "type": "integer" }, "is_pinned": { "type": "boolean" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "id": { "format": "int64", "type": "integer" }, "is_pinned": { "type": "boolean" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Site Toggle Pin", "tags": [ "Admin" ] } }, "/api/admin/app/site/update": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/site/update`.", "operationId": "post__api__admin__app__site__update", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "category": { "type": "string" }, "description": { "type": "string" }, "id": { "format": "int64", "type": "integer" }, "image": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "url": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "category": { "type": "string" }, "description": { "type": "string" }, "id": { "format": "int64", "type": "integer" }, "image": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "url": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Site Update", "tags": [ "Admin" ] } }, "/api/admin/app/site/user-sites": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/site/user-sites`.", "operationId": "post__api__admin__app__site__user_dash_sites", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "userId": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "userId": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Site User Sites", "tags": [ "Admin" ] } }, "/api/admin/app/storage-config/create": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/storage-config/create`.", "operationId": "post__api__admin__app__storage_dash_config__create", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_mode": { "type": "string" }, "appid": { "format": "int64", "type": "integer" }, "base_url": { "type": "string" }, "config_data": { "additionalProperties": {}, "type": "object" }, "config_id": { "format": "int64", "type": "integer" }, "config_name": { "type": "string" }, "description": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "is_default": { "nullable": true, "type": "boolean" }, "provider": { "type": "string" }, "proxy_download": { "nullable": true, "type": "boolean" }, "root_path": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "access_mode": { "type": "string" }, "appid": { "format": "int64", "type": "integer" }, "base_url": { "type": "string" }, "config_data": { "additionalProperties": {}, "type": "object" }, "config_id": { "format": "int64", "type": "integer" }, "config_name": { "type": "string" }, "description": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "is_default": { "nullable": true, "type": "boolean" }, "provider": { "type": "string" }, "proxy_download": { "nullable": true, "type": "boolean" }, "root_path": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Storage Config Create", "tags": [ "Admin" ] } }, "/api/admin/app/storage-config/delete": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/storage-config/delete`.", "operationId": "post__api__admin__app__storage_dash_config__delete", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Storage Config Delete", "tags": [ "Admin" ] } }, "/api/admin/app/storage-config/detail": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/storage-config/detail`.", "operationId": "post__api__admin__app__storage_dash_config__detail", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Storage Config Detail", "tags": [ "Admin" ] } }, "/api/admin/app/storage-config/list": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/storage-config/list`.", "operationId": "post__api__admin__app__storage_dash_config__list", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "provider": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "provider": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Storage Config List", "tags": [ "Admin" ] } }, "/api/admin/app/storage-config/test": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/storage-config/test`.", "operationId": "post__api__admin__app__storage_dash_config__test", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Storage Config Test", "tags": [ "Admin" ] } }, "/api/admin/app/storage-config/update": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/storage-config/update`.", "operationId": "post__api__admin__app__storage_dash_config__update", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_mode": { "type": "string" }, "appid": { "format": "int64", "type": "integer" }, "base_url": { "type": "string" }, "config_data": { "additionalProperties": {}, "type": "object" }, "config_id": { "format": "int64", "type": "integer" }, "config_name": { "type": "string" }, "description": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "is_default": { "nullable": true, "type": "boolean" }, "provider": { "type": "string" }, "proxy_download": { "nullable": true, "type": "boolean" }, "root_path": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "access_mode": { "type": "string" }, "appid": { "format": "int64", "type": "integer" }, "base_url": { "type": "string" }, "config_data": { "additionalProperties": {}, "type": "object" }, "config_id": { "format": "int64", "type": "integer" }, "config_name": { "type": "string" }, "description": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "is_default": { "nullable": true, "type": "boolean" }, "provider": { "type": "string" }, "proxy_download": { "nullable": true, "type": "boolean" }, "root_path": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Storage Config Update", "tags": [ "Admin" ] } }, "/api/admin/app/version/channel/add-users": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/version/channel/add-users`.", "operationId": "post__api__admin__app__version__channel__add_dash_users", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "channel_id": { "format": "int64", "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "user_ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "channel_id": { "format": "int64", "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "user_ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Version Channel Add Users", "tags": [ "Admin" ] } }, "/api/admin/app/version/channel/create": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/version/channel/create`.", "operationId": "post__api__admin__app__version__channel__create", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "channel_id": { "format": "int64", "type": "integer" }, "code": { "type": "string" }, "color": { "type": "string" }, "description": { "type": "string" }, "is_default": { "nullable": true, "type": "boolean" }, "level": { "type": "string" }, "max_version_code": { "format": "int64", "nullable": true, "type": "integer" }, "min_version_code": { "format": "int64", "nullable": true, "type": "integer" }, "name": { "type": "string" }, "platforms": { "items": { "type": "string" }, "type": "array" }, "priority": { "nullable": true, "type": "integer" }, "rollout_pct": { "nullable": true, "type": "integer" }, "rules": { "items": { "properties": { "field": { "type": "string" }, "op": { "type": "string" }, "value": {} }, "type": "object" }, "type": "array" }, "status": { "nullable": true, "type": "boolean" }, "targetAudience": { "additionalProperties": {}, "type": "object" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "channel_id": { "format": "int64", "type": "integer" }, "code": { "type": "string" }, "color": { "type": "string" }, "description": { "type": "string" }, "is_default": { "nullable": true, "type": "boolean" }, "level": { "type": "string" }, "max_version_code": { "format": "int64", "nullable": true, "type": "integer" }, "min_version_code": { "format": "int64", "nullable": true, "type": "integer" }, "name": { "type": "string" }, "platforms": { "items": { "type": "string" }, "type": "array" }, "priority": { "nullable": true, "type": "integer" }, "rollout_pct": { "nullable": true, "type": "integer" }, "rules": { "items": { "properties": { "field": { "type": "string" }, "op": { "type": "string" }, "value": {} }, "type": "object" }, "type": "array" }, "status": { "nullable": true, "type": "boolean" }, "targetAudience": { "additionalProperties": {}, "type": "object" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Version Channel Create", "tags": [ "Admin" ] } }, "/api/admin/app/version/channel/delete": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/version/channel/delete`.", "operationId": "post__api__admin__app__version__channel__delete", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "channel_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "channel_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Version Channel Delete", "tags": [ "Admin" ] } }, "/api/admin/app/version/channel/detail": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/version/channel/detail`.", "operationId": "post__api__admin__app__version__channel__detail", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "channel_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "channel_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Version Channel Detail", "tags": [ "Admin" ] } }, "/api/admin/app/version/channel/list": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/version/channel/list`.", "operationId": "post__api__admin__app__version__channel__list", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Version Channel List", "tags": [ "Admin" ] } }, "/api/admin/app/version/channel/preview-match": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/version/channel/preview-match`.", "operationId": "post__api__admin__app__version__channel__preview_dash_match", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "channel_id": { "format": "int64", "type": "integer" }, "targetAudience": { "additionalProperties": {}, "type": "object" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "channel_id": { "format": "int64", "type": "integer" }, "targetAudience": { "additionalProperties": {}, "type": "object" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Version Channel Preview Match", "tags": [ "Admin" ] } }, "/api/admin/app/version/channel/remove-users": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/version/channel/remove-users`.", "operationId": "post__api__admin__app__version__channel__remove_dash_users", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "channel_id": { "format": "int64", "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "user_ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "channel_id": { "format": "int64", "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "user_ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Version Channel Remove Users", "tags": [ "Admin" ] } }, "/api/admin/app/version/channel/update": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/version/channel/update`.", "operationId": "post__api__admin__app__version__channel__update", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "channel_id": { "format": "int64", "type": "integer" }, "code": { "type": "string" }, "color": { "type": "string" }, "description": { "type": "string" }, "is_default": { "nullable": true, "type": "boolean" }, "level": { "type": "string" }, "max_version_code": { "format": "int64", "nullable": true, "type": "integer" }, "min_version_code": { "format": "int64", "nullable": true, "type": "integer" }, "name": { "type": "string" }, "platforms": { "items": { "type": "string" }, "type": "array" }, "priority": { "nullable": true, "type": "integer" }, "rollout_pct": { "nullable": true, "type": "integer" }, "rules": { "items": { "properties": { "field": { "type": "string" }, "op": { "type": "string" }, "value": {} }, "type": "object" }, "type": "array" }, "status": { "nullable": true, "type": "boolean" }, "targetAudience": { "additionalProperties": {}, "type": "object" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "channel_id": { "format": "int64", "type": "integer" }, "code": { "type": "string" }, "color": { "type": "string" }, "description": { "type": "string" }, "is_default": { "nullable": true, "type": "boolean" }, "level": { "type": "string" }, "max_version_code": { "format": "int64", "nullable": true, "type": "integer" }, "min_version_code": { "format": "int64", "nullable": true, "type": "integer" }, "name": { "type": "string" }, "platforms": { "items": { "type": "string" }, "type": "array" }, "priority": { "nullable": true, "type": "integer" }, "rollout_pct": { "nullable": true, "type": "integer" }, "rules": { "items": { "properties": { "field": { "type": "string" }, "op": { "type": "string" }, "value": {} }, "type": "object" }, "type": "array" }, "status": { "nullable": true, "type": "boolean" }, "targetAudience": { "additionalProperties": {}, "type": "object" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Version Channel Update", "tags": [ "Admin" ] } }, "/api/admin/app/version/channel/users": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/version/channel/users`.", "operationId": "post__api__admin__app__version__channel__users", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "channel_id": { "format": "int64", "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "user_ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "channel_id": { "format": "int64", "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "user_ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Version Channel Users", "tags": [ "Admin" ] } }, "/api/admin/app/version/create": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/version/create`.", "operationId": "post__api__admin__app__version__create", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "channel_id": { "format": "int64", "nullable": true, "type": "integer" }, "description": { "type": "string" }, "download_url": { "type": "string" }, "file_hash": { "type": "string" }, "file_size": { "format": "int64", "type": "integer" }, "force_update": { "nullable": true, "type": "boolean" }, "metadata": { "additionalProperties": {}, "type": "object" }, "min_os_version": { "type": "string" }, "platform": { "type": "string" }, "release_notes": { "type": "string" }, "status": { "type": "string" }, "update_type": { "type": "string" }, "version": { "type": "string" }, "version_code": { "format": "int64", "type": "integer" }, "version_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "channel_id": { "format": "int64", "nullable": true, "type": "integer" }, "description": { "type": "string" }, "download_url": { "type": "string" }, "file_hash": { "type": "string" }, "file_size": { "format": "int64", "type": "integer" }, "force_update": { "nullable": true, "type": "boolean" }, "metadata": { "additionalProperties": {}, "type": "object" }, "min_os_version": { "type": "string" }, "platform": { "type": "string" }, "release_notes": { "type": "string" }, "status": { "type": "string" }, "update_type": { "type": "string" }, "version": { "type": "string" }, "version_code": { "format": "int64", "type": "integer" }, "version_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Version Create", "tags": [ "Admin" ] } }, "/api/admin/app/version/delete": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/version/delete`.", "operationId": "post__api__admin__app__version__delete", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "version_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "version_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Version Delete", "tags": [ "Admin" ] } }, "/api/admin/app/version/detail": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/version/detail`.", "operationId": "post__api__admin__app__version__detail", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "version_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "version_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Version Detail", "tags": [ "Admin" ] } }, "/api/admin/app/version/list": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/version/list`.", "operationId": "post__api__admin__app__version__list", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "channel_id": { "format": "int64", "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "platform": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "channel_id": { "format": "int64", "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "platform": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Version List", "tags": [ "Admin" ] } }, "/api/admin/app/version/stats": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/version/stats`.", "operationId": "post__api__admin__app__version__stats", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Version Stats", "tags": [ "Admin" ] } }, "/api/admin/app/version/update": { "post": { "description": "Auto-generated reference for `POST /api/admin/app/version/update`.", "operationId": "post__api__admin__app__version__update", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "channel_id": { "format": "int64", "nullable": true, "type": "integer" }, "description": { "type": "string" }, "download_url": { "type": "string" }, "file_hash": { "type": "string" }, "file_size": { "format": "int64", "type": "integer" }, "force_update": { "nullable": true, "type": "boolean" }, "metadata": { "additionalProperties": {}, "type": "object" }, "min_os_version": { "type": "string" }, "platform": { "type": "string" }, "release_notes": { "type": "string" }, "status": { "type": "string" }, "update_type": { "type": "string" }, "version": { "type": "string" }, "version_code": { "format": "int64", "type": "integer" }, "version_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "channel_id": { "format": "int64", "nullable": true, "type": "integer" }, "description": { "type": "string" }, "download_url": { "type": "string" }, "file_hash": { "type": "string" }, "file_size": { "format": "int64", "type": "integer" }, "force_update": { "nullable": true, "type": "boolean" }, "metadata": { "additionalProperties": {}, "type": "object" }, "min_os_version": { "type": "string" }, "platform": { "type": "string" }, "release_notes": { "type": "string" }, "status": { "type": "string" }, "update_type": { "type": "string" }, "version": { "type": "string" }, "version_code": { "format": "int64", "type": "integer" }, "version_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin App Version Update", "tags": [ "Admin" ] } }, "/api/admin/apps": { "get": { "description": "Returns the application catalog visible to the current administrator.", "operationId": "get__api__admin__apps", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "List Applications", "tags": [ "Admin" ] }, "post": { "description": "Creates or initializes an application visible to the current administrator.", "operationId": "post__api__admin__apps", "requestBody": { "content": { "application/json": { "schema": { "properties": { "disabledLoginReason": { "nullable": true, "type": "string" }, "disabledReason": { "nullable": true, "type": "string" }, "disabledRegisterReason": { "nullable": true, "type": "string" }, "loginStatus": { "nullable": true, "type": "boolean" }, "name": { "nullable": true, "type": "string" }, "registerStatus": { "nullable": true, "type": "boolean" }, "settings": { "additionalProperties": {}, "type": "object" }, "status": { "nullable": true, "type": "boolean" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "disabledLoginReason": { "nullable": true, "type": "string" }, "disabledReason": { "nullable": true, "type": "string" }, "disabledRegisterReason": { "nullable": true, "type": "string" }, "loginStatus": { "nullable": true, "type": "boolean" }, "name": { "nullable": true, "type": "string" }, "registerStatus": { "nullable": true, "type": "boolean" }, "settings": { "additionalProperties": {}, "type": "object" }, "status": { "nullable": true, "type": "boolean" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "Create Application", "tags": [ "Admin" ] } }, "/api/admin/apps/password-policy/templates": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/password-policy/templates`.", "operationId": "get__api__admin__apps__password_dash_policy__templates", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Password Policy Templates", "tags": [ "Admin" ] } }, "/api/admin/apps/signin-reward/templates": { "get": { "description": "Returns built-in sign-in reward templates for management-side initialization.", "operationId": "get__api__admin__apps__signin_dash_reward__templates", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "List Sign-in Reward Templates", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/apps/{appkey}`.", "operationId": "delete__api__admin__apps___by_appkey", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Apps Appkey", "tags": [ "Admin" ] }, "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}`.", "operationId": "get__api__admin__apps___by_appkey", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey", "tags": [ "Admin" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/apps/{appkey}`.", "operationId": "put__api__admin__apps___by_appkey", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "disabledLoginReason": { "nullable": true, "type": "string" }, "disabledReason": { "nullable": true, "type": "string" }, "disabledRegisterReason": { "nullable": true, "type": "string" }, "loginStatus": { "nullable": true, "type": "boolean" }, "name": { "nullable": true, "type": "string" }, "registerStatus": { "nullable": true, "type": "boolean" }, "settings": { "additionalProperties": {}, "type": "object" }, "status": { "nullable": true, "type": "boolean" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "disabledLoginReason": { "nullable": true, "type": "string" }, "disabledReason": { "nullable": true, "type": "string" }, "disabledRegisterReason": { "nullable": true, "type": "string" }, "loginStatus": { "nullable": true, "type": "boolean" }, "name": { "nullable": true, "type": "string" }, "registerStatus": { "nullable": true, "type": "boolean" }, "settings": { "additionalProperties": {}, "type": "object" }, "status": { "nullable": true, "type": "boolean" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin Apps Appkey", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/audits/login": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/audits/login`.", "operationId": "get__api__admin__apps___by_appkey__audits__login", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "keyword", "schema": { "type": "string" } }, { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Audits Login", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/audits/login/export": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/audits/login/export`.", "operationId": "get__api__admin__apps___by_appkey__audits__login__export", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "keyword", "schema": { "type": "string" } }, { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Audits Login Export", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/audits/sessions": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/audits/sessions`.", "operationId": "get__api__admin__apps___by_appkey__audits__sessions", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "keyword", "schema": { "type": "string" } }, { "in": "query", "name": "eventType", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Audits Sessions", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/audits/sessions/export": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/audits/sessions/export`.", "operationId": "get__api__admin__apps___by_appkey__audits__sessions__export", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "keyword", "schema": { "type": "string" } }, { "in": "query", "name": "eventType", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Audits Sessions Export", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/auth-protocol": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/auth-protocol`.", "operationId": "get__api__admin__apps___by_appkey__auth_dash_protocol", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Auth Protocol", "tags": [ "Admin" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/apps/{appkey}/auth-protocol`.", "operationId": "put__api__admin__apps___by_appkey__auth_dash_protocol", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "allowLegacy": { "nullable": true, "type": "boolean" }, "autoLoginAfterRegister": { "nullable": true, "type": "boolean" }, "identifiers": { "items": { "type": "string" }, "type": "array" }, "loginMethods": { "items": { "type": "string" }, "type": "array" }, "registerMethods": { "items": { "type": "string" }, "type": "array" }, "registrationSchema": { "items": { "properties": { "label": { "type": "string" }, "mutable": { "type": "boolean" }, "name": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "type": { "type": "string" } }, "type": "object" }, "type": "array" }, "requireCaptcha": { "nullable": true, "type": "boolean" }, "securityLevel": { "nullable": true, "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "allowLegacy": { "nullable": true, "type": "boolean" }, "autoLoginAfterRegister": { "nullable": true, "type": "boolean" }, "identifiers": { "items": { "type": "string" }, "type": "array" }, "loginMethods": { "items": { "type": "string" }, "type": "array" }, "registerMethods": { "items": { "type": "string" }, "type": "array" }, "registrationSchema": { "items": { "properties": { "label": { "type": "string" }, "mutable": { "type": "boolean" }, "name": { "type": "string" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "type": { "type": "string" } }, "type": "object" }, "type": "array" }, "requireCaptcha": { "nullable": true, "type": "boolean" }, "securityLevel": { "nullable": true, "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin Apps Appkey Auth Protocol", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/auth-protocol/secret/rotate": { "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/auth-protocol/secret/rotate`.", "operationId": "post__api__admin__apps___by_appkey__auth_dash_protocol__secret__rotate", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Auth Protocol Secret Rotate", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/auth-protocol/selftest": { "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/auth-protocol/selftest`.", "operationId": "post__api__admin__apps___by_appkey__auth_dash_protocol__selftest", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "baseUrl": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "baseUrl": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Auth Protocol Selftest", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/auth-protocol/transport/keys": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/auth-protocol/transport/keys`.", "operationId": "get__api__admin__apps___by_appkey__auth_dash_protocol__transport__keys", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Auth Protocol Transport Keys", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/auth-protocol/transport/keys/{keyId}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/apps/{appkey}/auth-protocol/transport/keys/{keyId}`.", "operationId": "delete__api__admin__apps___by_appkey__auth_dash_protocol__transport__keys___by_keyId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "keyId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Apps Appkey Auth Protocol Transport Keys KeyId", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/auth-protocol/transport/rotate": { "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/auth-protocol/transport/rotate`.", "operationId": "post__api__admin__apps___by_appkey__auth_dash_protocol__transport__rotate", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Auth Protocol Transport Rotate", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/banners": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/apps/{appkey}/banners`.", "operationId": "delete__api__admin__apps___by_appkey__banners", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Apps Appkey Banners", "tags": [ "Admin" ] }, "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/banners`.", "operationId": "get__api__admin__apps___by_appkey__banners", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "type", "schema": { "type": "string" } }, { "in": "query", "name": "keyword", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Banners", "tags": [ "Admin" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/banners`.", "operationId": "post__api__admin__apps___by_appkey__banners", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "content": { "nullable": true, "type": "string" }, "endTime": { "format": "date-time", "nullable": true, "type": "string" }, "header": { "nullable": true, "type": "string" }, "position": { "nullable": true, "type": "integer" }, "startTime": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "nullable": true, "type": "boolean" }, "title": { "nullable": true, "type": "string" }, "type": { "nullable": true, "type": "string" }, "url": { "nullable": true, "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "content": { "nullable": true, "type": "string" }, "endTime": { "format": "date-time", "nullable": true, "type": "string" }, "header": { "nullable": true, "type": "string" }, "position": { "nullable": true, "type": "integer" }, "startTime": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "nullable": true, "type": "boolean" }, "title": { "nullable": true, "type": "string" }, "type": { "nullable": true, "type": "string" }, "url": { "nullable": true, "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Banners", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/banners/export": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/banners/export`.", "operationId": "get__api__admin__apps___by_appkey__banners__export", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Banners Export", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/banners/image": { "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/banners/image`.", "operationId": "post__api__admin__apps___by_appkey__banners__image", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Banners Image", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/banners/order": { "put": { "description": "Auto-generated reference for `PUT /api/admin/apps/{appkey}/banners/order`.", "operationId": "put__api__admin__apps___by_appkey__banners__order", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin Apps Appkey Banners Order", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/banners/{bannerId}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/apps/{appkey}/banners/{bannerId}`.", "operationId": "delete__api__admin__apps___by_appkey__banners___by_bannerId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "bannerId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Apps Appkey Banners BannerId", "tags": [ "Admin" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/apps/{appkey}/banners/{bannerId}`.", "operationId": "put__api__admin__apps___by_appkey__banners___by_bannerId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "bannerId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "content": { "nullable": true, "type": "string" }, "endTime": { "format": "date-time", "nullable": true, "type": "string" }, "header": { "nullable": true, "type": "string" }, "position": { "nullable": true, "type": "integer" }, "startTime": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "nullable": true, "type": "boolean" }, "title": { "nullable": true, "type": "string" }, "type": { "nullable": true, "type": "string" }, "url": { "nullable": true, "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "content": { "nullable": true, "type": "string" }, "endTime": { "format": "date-time", "nullable": true, "type": "string" }, "header": { "nullable": true, "type": "string" }, "position": { "nullable": true, "type": "integer" }, "startTime": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "nullable": true, "type": "boolean" }, "title": { "nullable": true, "type": "string" }, "type": { "nullable": true, "type": "string" }, "url": { "nullable": true, "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin Apps Appkey Banners BannerId", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/captcha-config": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/captcha-config`.", "operationId": "get__api__admin__apps___by_appkey__captcha_dash_config", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Captcha Config", "tags": [ "Admin" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/apps/{appkey}/captcha-config`.", "operationId": "put__api__admin__apps___by_appkey__captcha_dash_config", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "antiFlood": { "properties": { "globalPhoneDailyLimit": { "type": "integer" }, "ipDailyLimit": { "type": "integer" }, "ipHourlyLimit": { "type": "integer" }, "phoneDailyLimit": { "type": "integer" }, "requireCaptcha": { "type": "boolean" }, "sendIntervalSeconds": { "type": "integer" } }, "type": "object" }, "audioEnabled": { "type": "boolean" }, "chiralEnabled": { "type": "boolean" }, "defaultType": { "type": "string" }, "digitEnabled": { "type": "boolean" }, "dynamic": { "nullable": true, "properties": { "frameDelayMs": { "type": "integer" }, "frames": { "type": "integer" }, "height": { "type": "integer" }, "length": { "type": "integer" }, "mode": { "type": "string" }, "noise": { "type": "integer" }, "width": { "type": "integer" }, "wobble": { "type": "integer" } }, "type": "object" }, "dynamicEnabled": { "type": "boolean" }, "imageEnabled": { "type": "boolean" }, "mathEnabled": { "type": "boolean" }, "requireForLogin": { "type": "boolean" }, "requireForRegister": { "type": "boolean" }, "sms": { "properties": { "accessKey": { "type": "string" }, "codeParamKey": { "type": "string" }, "provider": { "type": "string" }, "region": { "type": "string" }, "sdkAppId": { "type": "string" }, "secretKey": { "type": "string" }, "signName": { "type": "string" }, "templateId": { "type": "string" }, "templates": { "items": { "properties": { "codeParamKey": { "type": "string" }, "enabled": { "type": "boolean" }, "name": { "type": "string" }, "purpose": { "type": "string" }, "signName": { "type": "string" }, "templateId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "smsEnabled": { "type": "boolean" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "antiFlood": { "properties": { "globalPhoneDailyLimit": { "type": "integer" }, "ipDailyLimit": { "type": "integer" }, "ipHourlyLimit": { "type": "integer" }, "phoneDailyLimit": { "type": "integer" }, "requireCaptcha": { "type": "boolean" }, "sendIntervalSeconds": { "type": "integer" } }, "type": "object" }, "audioEnabled": { "type": "boolean" }, "chiralEnabled": { "type": "boolean" }, "defaultType": { "type": "string" }, "digitEnabled": { "type": "boolean" }, "dynamic": { "nullable": true, "properties": { "frameDelayMs": { "type": "integer" }, "frames": { "type": "integer" }, "height": { "type": "integer" }, "length": { "type": "integer" }, "mode": { "type": "string" }, "noise": { "type": "integer" }, "width": { "type": "integer" }, "wobble": { "type": "integer" } }, "type": "object" }, "dynamicEnabled": { "type": "boolean" }, "imageEnabled": { "type": "boolean" }, "mathEnabled": { "type": "boolean" }, "requireForLogin": { "type": "boolean" }, "requireForRegister": { "type": "boolean" }, "sms": { "properties": { "accessKey": { "type": "string" }, "codeParamKey": { "type": "string" }, "provider": { "type": "string" }, "region": { "type": "string" }, "sdkAppId": { "type": "string" }, "secretKey": { "type": "string" }, "signName": { "type": "string" }, "templateId": { "type": "string" }, "templates": { "items": { "properties": { "codeParamKey": { "type": "string" }, "enabled": { "type": "boolean" }, "name": { "type": "string" }, "purpose": { "type": "string" }, "signName": { "type": "string" }, "templateId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "smsEnabled": { "type": "boolean" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin Apps Appkey Captcha Config", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/captcha-config/preview": { "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/captcha-config/preview`.", "operationId": "post__api__admin__apps___by_appkey__captcha_dash_config__preview", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "frameDelayMs": { "type": "integer" }, "frames": { "type": "integer" }, "height": { "type": "integer" }, "length": { "type": "integer" }, "mode": { "type": "string" }, "noise": { "type": "integer" }, "width": { "type": "integer" }, "wobble": { "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "frameDelayMs": { "type": "integer" }, "frames": { "type": "integer" }, "height": { "type": "integer" }, "length": { "type": "integer" }, "mode": { "type": "string" }, "noise": { "type": "integer" }, "width": { "type": "integer" }, "wobble": { "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Captcha Config Preview", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/captcha-config/test-sms": { "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/captcha-config/test-sms`.", "operationId": "post__api__admin__apps___by_appkey__captcha_dash_config__test_dash_sms", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "phone": { "type": "string" }, "purpose": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "phone": { "type": "string" }, "purpose": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Captcha Config Test Sms", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/card-keys/batches": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/card-keys/batches`.", "operationId": "get__api__admin__apps___by_appkey__card_dash_keys__batches", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Card Keys Batches", "tags": [ "Admin" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/card-keys/batches`.", "operationId": "post__api__admin__apps___by_appkey__card_dash_keys__batches", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "codePrefix": { "type": "string" }, "count": { "type": "integer" }, "kind": { "type": "string" }, "maxDevices": { "type": "integer" }, "name": { "type": "string" }, "remark": { "type": "string" }, "rewards": { "items": { "properties": { "amount": { "format": "int64", "type": "integer" }, "money": { "type": "string" }, "refId": { "format": "int64", "type": "integer" }, "type": { "type": "string" } }, "type": "object" }, "type": "array" }, "segmentLength": { "type": "integer" }, "segments": { "type": "integer" }, "validUntil": { "format": "date-time", "nullable": true, "type": "string" }, "validityDays": { "type": "integer" }, "validityMode": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "codePrefix": { "type": "string" }, "count": { "type": "integer" }, "kind": { "type": "string" }, "maxDevices": { "type": "integer" }, "name": { "type": "string" }, "remark": { "type": "string" }, "rewards": { "items": { "properties": { "amount": { "format": "int64", "type": "integer" }, "money": { "type": "string" }, "refId": { "format": "int64", "type": "integer" }, "type": { "type": "string" } }, "type": "object" }, "type": "array" }, "segmentLength": { "type": "integer" }, "segments": { "type": "integer" }, "validUntil": { "format": "date-time", "nullable": true, "type": "string" }, "validityDays": { "type": "integer" }, "validityMode": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Card Keys Batches", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/card-keys/batches/{batchId}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/apps/{appkey}/card-keys/batches/{batchId}`.", "operationId": "delete__api__admin__apps___by_appkey__card_dash_keys__batches___by_batchId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "batchId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Apps Appkey Card Keys Batches BatchId", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/card-keys/batches/{batchId}/export": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/card-keys/batches/{batchId}/export`.", "operationId": "get__api__admin__apps___by_appkey__card_dash_keys__batches___by_batchId__export", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "batchId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Card Keys Batches BatchId Export", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/card-keys/batches/{batchId}/status": { "put": { "description": "Auto-generated reference for `PUT /api/admin/apps/{appkey}/card-keys/batches/{batchId}/status`.", "operationId": "put__api__admin__apps___by_appkey__card_dash_keys__batches___by_batchId__status", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "batchId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "enabled": { "type": "boolean" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "enabled": { "type": "boolean" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin Apps Appkey Card Keys Batches BatchId Status", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/card-keys/catalog": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/card-keys/catalog`.", "operationId": "get__api__admin__apps___by_appkey__card_dash_keys__catalog", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Card Keys Catalog", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/card-keys/codes": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/card-keys/codes`.", "operationId": "get__api__admin__apps___by_appkey__card_dash_keys__codes", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Card Keys Codes", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/card-keys/codes/disable": { "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/card-keys/codes/disable`.", "operationId": "post__api__admin__apps___by_appkey__card_dash_keys__codes__disable", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "reason": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "reason": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Card Keys Codes Disable", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/card-keys/codes/restore": { "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/card-keys/codes/restore`.", "operationId": "post__api__admin__apps___by_appkey__card_dash_keys__codes__restore", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "reason": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "reason": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Card Keys Codes Restore", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/card-keys/codes/{cardId}/devices": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/card-keys/codes/{cardId}/devices`.", "operationId": "get__api__admin__apps___by_appkey__card_dash_keys__codes___by_cardId__devices", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "cardId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Card Keys Codes CardId Devices", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/card-keys/codes/{cardId}/devices/{deviceId}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/apps/{appkey}/card-keys/codes/{cardId}/devices/{deviceId}`.", "operationId": "delete__api__admin__apps___by_appkey__card_dash_keys__codes___by_cardId__devices___by_deviceId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "cardId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "deviceId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Apps Appkey Card Keys Codes CardId Devices DeviceId", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/card-keys/redemptions": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/card-keys/redemptions`.", "operationId": "get__api__admin__apps___by_appkey__card_dash_keys__redemptions", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Card Keys Redemptions", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/channels": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/channels`.", "operationId": "get__api__admin__apps___by_appkey__channels", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Channels", "tags": [ "Admin" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/channels`.", "operationId": "post__api__admin__apps___by_appkey__channels", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "channel_id": { "format": "int64", "type": "integer" }, "code": { "type": "string" }, "color": { "type": "string" }, "description": { "type": "string" }, "is_default": { "nullable": true, "type": "boolean" }, "level": { "type": "string" }, "max_version_code": { "format": "int64", "nullable": true, "type": "integer" }, "min_version_code": { "format": "int64", "nullable": true, "type": "integer" }, "name": { "type": "string" }, "platforms": { "items": { "type": "string" }, "type": "array" }, "priority": { "nullable": true, "type": "integer" }, "rollout_pct": { "nullable": true, "type": "integer" }, "rules": { "items": { "properties": { "field": { "type": "string" }, "op": { "type": "string" }, "value": {} }, "type": "object" }, "type": "array" }, "status": { "nullable": true, "type": "boolean" }, "targetAudience": { "additionalProperties": {}, "type": "object" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "channel_id": { "format": "int64", "type": "integer" }, "code": { "type": "string" }, "color": { "type": "string" }, "description": { "type": "string" }, "is_default": { "nullable": true, "type": "boolean" }, "level": { "type": "string" }, "max_version_code": { "format": "int64", "nullable": true, "type": "integer" }, "min_version_code": { "format": "int64", "nullable": true, "type": "integer" }, "name": { "type": "string" }, "platforms": { "items": { "type": "string" }, "type": "array" }, "priority": { "nullable": true, "type": "integer" }, "rollout_pct": { "nullable": true, "type": "integer" }, "rules": { "items": { "properties": { "field": { "type": "string" }, "op": { "type": "string" }, "value": {} }, "type": "object" }, "type": "array" }, "status": { "nullable": true, "type": "boolean" }, "targetAudience": { "additionalProperties": {}, "type": "object" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Channels", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/channels/{cid}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/apps/{appkey}/channels/{cid}`.", "operationId": "delete__api__admin__apps___by_appkey__channels___by_cid", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "cid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Apps Appkey Channels Cid", "tags": [ "Admin" ] }, "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/channels/{cid}`.", "operationId": "get__api__admin__apps___by_appkey__channels___by_cid", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "cid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Channels Cid", "tags": [ "Admin" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/apps/{appkey}/channels/{cid}`.", "operationId": "put__api__admin__apps___by_appkey__channels___by_cid", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "cid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "channel_id": { "format": "int64", "type": "integer" }, "code": { "type": "string" }, "color": { "type": "string" }, "description": { "type": "string" }, "is_default": { "nullable": true, "type": "boolean" }, "level": { "type": "string" }, "max_version_code": { "format": "int64", "nullable": true, "type": "integer" }, "min_version_code": { "format": "int64", "nullable": true, "type": "integer" }, "name": { "type": "string" }, "platforms": { "items": { "type": "string" }, "type": "array" }, "priority": { "nullable": true, "type": "integer" }, "rollout_pct": { "nullable": true, "type": "integer" }, "rules": { "items": { "properties": { "field": { "type": "string" }, "op": { "type": "string" }, "value": {} }, "type": "object" }, "type": "array" }, "status": { "nullable": true, "type": "boolean" }, "targetAudience": { "additionalProperties": {}, "type": "object" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "channel_id": { "format": "int64", "type": "integer" }, "code": { "type": "string" }, "color": { "type": "string" }, "description": { "type": "string" }, "is_default": { "nullable": true, "type": "boolean" }, "level": { "type": "string" }, "max_version_code": { "format": "int64", "nullable": true, "type": "integer" }, "min_version_code": { "format": "int64", "nullable": true, "type": "integer" }, "name": { "type": "string" }, "platforms": { "items": { "type": "string" }, "type": "array" }, "priority": { "nullable": true, "type": "integer" }, "rollout_pct": { "nullable": true, "type": "integer" }, "rules": { "items": { "properties": { "field": { "type": "string" }, "op": { "type": "string" }, "value": {} }, "type": "object" }, "type": "array" }, "status": { "nullable": true, "type": "boolean" }, "targetAudience": { "additionalProperties": {}, "type": "object" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin Apps Appkey Channels Cid", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/channels/{cid}/users": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/apps/{appkey}/channels/{cid}/users`.", "operationId": "delete__api__admin__apps___by_appkey__channels___by_cid__users", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "cid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "user_ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "user_ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Apps Appkey Channels Cid Users", "tags": [ "Admin" ] }, "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/channels/{cid}/users`.", "operationId": "get__api__admin__apps___by_appkey__channels___by_cid__users", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "cid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Channels Cid Users", "tags": [ "Admin" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/channels/{cid}/users`.", "operationId": "post__api__admin__apps___by_appkey__channels___by_cid__users", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "cid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "user_ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "user_ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Channels Cid Users", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/commerce": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/commerce`.", "operationId": "get__api__admin__apps___by_appkey__commerce", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Commerce", "tags": [ "Admin" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/apps/{appkey}/commerce`.", "operationId": "put__api__admin__apps___by_appkey__commerce", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "integralPerCurrency": { "type": "integer" }, "receiptEmailOnPaid": { "type": "boolean" }, "receiptLocale": { "type": "string" }, "walletCurrency": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "integralPerCurrency": { "type": "integer" }, "receiptEmailOnPaid": { "type": "boolean" }, "receiptLocale": { "type": "string" }, "walletCurrency": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin Apps Appkey Commerce", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/commerce/overview": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/commerce/overview`.", "operationId": "get__api__admin__apps___by_appkey__commerce__overview", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "start", "schema": { "type": "string" } }, { "in": "query", "name": "end", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Commerce Overview", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/content/overview": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/content/overview`.", "operationId": "get__api__admin__apps___by_appkey__content__overview", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Content Overview", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/encryption": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/encryption`.", "operationId": "get__api__admin__apps___by_appkey__encryption", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Encryption", "tags": [ "Admin" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/apps/{appkey}/encryption`.", "operationId": "put__api__admin__apps___by_appkey__encryption", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "allowedAlgorithms": { "items": { "type": "string" }, "type": "array" }, "enabled": { "nullable": true, "type": "boolean" }, "generateECDHKey": { "type": "boolean" }, "generateRSAKey": { "type": "boolean" }, "responseEncryption": { "nullable": true, "type": "boolean" }, "secret": { "nullable": true, "type": "string" }, "strict": { "nullable": true, "type": "boolean" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "allowedAlgorithms": { "items": { "type": "string" }, "type": "array" }, "enabled": { "nullable": true, "type": "boolean" }, "generateECDHKey": { "type": "boolean" }, "generateRSAKey": { "type": "boolean" }, "responseEncryption": { "nullable": true, "type": "boolean" }, "secret": { "nullable": true, "type": "string" }, "strict": { "nullable": true, "type": "boolean" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin Apps Appkey Encryption", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/function-catalog": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/function-catalog`.", "operationId": "get__api__admin__apps___by_appkey__function_dash_catalog", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Function Catalog", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/function-keys": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/function-keys`.", "operationId": "get__api__admin__apps___by_appkey__function_dash_keys", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Function Keys", "tags": [ "Admin" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/function-keys`.", "operationId": "post__api__admin__apps___by_appkey__function_dash_keys", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "name": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "name": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Function Keys", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/function-keys/{keyId}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/apps/{appkey}/function-keys/{keyId}`.", "operationId": "delete__api__admin__apps___by_appkey__function_dash_keys___by_keyId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "keyId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Apps Appkey Function Keys KeyId", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/function-kv": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/apps/{appkey}/function-kv`.", "operationId": "delete__api__admin__apps___by_appkey__function_dash_kv", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Apps Appkey Function Kv", "tags": [ "Admin" ] }, "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/function-kv`.", "operationId": "get__api__admin__apps___by_appkey__function_dash_kv", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Function Kv", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/functions": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/functions`.", "operationId": "get__api__admin__apps___by_appkey__functions", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Functions", "tags": [ "Admin" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/functions`.", "operationId": "post__api__admin__apps___by_appkey__functions", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "capabilities": { "items": { "type": "string" }, "type": "array" }, "config": {}, "description": { "type": "string" }, "inputSchema": {}, "maxConcurrency": { "type": "integer" }, "maxRequestBytes": { "type": "integer" }, "maxResponseBytes": { "type": "integer" }, "name": { "type": "string" }, "rateLimitPerMin": { "type": "integer" }, "runtime": { "type": "string" }, "timeoutMs": { "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "capabilities": { "items": { "type": "string" }, "type": "array" }, "config": {}, "description": { "type": "string" }, "inputSchema": {}, "maxConcurrency": { "type": "integer" }, "maxRequestBytes": { "type": "integer" }, "maxResponseBytes": { "type": "integer" }, "name": { "type": "string" }, "rateLimitPerMin": { "type": "integer" }, "runtime": { "type": "string" }, "timeoutMs": { "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Functions", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/functions/{functionName}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/apps/{appkey}/functions/{functionName}`.", "operationId": "delete__api__admin__apps___by_appkey__functions___by_functionName", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "functionName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Apps Appkey Functions FunctionName", "tags": [ "Admin" ] }, "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/functions/{functionName}`.", "operationId": "get__api__admin__apps___by_appkey__functions___by_functionName", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "functionName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Functions FunctionName", "tags": [ "Admin" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/apps/{appkey}/functions/{functionName}`.", "operationId": "put__api__admin__apps___by_appkey__functions___by_functionName", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "functionName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "capabilities": { "items": { "type": "string" }, "type": "array" }, "config": {}, "description": { "nullable": true, "type": "string" }, "inputSchema": {}, "maxConcurrency": { "nullable": true, "type": "integer" }, "maxRequestBytes": { "nullable": true, "type": "integer" }, "maxResponseBytes": { "nullable": true, "type": "integer" }, "rateLimitPerMin": { "nullable": true, "type": "integer" }, "status": { "nullable": true, "type": "string" }, "timeoutMs": { "nullable": true, "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "capabilities": { "items": { "type": "string" }, "type": "array" }, "config": {}, "description": { "nullable": true, "type": "string" }, "inputSchema": {}, "maxConcurrency": { "nullable": true, "type": "integer" }, "maxRequestBytes": { "nullable": true, "type": "integer" }, "maxResponseBytes": { "nullable": true, "type": "integer" }, "rateLimitPerMin": { "nullable": true, "type": "integer" }, "status": { "nullable": true, "type": "string" }, "timeoutMs": { "nullable": true, "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin Apps Appkey Functions FunctionName", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/functions/{functionName}/analyze": { "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/functions/{functionName}/analyze`.", "operationId": "post__api__admin__apps___by_appkey__functions___by_functionName__analyze", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "functionName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "source": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "source": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Functions FunctionName Analyze", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/functions/{functionName}/invocations": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/functions/{functionName}/invocations`.", "operationId": "get__api__admin__apps___by_appkey__functions___by_functionName__invocations", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "functionName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Functions FunctionName Invocations", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/functions/{functionName}/invoke": { "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/functions/{functionName}/invoke`.", "operationId": "post__api__admin__apps___by_appkey__functions___by_functionName__invoke", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "functionName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "eventId": { "type": "string" }, "input": {} }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "eventId": { "type": "string" }, "input": {} }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Functions FunctionName Invoke", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/functions/{functionName}/stats": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/functions/{functionName}/stats`.", "operationId": "get__api__admin__apps___by_appkey__functions___by_functionName__stats", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "functionName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Functions FunctionName Stats", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/functions/{functionName}/test": { "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/functions/{functionName}/test`.", "operationId": "post__api__admin__apps___by_appkey__functions___by_functionName__test", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "functionName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "asUserId": { "format": "int64", "type": "integer" }, "config": {}, "input": {}, "source": { "type": "string" }, "timeoutMs": { "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "asUserId": { "format": "int64", "type": "integer" }, "config": {}, "input": {}, "source": { "type": "string" }, "timeoutMs": { "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Functions FunctionName Test", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/functions/{functionName}/versions": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/functions/{functionName}/versions`.", "operationId": "get__api__admin__apps___by_appkey__functions___by_functionName__versions", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "functionName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Functions FunctionName Versions", "tags": [ "Admin" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/functions/{functionName}/versions`.", "operationId": "post__api__admin__apps___by_appkey__functions___by_functionName__versions", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "functionName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "endpointUrl": { "type": "string" }, "notes": { "type": "string" }, "responsePublicKey": { "type": "string" }, "source": { "type": "string" }, "version": { "type": "string" }, "wasmBase64": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "endpointUrl": { "type": "string" }, "notes": { "type": "string" }, "responsePublicKey": { "type": "string" }, "source": { "type": "string" }, "version": { "type": "string" }, "wasmBase64": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Functions FunctionName Versions", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/functions/{functionName}/versions/{version}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/apps/{appkey}/functions/{functionName}/versions/{version}`.", "operationId": "delete__api__admin__apps___by_appkey__functions___by_functionName__versions___by_version", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "functionName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "version", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Apps Appkey Functions FunctionName Versions Version", "tags": [ "Admin" ] }, "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/functions/{functionName}/versions/{version}`.", "operationId": "get__api__admin__apps___by_appkey__functions___by_functionName__versions___by_version", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "functionName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "version", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Functions FunctionName Versions Version", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/functions/{functionName}/versions/{version}/activate": { "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/functions/{functionName}/versions/{version}/activate`.", "operationId": "post__api__admin__apps___by_appkey__functions___by_functionName__versions___by_version__activate", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "functionName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "version", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Functions FunctionName Versions Version Activate", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/governance": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/governance`.", "operationId": "get__api__admin__apps___by_appkey__governance", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Governance", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/governance/appeals": { "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/governance/appeals`.", "operationId": "post__api__admin__apps___by_appkey__governance__appeals", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "attachments": { "items": { "type": "string" }, "type": "array" }, "content": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "attachments": { "items": { "type": "string" }, "type": "array" }, "content": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Governance Appeals", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/governance/appeals/{appealId}/withdraw": { "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/governance/appeals/{appealId}/withdraw`.", "operationId": "post__api__admin__apps___by_appkey__governance__appeals___by_appealId__withdraw", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "appealId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Governance Appeals AppealId Withdraw", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/governance/history": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/governance/history`.", "operationId": "get__api__admin__apps___by_appkey__governance__history", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Governance History", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/login-baseline/{userid}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/apps/{appkey}/login-baseline/{userid}`.", "operationId": "delete__api__admin__apps___by_appkey__login_dash_baseline___by_userid", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "userid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Apps Appkey Login Baseline Userid", "tags": [ "Admin" ] }, "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/login-baseline/{userid}`.", "operationId": "get__api__admin__apps___by_appkey__login_dash_baseline___by_userid", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "userid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Login Baseline Userid", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/lottery/activities": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/lottery/activities`.", "operationId": "get__api__admin__apps___by_appkey__lottery__activities", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "keyword", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Lottery Activities", "tags": [ "Admin" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/lottery/activities`.", "operationId": "post__api__admin__apps___by_appkey__lottery__activities", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "autoJoinRules": { "additionalProperties": {}, "type": "object" }, "costAmount": { "type": "integer" }, "costType": { "type": "string" }, "dailyLimit": { "type": "integer" }, "description": { "type": "string" }, "endTime": { "format": "date-time", "type": "string" }, "joinMode": { "type": "string" }, "name": { "type": "string" }, "startTime": { "format": "date-time", "type": "string" }, "status": { "type": "string" }, "totalLimit": { "type": "integer" }, "uiMode": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "autoJoinRules": { "additionalProperties": {}, "type": "object" }, "costAmount": { "type": "integer" }, "costType": { "type": "string" }, "dailyLimit": { "type": "integer" }, "description": { "type": "string" }, "endTime": { "format": "date-time", "type": "string" }, "joinMode": { "type": "string" }, "name": { "type": "string" }, "startTime": { "format": "date-time", "type": "string" }, "status": { "type": "string" }, "totalLimit": { "type": "integer" }, "uiMode": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Lottery Activities", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/lottery/activities/{id}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/apps/{appkey}/lottery/activities/{id}`.", "operationId": "delete__api__admin__apps___by_appkey__lottery__activities___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Apps Appkey Lottery Activities Id", "tags": [ "Admin" ] }, "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/lottery/activities/{id}`.", "operationId": "get__api__admin__apps___by_appkey__lottery__activities___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Lottery Activities Id", "tags": [ "Admin" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/apps/{appkey}/lottery/activities/{id}`.", "operationId": "put__api__admin__apps___by_appkey__lottery__activities___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "autoJoinRules": { "additionalProperties": {}, "type": "object" }, "costAmount": { "nullable": true, "type": "integer" }, "costType": { "nullable": true, "type": "string" }, "dailyLimit": { "nullable": true, "type": "integer" }, "description": { "nullable": true, "type": "string" }, "endTime": { "format": "date-time", "nullable": true, "type": "string" }, "joinMode": { "nullable": true, "type": "string" }, "name": { "nullable": true, "type": "string" }, "startTime": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "nullable": true, "type": "string" }, "totalLimit": { "nullable": true, "type": "integer" }, "uiMode": { "nullable": true, "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "autoJoinRules": { "additionalProperties": {}, "type": "object" }, "costAmount": { "nullable": true, "type": "integer" }, "costType": { "nullable": true, "type": "string" }, "dailyLimit": { "nullable": true, "type": "integer" }, "description": { "nullable": true, "type": "string" }, "endTime": { "format": "date-time", "nullable": true, "type": "string" }, "joinMode": { "nullable": true, "type": "string" }, "name": { "nullable": true, "type": "string" }, "startTime": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "nullable": true, "type": "string" }, "totalLimit": { "nullable": true, "type": "integer" }, "uiMode": { "nullable": true, "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin Apps Appkey Lottery Activities Id", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/lottery/activities/{id}/prizes": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/lottery/activities/{id}/prizes`.", "operationId": "get__api__admin__apps___by_appkey__lottery__activities___by_id__prizes", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Lottery Activities Id Prizes", "tags": [ "Admin" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/lottery/activities/{id}/prizes`.", "operationId": "post__api__admin__apps___by_appkey__lottery__activities___by_id__prizes", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "extra": { "additionalProperties": {}, "type": "object" }, "imageUrl": { "type": "string" }, "isDefault": { "type": "boolean" }, "name": { "type": "string" }, "position": { "type": "integer" }, "quantity": { "type": "integer" }, "type": { "type": "string" }, "value": { "type": "string" }, "weight": { "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "extra": { "additionalProperties": {}, "type": "object" }, "imageUrl": { "type": "string" }, "isDefault": { "type": "boolean" }, "name": { "type": "string" }, "position": { "type": "integer" }, "quantity": { "type": "integer" }, "type": { "type": "string" }, "value": { "type": "string" }, "weight": { "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Lottery Activities Id Prizes", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/lottery/activities/{id}/seed/commit": { "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/lottery/activities/{id}/seed/commit`.", "operationId": "post__api__admin__apps___by_appkey__lottery__activities___by_id__seed__commit", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Lottery Activities Id Seed Commit", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/lottery/activities/{id}/seed/reveal": { "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/lottery/activities/{id}/seed/reveal`.", "operationId": "post__api__admin__apps___by_appkey__lottery__activities___by_id__seed__reveal", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Lottery Activities Id Seed Reveal", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/lottery/activities/{id}/stats": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/lottery/activities/{id}/stats`.", "operationId": "get__api__admin__apps___by_appkey__lottery__activities___by_id__stats", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Lottery Activities Id Stats", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/lottery/draws": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/lottery/draws`.", "operationId": "get__api__admin__apps___by_appkey__lottery__draws", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "activityId", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "userId", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Lottery Draws", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/lottery/prizes/{id}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/apps/{appkey}/lottery/prizes/{id}`.", "operationId": "delete__api__admin__apps___by_appkey__lottery__prizes___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Apps Appkey Lottery Prizes Id", "tags": [ "Admin" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/apps/{appkey}/lottery/prizes/{id}`.", "operationId": "put__api__admin__apps___by_appkey__lottery__prizes___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "extra": { "additionalProperties": {}, "type": "object" }, "imageUrl": { "nullable": true, "type": "string" }, "isDefault": { "nullable": true, "type": "boolean" }, "name": { "nullable": true, "type": "string" }, "position": { "nullable": true, "type": "integer" }, "quantity": { "nullable": true, "type": "integer" }, "type": { "nullable": true, "type": "string" }, "value": { "nullable": true, "type": "string" }, "weight": { "nullable": true, "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "extra": { "additionalProperties": {}, "type": "object" }, "imageUrl": { "nullable": true, "type": "string" }, "isDefault": { "nullable": true, "type": "boolean" }, "name": { "nullable": true, "type": "string" }, "position": { "nullable": true, "type": "integer" }, "quantity": { "nullable": true, "type": "integer" }, "type": { "nullable": true, "type": "string" }, "value": { "nullable": true, "type": "string" }, "weight": { "nullable": true, "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin Apps Appkey Lottery Prizes Id", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/notices": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/apps/{appkey}/notices`.", "operationId": "delete__api__admin__apps___by_appkey__notices", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Apps Appkey Notices", "tags": [ "Admin" ] }, "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/notices`.", "operationId": "get__api__admin__apps___by_appkey__notices", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "type", "schema": { "type": "string" } }, { "in": "query", "name": "level", "schema": { "type": "string" } }, { "in": "query", "name": "keyword", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Notices", "tags": [ "Admin" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/notices`.", "operationId": "post__api__admin__apps___by_appkey__notices", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "content": { "nullable": true, "type": "string" }, "endTime": { "format": "date-time", "nullable": true, "type": "string" }, "level": { "nullable": true, "type": "string" }, "pinned": { "nullable": true, "type": "boolean" }, "startTime": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "nullable": true, "type": "string" }, "title": { "nullable": true, "type": "string" }, "type": { "nullable": true, "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "content": { "nullable": true, "type": "string" }, "endTime": { "format": "date-time", "nullable": true, "type": "string" }, "level": { "nullable": true, "type": "string" }, "pinned": { "nullable": true, "type": "boolean" }, "startTime": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "nullable": true, "type": "string" }, "title": { "nullable": true, "type": "string" }, "type": { "nullable": true, "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Notices", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/notices/export": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/notices/export`.", "operationId": "get__api__admin__apps___by_appkey__notices__export", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Notices Export", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/notices/{noticeId}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/apps/{appkey}/notices/{noticeId}`.", "operationId": "delete__api__admin__apps___by_appkey__notices___by_noticeId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "noticeId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Apps Appkey Notices NoticeId", "tags": [ "Admin" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/apps/{appkey}/notices/{noticeId}`.", "operationId": "put__api__admin__apps___by_appkey__notices___by_noticeId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "noticeId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "content": { "nullable": true, "type": "string" }, "endTime": { "format": "date-time", "nullable": true, "type": "string" }, "level": { "nullable": true, "type": "string" }, "pinned": { "nullable": true, "type": "boolean" }, "startTime": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "nullable": true, "type": "string" }, "title": { "nullable": true, "type": "string" }, "type": { "nullable": true, "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "content": { "nullable": true, "type": "string" }, "endTime": { "format": "date-time", "nullable": true, "type": "string" }, "level": { "nullable": true, "type": "string" }, "pinned": { "nullable": true, "type": "boolean" }, "startTime": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "nullable": true, "type": "string" }, "title": { "nullable": true, "type": "string" }, "type": { "nullable": true, "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin Apps Appkey Notices NoticeId", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/notifications": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/apps/{appkey}/notifications`.", "operationId": "delete__api__admin__apps___by_appkey__notifications", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Apps Appkey Notifications", "tags": [ "Admin" ] }, "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/notifications`.", "operationId": "get__api__admin__apps___by_appkey__notifications", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "appid", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "keyword", "schema": { "type": "string" } }, { "in": "query", "name": "type", "schema": { "type": "string" } }, { "in": "query", "name": "level", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Notifications", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/notifications/bulk": { "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/notifications/bulk`.", "operationId": "post__api__admin__apps___by_appkey__notifications__bulk", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "content": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "keyword": { "type": "string" }, "level": { "type": "string" }, "limit": { "type": "integer" }, "metadata": { "additionalProperties": {}, "type": "object" }, "title": { "type": "string" }, "type": { "type": "string" }, "userIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "content": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "keyword": { "type": "string" }, "level": { "type": "string" }, "limit": { "type": "integer" }, "metadata": { "additionalProperties": {}, "type": "object" }, "title": { "type": "string" }, "type": { "type": "string" }, "userIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Notifications Bulk", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/notifications/delete-by-filter": { "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/notifications/delete-by-filter`.", "operationId": "post__api__admin__apps___by_appkey__notifications__delete_dash_by_dash_filter", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "keyword": { "type": "string" }, "level": { "type": "string" }, "limit": { "type": "integer" }, "type": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "keyword": { "type": "string" }, "level": { "type": "string" }, "limit": { "type": "integer" }, "type": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Notifications Delete By Filter", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/notifications/export": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/notifications/export`.", "operationId": "get__api__admin__apps___by_appkey__notifications__export", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "appid", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "keyword", "schema": { "type": "string" } }, { "in": "query", "name": "type", "schema": { "type": "string" } }, { "in": "query", "name": "level", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Notifications Export", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/oauth-bindings": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/apps/{appkey}/oauth-bindings`.", "operationId": "delete__api__admin__apps___by_appkey__oauth_dash_bindings", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "force": { "type": "boolean" }, "provider": { "type": "string" }, "userId": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "force": { "type": "boolean" }, "provider": { "type": "string" }, "userId": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Apps Appkey Oauth Bindings", "tags": [ "Admin" ] }, "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/oauth-bindings`.", "operationId": "get__api__admin__apps___by_appkey__oauth_dash_bindings", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "provider", "schema": { "type": "string" } }, { "in": "query", "name": "userId", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "keyword", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "pageSize", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Oauth Bindings", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/oauth-providers": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/oauth-providers`.", "operationId": "get__api__admin__apps___by_appkey__oauth_dash_providers", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Oauth Providers", "tags": [ "Admin" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/oauth-providers`.", "operationId": "post__api__admin__apps___by_appkey__oauth_dash_providers", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "allowBind": { "nullable": true, "type": "boolean" }, "allowLogin": { "nullable": true, "type": "boolean" }, "allowRegister": { "nullable": true, "type": "boolean" }, "authUrl": { "type": "string" }, "clearClientSecret": { "type": "boolean" }, "clientId": { "type": "string" }, "clientSecret": { "type": "string" }, "color": { "type": "string" }, "displayName": { "type": "string" }, "enabled": { "type": "boolean" }, "extraAuthParams": { "additionalProperties": { "type": "string" }, "type": "object" }, "icon": { "type": "string" }, "kind": { "type": "string" }, "profileMapping": { "additionalProperties": { "type": "string" }, "type": "object" }, "provider": { "type": "string" }, "redirectUrl": { "type": "string" }, "remark": { "type": "string" }, "scopes": { "items": { "type": "string" }, "type": "array" }, "sortOrder": { "nullable": true, "type": "integer" }, "tokenAuthStyle": { "type": "string" }, "tokenUrl": { "type": "string" }, "userInfoAuthStyle": { "type": "string" }, "userInfoUrl": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "allowBind": { "nullable": true, "type": "boolean" }, "allowLogin": { "nullable": true, "type": "boolean" }, "allowRegister": { "nullable": true, "type": "boolean" }, "authUrl": { "type": "string" }, "clearClientSecret": { "type": "boolean" }, "clientId": { "type": "string" }, "clientSecret": { "type": "string" }, "color": { "type": "string" }, "displayName": { "type": "string" }, "enabled": { "type": "boolean" }, "extraAuthParams": { "additionalProperties": { "type": "string" }, "type": "object" }, "icon": { "type": "string" }, "kind": { "type": "string" }, "profileMapping": { "additionalProperties": { "type": "string" }, "type": "object" }, "provider": { "type": "string" }, "redirectUrl": { "type": "string" }, "remark": { "type": "string" }, "scopes": { "items": { "type": "string" }, "type": "array" }, "sortOrder": { "nullable": true, "type": "integer" }, "tokenAuthStyle": { "type": "string" }, "tokenUrl": { "type": "string" }, "userInfoAuthStyle": { "type": "string" }, "userInfoUrl": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Oauth Providers", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/oauth-providers/reorder": { "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/oauth-providers/reorder`.", "operationId": "post__api__admin__apps___by_appkey__oauth_dash_providers__reorder", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "providers": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "providers": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Oauth Providers Reorder", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/oauth-providers/{provider}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/apps/{appkey}/oauth-providers/{provider}`.", "operationId": "delete__api__admin__apps___by_appkey__oauth_dash_providers___by_provider", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "provider", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Apps Appkey Oauth Providers Provider", "tags": [ "Admin" ] }, "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/oauth-providers/{provider}`.", "operationId": "get__api__admin__apps___by_appkey__oauth_dash_providers___by_provider", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "provider", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Oauth Providers Provider", "tags": [ "Admin" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/apps/{appkey}/oauth-providers/{provider}`.", "operationId": "put__api__admin__apps___by_appkey__oauth_dash_providers___by_provider", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "provider", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "allowBind": { "nullable": true, "type": "boolean" }, "allowLogin": { "nullable": true, "type": "boolean" }, "allowRegister": { "nullable": true, "type": "boolean" }, "authUrl": { "type": "string" }, "clearClientSecret": { "type": "boolean" }, "clientId": { "type": "string" }, "clientSecret": { "type": "string" }, "color": { "type": "string" }, "displayName": { "type": "string" }, "enabled": { "type": "boolean" }, "extraAuthParams": { "additionalProperties": { "type": "string" }, "type": "object" }, "icon": { "type": "string" }, "kind": { "type": "string" }, "profileMapping": { "additionalProperties": { "type": "string" }, "type": "object" }, "provider": { "type": "string" }, "redirectUrl": { "type": "string" }, "remark": { "type": "string" }, "scopes": { "items": { "type": "string" }, "type": "array" }, "sortOrder": { "nullable": true, "type": "integer" }, "tokenAuthStyle": { "type": "string" }, "tokenUrl": { "type": "string" }, "userInfoAuthStyle": { "type": "string" }, "userInfoUrl": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "allowBind": { "nullable": true, "type": "boolean" }, "allowLogin": { "nullable": true, "type": "boolean" }, "allowRegister": { "nullable": true, "type": "boolean" }, "authUrl": { "type": "string" }, "clearClientSecret": { "type": "boolean" }, "clientId": { "type": "string" }, "clientSecret": { "type": "string" }, "color": { "type": "string" }, "displayName": { "type": "string" }, "enabled": { "type": "boolean" }, "extraAuthParams": { "additionalProperties": { "type": "string" }, "type": "object" }, "icon": { "type": "string" }, "kind": { "type": "string" }, "profileMapping": { "additionalProperties": { "type": "string" }, "type": "object" }, "provider": { "type": "string" }, "redirectUrl": { "type": "string" }, "remark": { "type": "string" }, "scopes": { "items": { "type": "string" }, "type": "array" }, "sortOrder": { "nullable": true, "type": "integer" }, "tokenAuthStyle": { "type": "string" }, "tokenUrl": { "type": "string" }, "userInfoAuthStyle": { "type": "string" }, "userInfoUrl": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin Apps Appkey Oauth Providers Provider", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/oauth-providers/{provider}/enabled": { "put": { "description": "Auto-generated reference for `PUT /api/admin/apps/{appkey}/oauth-providers/{provider}/enabled`.", "operationId": "put__api__admin__apps___by_appkey__oauth_dash_providers___by_provider__enabled", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "provider", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "enabled": { "type": "boolean" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "enabled": { "type": "boolean" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin Apps Appkey Oauth Providers Provider Enabled", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/oauth-providers/{provider}/test": { "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/oauth-providers/{provider}/test`.", "operationId": "post__api__admin__apps___by_appkey__oauth_dash_providers___by_provider__test", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "provider", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Oauth Providers Provider Test", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/password-policy": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/password-policy`.", "operationId": "get__api__admin__apps___by_appkey__password_dash_policy", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Password Policy", "tags": [ "Admin" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/apps/{appkey}/password-policy`.", "operationId": "put__api__admin__apps___by_appkey__password_dash_policy", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "policy": { "properties": { "description": { "type": "string" }, "isDefault": { "type": "boolean" }, "maxAge": { "type": "integer" }, "maxLength": { "type": "integer" }, "minLength": { "type": "integer" }, "minScore": { "type": "integer" }, "name": { "type": "string" }, "preventReuse": { "type": "integer" }, "requireLowercase": { "type": "boolean" }, "requireNumbers": { "type": "boolean" }, "requireSpecialChars": { "type": "boolean" }, "requireUppercase": { "type": "boolean" } }, "type": "object" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "policy": { "properties": { "description": { "type": "string" }, "isDefault": { "type": "boolean" }, "maxAge": { "type": "integer" }, "maxLength": { "type": "integer" }, "minLength": { "type": "integer" }, "minScore": { "type": "integer" }, "name": { "type": "string" }, "preventReuse": { "type": "integer" }, "requireLowercase": { "type": "boolean" }, "requireNumbers": { "type": "boolean" }, "requireSpecialChars": { "type": "boolean" }, "requireUppercase": { "type": "boolean" } }, "type": "object" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin Apps Appkey Password Policy", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/password-policy/reset": { "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/password-policy/reset`.", "operationId": "post__api__admin__apps___by_appkey__password_dash_policy__reset", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Password Policy Reset", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/password-policy/test": { "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/password-policy/test`.", "operationId": "post__api__admin__apps___by_appkey__password_dash_policy__test", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "password": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "password": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Password Policy Test", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/policy": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/policy`.", "operationId": "get__api__admin__apps___by_appkey__policy", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Policy", "tags": [ "Admin" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/apps/{appkey}/policy`.", "operationId": "put__api__admin__apps___by_appkey__policy", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "loginCheckDevice": { "type": "boolean" }, "loginCheckDeviceTimeOut": { "type": "integer" }, "loginCheckIp": { "type": "boolean" }, "loginCheckUser": { "type": "boolean" }, "multiDeviceLimit": { "type": "integer" }, "multiDeviceLogin": { "type": "boolean" }, "registerCheckIp": { "type": "boolean" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "loginCheckDevice": { "type": "boolean" }, "loginCheckDeviceTimeOut": { "type": "integer" }, "loginCheckIp": { "type": "boolean" }, "loginCheckUser": { "type": "boolean" }, "multiDeviceLimit": { "type": "integer" }, "multiDeviceLogin": { "type": "boolean" }, "registerCheckIp": { "type": "boolean" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin Apps Appkey Policy", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/reports/active": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/reports/active`.", "operationId": "get__api__admin__apps___by_appkey__reports__active", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "start", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "end", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "granularity", "schema": { "type": "string" } }, { "in": "query", "name": "activityId", "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Reports Active", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/reports/activity": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/reports/activity`.", "operationId": "get__api__admin__apps___by_appkey__reports__activity", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "start", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "end", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "granularity", "schema": { "type": "string" } }, { "in": "query", "name": "activityId", "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Reports Activity", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/reports/channel": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/reports/channel`.", "operationId": "get__api__admin__apps___by_appkey__reports__channel", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "start", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "end", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "granularity", "schema": { "type": "string" } }, { "in": "query", "name": "activityId", "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Reports Channel", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/reports/device": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/reports/device`.", "operationId": "get__api__admin__apps___by_appkey__reports__device", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "start", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "end", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "granularity", "schema": { "type": "string" } }, { "in": "query", "name": "activityId", "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Reports Device", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/reports/export": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/reports/export`.", "operationId": "get__api__admin__apps___by_appkey__reports__export", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "type", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "start", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "end", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "format", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Reports Export", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/reports/funnel": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/reports/funnel`.", "operationId": "get__api__admin__apps___by_appkey__reports__funnel", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "start", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "end", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "granularity", "schema": { "type": "string" } }, { "in": "query", "name": "activityId", "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Reports Funnel", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/reports/login": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/reports/login`.", "operationId": "get__api__admin__apps___by_appkey__reports__login", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "start", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "end", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "granularity", "schema": { "type": "string" } }, { "in": "query", "name": "activityId", "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Reports Login", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/reports/notification": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/reports/notification`.", "operationId": "get__api__admin__apps___by_appkey__reports__notification", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "start", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "end", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "granularity", "schema": { "type": "string" } }, { "in": "query", "name": "activityId", "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Reports Notification", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/reports/payment": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/reports/payment`.", "operationId": "get__api__admin__apps___by_appkey__reports__payment", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "start", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "end", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "granularity", "schema": { "type": "string" } }, { "in": "query", "name": "activityId", "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Reports Payment", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/reports/region": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/reports/region`.", "operationId": "get__api__admin__apps___by_appkey__reports__region", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "start", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "end", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "granularity", "schema": { "type": "string" } }, { "in": "query", "name": "activityId", "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Reports Region", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/reports/registration": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/reports/registration`.", "operationId": "get__api__admin__apps___by_appkey__reports__registration", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "start", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "end", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "granularity", "schema": { "type": "string" } }, { "in": "query", "name": "activityId", "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Reports Registration", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/reports/retention": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/reports/retention`.", "operationId": "get__api__admin__apps___by_appkey__reports__retention", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "start", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "end", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "granularity", "schema": { "type": "string" } }, { "in": "query", "name": "activityId", "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Reports Retention", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/reports/risk": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/reports/risk`.", "operationId": "get__api__admin__apps___by_appkey__reports__risk", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "start", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "end", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "granularity", "schema": { "type": "string" } }, { "in": "query", "name": "activityId", "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Reports Risk", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/signin-reward": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/signin-reward`.", "operationId": "get__api__admin__apps___by_appkey__signin_dash_reward", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Signin Reward", "tags": [ "Admin" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/apps/{appkey}/signin-reward`.", "operationId": "put__api__admin__apps___by_appkey__signin_dash_reward", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "policy": { "properties": { "applyLevelExperienceMultiplier": { "type": "boolean" }, "baseExperience": { "format": "int64", "type": "integer" }, "baseIntegral": { "format": "int64", "type": "integer" }, "consecutiveExperienceStep": { "format": "int64", "type": "integer" }, "consecutiveExperienceStepCap": { "format": "int64", "type": "integer" }, "description": { "type": "string" }, "enabled": { "type": "boolean" }, "firstSignInExperienceBonus": { "format": "int64", "type": "integer" }, "isDefault": { "type": "boolean" }, "maxExperienceReward": { "format": "int64", "type": "integer" }, "maxIntegralReward": { "format": "int64", "type": "integer" }, "milestones": { "items": { "properties": { "bonusType": { "type": "string" }, "consecutiveDays": { "format": "int64", "type": "integer" }, "description": { "type": "string" }, "experienceBonus": { "format": "int64", "type": "integer" }, "integralBonus": { "format": "int64", "type": "integer" } }, "type": "object" }, "type": "array" }, "name": { "type": "string" }, "rules": { "items": { "properties": { "bonusDescription": { "type": "string" }, "bonusType": { "type": "string" }, "description": { "type": "string" }, "enabled": { "type": "boolean" }, "experienceBonus": { "format": "int64", "type": "integer" }, "experienceMultiplierDelta": { "format": "double", "type": "number" }, "expression": { "type": "string" }, "group": { "type": "string" }, "integralBonus": { "format": "int64", "type": "integer" }, "integralMultiplierDelta": { "format": "double", "type": "number" }, "key": { "type": "string" }, "name": { "type": "string" }, "priority": { "type": "integer" } }, "type": "object" }, "type": "array" }, "timezone": { "type": "string" } }, "type": "object" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "policy": { "properties": { "applyLevelExperienceMultiplier": { "type": "boolean" }, "baseExperience": { "format": "int64", "type": "integer" }, "baseIntegral": { "format": "int64", "type": "integer" }, "consecutiveExperienceStep": { "format": "int64", "type": "integer" }, "consecutiveExperienceStepCap": { "format": "int64", "type": "integer" }, "description": { "type": "string" }, "enabled": { "type": "boolean" }, "firstSignInExperienceBonus": { "format": "int64", "type": "integer" }, "isDefault": { "type": "boolean" }, "maxExperienceReward": { "format": "int64", "type": "integer" }, "maxIntegralReward": { "format": "int64", "type": "integer" }, "milestones": { "items": { "properties": { "bonusType": { "type": "string" }, "consecutiveDays": { "format": "int64", "type": "integer" }, "description": { "type": "string" }, "experienceBonus": { "format": "int64", "type": "integer" }, "integralBonus": { "format": "int64", "type": "integer" } }, "type": "object" }, "type": "array" }, "name": { "type": "string" }, "rules": { "items": { "properties": { "bonusDescription": { "type": "string" }, "bonusType": { "type": "string" }, "description": { "type": "string" }, "enabled": { "type": "boolean" }, "experienceBonus": { "format": "int64", "type": "integer" }, "experienceMultiplierDelta": { "format": "double", "type": "number" }, "expression": { "type": "string" }, "group": { "type": "string" }, "integralBonus": { "format": "int64", "type": "integer" }, "integralMultiplierDelta": { "format": "double", "type": "number" }, "key": { "type": "string" }, "name": { "type": "string" }, "priority": { "type": "integer" } }, "type": "object" }, "type": "array" }, "timezone": { "type": "string" } }, "type": "object" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin Apps Appkey Signin Reward", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/signin-reward/reset": { "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/signin-reward/reset`.", "operationId": "post__api__admin__apps___by_appkey__signin_dash_reward__reset", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Signin Reward Reset", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/signin-reward/test": { "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/signin-reward/test`.", "operationId": "post__api__admin__apps___by_appkey__signin_dash_reward__test", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "consecutiveDays": { "type": "integer" }, "occurredAt": { "format": "date-time", "nullable": true, "type": "string" }, "totalSignIns": { "format": "int64", "type": "integer" }, "userExperience": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "consecutiveDays": { "type": "integer" }, "occurredAt": { "format": "date-time", "nullable": true, "type": "string" }, "totalSignIns": { "format": "int64", "type": "integer" }, "userExperience": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Signin Reward Test", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/signin/records": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/signin/records`.", "operationId": "get__api__admin__apps___by_appkey__signin__records", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "keyword", "schema": { "type": "string" } }, { "in": "query", "name": "source", "schema": { "type": "string" } }, { "in": "query", "name": "dateFrom", "schema": { "type": "string" } }, { "in": "query", "name": "dateTo", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Signin Records", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/signin/stats": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/signin/stats`.", "operationId": "get__api__admin__apps___by_appkey__signin__stats", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "days", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Signin Stats", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/stats": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/stats`.", "operationId": "get__api__admin__apps___by_appkey__stats", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Stats", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/stats/auth-sources": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/stats/auth-sources`.", "operationId": "get__api__admin__apps___by_appkey__stats__auth_dash_sources", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Stats Auth Sources", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/stats/regions": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/stats/regions`.", "operationId": "get__api__admin__apps___by_appkey__stats__regions", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "type", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Stats Regions", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/stats/user-trend": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/stats/user-trend`.", "operationId": "get__api__admin__apps___by_appkey__stats__user_dash_trend", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "days", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Stats User Trend", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/users": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/users`.", "operationId": "get__api__admin__apps___by_appkey__users", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "appid", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "keyword", "schema": { "type": "string" } }, { "in": "query", "name": "account", "schema": { "type": "string" } }, { "in": "query", "name": "nickname", "schema": { "type": "string" } }, { "in": "query", "name": "email", "schema": { "type": "string" } }, { "in": "query", "name": "phone", "schema": { "type": "string" } }, { "in": "query", "name": "inviteCode", "schema": { "type": "string" } }, { "in": "query", "name": "registerIp", "schema": { "type": "string" } }, { "in": "query", "name": "userId", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "enabled", "schema": { "type": "boolean" } }, { "in": "query", "name": "createdFrom", "schema": { "type": "string" } }, { "in": "query", "name": "createdTo", "schema": { "type": "string" } }, { "in": "query", "name": "sort", "schema": { "type": "string" } }, { "in": "query", "name": "order", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Users", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/users/bans/batch": { "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/users/bans/batch`.", "operationId": "post__api__admin__apps___by_appkey__users__bans__batch", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "banScope": { "type": "string" }, "banType": { "type": "string" }, "endAt": { "format": "date-time", "nullable": true, "type": "string" }, "evidence": { "additionalProperties": {}, "type": "object" }, "reason": { "type": "string" }, "startAt": { "format": "date-time", "nullable": true, "type": "string" }, "userIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "banScope": { "type": "string" }, "banType": { "type": "string" }, "endAt": { "format": "date-time", "nullable": true, "type": "string" }, "evidence": { "additionalProperties": {}, "type": "object" }, "reason": { "type": "string" }, "startAt": { "format": "date-time", "nullable": true, "type": "string" }, "userIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Users Bans Batch", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/users/export": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/users/export`.", "operationId": "get__api__admin__apps___by_appkey__users__export", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "appid", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "keyword", "schema": { "type": "string" } }, { "in": "query", "name": "account", "schema": { "type": "string" } }, { "in": "query", "name": "nickname", "schema": { "type": "string" } }, { "in": "query", "name": "email", "schema": { "type": "string" } }, { "in": "query", "name": "phone", "schema": { "type": "string" } }, { "in": "query", "name": "inviteCode", "schema": { "type": "string" } }, { "in": "query", "name": "registerIp", "schema": { "type": "string" } }, { "in": "query", "name": "userId", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "enabled", "schema": { "type": "boolean" } }, { "in": "query", "name": "createdFrom", "schema": { "type": "string" } }, { "in": "query", "name": "createdTo", "schema": { "type": "string" } }, { "in": "query", "name": "sort", "schema": { "type": "string" } }, { "in": "query", "name": "order", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Users Export", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/users/status/batch": { "put": { "description": "Auto-generated reference for `PUT /api/admin/apps/{appkey}/users/status/batch`.", "operationId": "put__api__admin__apps___by_appkey__users__status__batch", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "clearDisabledEndTime": { "type": "boolean" }, "disabledEndTime": { "format": "date-time", "nullable": true, "type": "string" }, "disabledReason": { "nullable": true, "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "userIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "clearDisabledEndTime": { "type": "boolean" }, "disabledEndTime": { "format": "date-time", "nullable": true, "type": "string" }, "disabledReason": { "nullable": true, "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "userIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin Apps Appkey Users Status Batch", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/users/{userId}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/apps/{appkey}/users/{userId}`.", "operationId": "delete__api__admin__apps___by_appkey__users___by_userId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Apps Appkey Users UserId", "tags": [ "Admin" ] }, "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/users/{userId}`.", "operationId": "get__api__admin__apps___by_appkey__users___by_userId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Users UserId", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/users/{userId}/audits/login": { "get": { "description": "Lists login audit records for a single application user.", "operationId": "get__api__admin__apps___by_appkey__users___by_userId__audits__login", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "List User Login Audits", "tags": [ "Admin Users" ] } }, "/api/admin/apps/{appkey}/users/{userId}/audits/sessions": { "get": { "description": "Lists session event audit records for a single application user.", "operationId": "get__api__admin__apps___by_appkey__users___by_userId__audits__sessions", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "eventType", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "List User Session Audits", "tags": [ "Admin Users" ] } }, "/api/admin/apps/{appkey}/users/{userId}/bans": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/users/{userId}/bans`.", "operationId": "get__api__admin__apps___by_appkey__users___by_userId__bans", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Users UserId Bans", "tags": [ "Admin" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/users/{userId}/bans`.", "operationId": "post__api__admin__apps___by_appkey__users___by_userId__bans", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "banScope": { "type": "string" }, "banType": { "type": "string" }, "endAt": { "format": "date-time", "nullable": true, "type": "string" }, "evidence": { "additionalProperties": {}, "type": "object" }, "reason": { "type": "string" }, "startAt": { "format": "date-time", "nullable": true, "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "banScope": { "type": "string" }, "banType": { "type": "string" }, "endAt": { "format": "date-time", "nullable": true, "type": "string" }, "evidence": { "additionalProperties": {}, "type": "object" }, "reason": { "type": "string" }, "startAt": { "format": "date-time", "nullable": true, "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Users UserId Bans", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/users/{userId}/bans/active": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/users/{userId}/bans/active`.", "operationId": "get__api__admin__apps___by_appkey__users___by_userId__bans__active", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Users UserId Bans Active", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/users/{userId}/bans/{banId}/revoke": { "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/users/{userId}/bans/{banId}/revoke`.", "operationId": "post__api__admin__apps___by_appkey__users___by_userId__bans___by_banId__revoke", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "banId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "reason": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "reason": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Users UserId Bans BanId Revoke", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/users/{userId}/profile": { "put": { "description": "Auto-generated reference for `PUT /api/admin/apps/{appkey}/users/{userId}/profile`.", "operationId": "put__api__admin__apps___by_appkey__users___by_userId__profile", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "email": { "type": "string" }, "nickname": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "email": { "type": "string" }, "nickname": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin Apps Appkey Users UserId Profile", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/users/{userId}/reset-password": { "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/users/{userId}/reset-password`.", "operationId": "post__api__admin__apps___by_appkey__users___by_userId__reset_dash_password", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "newPassword": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "newPassword": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Users UserId Reset Password", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/users/{userId}/revoke-sessions": { "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/users/{userId}/revoke-sessions`.", "operationId": "post__api__admin__apps___by_appkey__users___by_userId__revoke_dash_sessions", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Users UserId Revoke Sessions", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/users/{userId}/sessions": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/users/{userId}/sessions`.", "operationId": "get__api__admin__apps___by_appkey__users___by_userId__sessions", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Users UserId Sessions", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/users/{userId}/sessions/revoke-batch": { "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/users/{userId}/sessions/revoke-batch`.", "operationId": "post__api__admin__apps___by_appkey__users___by_userId__sessions__revoke_dash_batch", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "tokenHashes": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "tokenHashes": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Users UserId Sessions Revoke Batch", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/users/{userId}/sessions/{tokenHash}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/apps/{appkey}/users/{userId}/sessions/{tokenHash}`.", "operationId": "delete__api__admin__apps___by_appkey__users___by_userId__sessions___by_tokenHash", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "tokenHash", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Apps Appkey Users UserId Sessions TokenHash", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/users/{userId}/status": { "put": { "description": "Auto-generated reference for `PUT /api/admin/apps/{appkey}/users/{userId}/status`.", "operationId": "put__api__admin__apps___by_appkey__users___by_userId__status", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "clearDisabledEndTime": { "type": "boolean" }, "disabledEndTime": { "format": "date-time", "nullable": true, "type": "string" }, "disabledReason": { "nullable": true, "type": "string" }, "enabled": { "nullable": true, "type": "boolean" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "clearDisabledEndTime": { "type": "boolean" }, "disabledEndTime": { "format": "date-time", "nullable": true, "type": "string" }, "disabledReason": { "nullable": true, "type": "string" }, "enabled": { "nullable": true, "type": "boolean" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin Apps Appkey Users UserId Status", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/users/{userId}/wallet": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/users/{userId}/wallet`.", "operationId": "get__api__admin__apps___by_appkey__users___by_userId__wallet", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Users UserId Wallet", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/users/{userId}/wallet/transactions": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/users/{userId}/wallet/transactions`.", "operationId": "get__api__admin__apps___by_appkey__users___by_userId__wallet__transactions", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "type", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Users UserId Wallet Transactions", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/versions": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/versions`.", "operationId": "get__api__admin__apps___by_appkey__versions", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Versions", "tags": [ "Admin" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/versions`.", "operationId": "post__api__admin__apps___by_appkey__versions", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "channel_id": { "format": "int64", "nullable": true, "type": "integer" }, "description": { "type": "string" }, "download_url": { "type": "string" }, "file_hash": { "type": "string" }, "file_size": { "format": "int64", "type": "integer" }, "force_update": { "nullable": true, "type": "boolean" }, "metadata": { "additionalProperties": {}, "type": "object" }, "min_os_version": { "type": "string" }, "platform": { "type": "string" }, "release_notes": { "type": "string" }, "status": { "type": "string" }, "update_type": { "type": "string" }, "version": { "type": "string" }, "version_code": { "format": "int64", "type": "integer" }, "version_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "channel_id": { "format": "int64", "nullable": true, "type": "integer" }, "description": { "type": "string" }, "download_url": { "type": "string" }, "file_hash": { "type": "string" }, "file_size": { "format": "int64", "type": "integer" }, "force_update": { "nullable": true, "type": "boolean" }, "metadata": { "additionalProperties": {}, "type": "object" }, "min_os_version": { "type": "string" }, "platform": { "type": "string" }, "release_notes": { "type": "string" }, "status": { "type": "string" }, "update_type": { "type": "string" }, "version": { "type": "string" }, "version_code": { "format": "int64", "type": "integer" }, "version_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Versions", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/versions/stats": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/versions/stats`.", "operationId": "get__api__admin__apps___by_appkey__versions__stats", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Versions Stats", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/versions/{vid}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/apps/{appkey}/versions/{vid}`.", "operationId": "delete__api__admin__apps___by_appkey__versions___by_vid", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "vid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Apps Appkey Versions Vid", "tags": [ "Admin" ] }, "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/versions/{vid}`.", "operationId": "get__api__admin__apps___by_appkey__versions___by_vid", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "vid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Versions Vid", "tags": [ "Admin" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/apps/{appkey}/versions/{vid}`.", "operationId": "put__api__admin__apps___by_appkey__versions___by_vid", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "vid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "channel_id": { "format": "int64", "nullable": true, "type": "integer" }, "description": { "type": "string" }, "download_url": { "type": "string" }, "file_hash": { "type": "string" }, "file_size": { "format": "int64", "type": "integer" }, "force_update": { "nullable": true, "type": "boolean" }, "metadata": { "additionalProperties": {}, "type": "object" }, "min_os_version": { "type": "string" }, "platform": { "type": "string" }, "release_notes": { "type": "string" }, "status": { "type": "string" }, "update_type": { "type": "string" }, "version": { "type": "string" }, "version_code": { "format": "int64", "type": "integer" }, "version_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "channel_id": { "format": "int64", "nullable": true, "type": "integer" }, "description": { "type": "string" }, "download_url": { "type": "string" }, "file_hash": { "type": "string" }, "file_size": { "format": "int64", "type": "integer" }, "force_update": { "nullable": true, "type": "boolean" }, "metadata": { "additionalProperties": {}, "type": "object" }, "min_os_version": { "type": "string" }, "platform": { "type": "string" }, "release_notes": { "type": "string" }, "status": { "type": "string" }, "update_type": { "type": "string" }, "version": { "type": "string" }, "version_code": { "format": "int64", "type": "integer" }, "version_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin Apps Appkey Versions Vid", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/versions/{vid}/publish": { "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/versions/{vid}/publish`.", "operationId": "post__api__admin__apps___by_appkey__versions___by_vid__publish", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "vid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Versions Vid Publish", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/versions/{vid}/revoke": { "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/versions/{vid}/revoke`.", "operationId": "post__api__admin__apps___by_appkey__versions___by_vid__revoke", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "vid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Versions Vid Revoke", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/vip/entitlement": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/vip/entitlement`.", "operationId": "get__api__admin__apps___by_appkey__vip__entitlement", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Vip Entitlement", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/vip/features": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/vip/features`.", "operationId": "get__api__admin__apps___by_appkey__vip__features", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Vip Features", "tags": [ "Admin" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/vip/features`.", "operationId": "post__api__admin__apps___by_appkey__vip__features", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "description": { "nullable": true, "type": "string" }, "isActive": { "nullable": true, "type": "boolean" }, "name": { "nullable": true, "type": "string" }, "sortOrder": { "nullable": true, "type": "integer" }, "tag": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "description": { "nullable": true, "type": "string" }, "isActive": { "nullable": true, "type": "boolean" }, "name": { "nullable": true, "type": "string" }, "sortOrder": { "nullable": true, "type": "integer" }, "tag": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Vip Features", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/vip/features/{tag}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/apps/{appkey}/vip/features/{tag}`.", "operationId": "delete__api__admin__apps___by_appkey__vip__features___by_tag", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "tag", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Apps Appkey Vip Features Tag", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/vip/grant": { "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/vip/grant`.", "operationId": "post__api__admin__apps___by_appkey__vip__grant", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "bonusIntegral": { "format": "int64", "type": "integer" }, "days": { "type": "integer" }, "reason": { "type": "string" }, "userId": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "bonusIntegral": { "format": "int64", "type": "integer" }, "days": { "type": "integer" }, "reason": { "type": "string" }, "userId": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Vip Grant", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/vip/plans": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/vip/plans`.", "operationId": "get__api__admin__apps___by_appkey__vip__plans", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Vip Plans", "tags": [ "Admin" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/vip/plans`.", "operationId": "post__api__admin__apps___by_appkey__vip__plans", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "bonusIntegral": { "format": "int64", "nullable": true, "type": "integer" }, "description": { "nullable": true, "type": "string" }, "durationDays": { "nullable": true, "type": "integer" }, "features": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "id": { "format": "int64", "type": "integer" }, "isActive": { "nullable": true, "type": "boolean" }, "kind": { "nullable": true, "type": "string" }, "name": { "nullable": true, "type": "string" }, "originalPrice": { "nullable": true, "type": "string" }, "price": { "nullable": true, "type": "string" }, "sortOrder": { "nullable": true, "type": "integer" }, "trialDeviceLimited": { "nullable": true, "type": "boolean" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "bonusIntegral": { "format": "int64", "nullable": true, "type": "integer" }, "description": { "nullable": true, "type": "string" }, "durationDays": { "nullable": true, "type": "integer" }, "features": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "id": { "format": "int64", "type": "integer" }, "isActive": { "nullable": true, "type": "boolean" }, "kind": { "nullable": true, "type": "string" }, "name": { "nullable": true, "type": "string" }, "originalPrice": { "nullable": true, "type": "string" }, "price": { "nullable": true, "type": "string" }, "sortOrder": { "nullable": true, "type": "integer" }, "trialDeviceLimited": { "nullable": true, "type": "boolean" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Vip Plans", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/vip/plans/{planId}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/apps/{appkey}/vip/plans/{planId}`.", "operationId": "delete__api__admin__apps___by_appkey__vip__plans___by_planId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "planId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Apps Appkey Vip Plans PlanId", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/vip/transactions": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/vip/transactions`.", "operationId": "get__api__admin__apps___by_appkey__vip__transactions", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Vip Transactions", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/vip/trial/claims": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/vip/trial/claims`.", "operationId": "get__api__admin__apps___by_appkey__vip__trial__claims", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Vip Trial Claims", "tags": [ "Admin" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/vip/trial/claims`.", "operationId": "post__api__admin__apps___by_appkey__vip__trial__claims", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "userId": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "userId": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Vip Trial Claims", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/vip/trial/claims/{userId}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/apps/{appkey}/vip/trial/claims/{userId}`.", "operationId": "delete__api__admin__apps___by_appkey__vip__trial__claims___by_userId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Apps Appkey Vip Trial Claims UserId", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/wallet/adjust": { "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/wallet/adjust`.", "operationId": "post__api__admin__apps___by_appkey__wallet__adjust", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "amount": { "type": "string" }, "reason": { "type": "string" }, "userId": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "amount": { "type": "string" }, "reason": { "type": "string" }, "userId": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Wallet Adjust", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/wallet/receipt": { "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/wallet/receipt`.", "operationId": "post__api__admin__apps___by_appkey__wallet__receipt", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "documentType": { "type": "string" }, "expireMinutes": { "type": "integer" }, "locale": { "type": "string" }, "timezone": { "type": "string" }, "transactionNo": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "documentType": { "type": "string" }, "expireMinutes": { "type": "integer" }, "locale": { "type": "string" }, "timezone": { "type": "string" }, "transactionNo": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Wallet Receipt", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/wallet/receipt/email": { "post": { "description": "Auto-generated reference for `POST /api/admin/apps/{appkey}/wallet/receipt/email`.", "operationId": "post__api__admin__apps___by_appkey__wallet__receipt__email", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "documentType": { "type": "string" }, "expireMinutes": { "type": "integer" }, "locale": { "type": "string" }, "timezone": { "type": "string" }, "to": { "type": "string" }, "transactionNo": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "documentType": { "type": "string" }, "expireMinutes": { "type": "integer" }, "locale": { "type": "string" }, "timezone": { "type": "string" }, "to": { "type": "string" }, "transactionNo": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Apps Appkey Wallet Receipt Email", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/wallet/stats": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/wallet/stats`.", "operationId": "get__api__admin__apps___by_appkey__wallet__stats", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "start", "schema": { "type": "string" } }, { "in": "query", "name": "end", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Wallet Stats", "tags": [ "Admin" ] } }, "/api/admin/apps/{appkey}/wallet/transactions": { "get": { "description": "Auto-generated reference for `GET /api/admin/apps/{appkey}/wallet/transactions`.", "operationId": "get__api__admin__apps___by_appkey__wallet__transactions", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "userId", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "type", "schema": { "type": "string" } }, { "in": "query", "name": "direction", "schema": { "type": "string" } }, { "in": "query", "name": "keyword", "schema": { "type": "string" } }, { "in": "query", "name": "start", "schema": { "type": "string" } }, { "in": "query", "name": "end", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Apps Appkey Wallet Transactions", "tags": [ "Admin" ] } }, "/api/admin/auth/ldap/config": { "get": { "description": "Auto-generated reference for `GET /api/admin/auth/ldap/config`.", "operationId": "get__api__admin__auth__ldap__config", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Auth Ldap Config", "tags": [ "Admin Auth" ] } }, "/api/admin/auth/login": { "post": { "description": "Authenticates an administrator and returns an administrator access session.", "operationId": "post__api__admin__auth__login", "requestBody": { "content": { "application/json": { "schema": { "properties": { "account": { "type": "string" }, "captchaAnswer": { "type": "string" }, "captchaId": { "type": "string" }, "password": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "account": { "type": "string" }, "captchaAnswer": { "type": "string" }, "captchaId": { "type": "string" }, "password": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "Admin Login", "tags": [ "Admin Auth" ] } }, "/api/admin/auth/logout": { "post": { "description": "Revokes the current administrator session.", "operationId": "post__api__admin__auth__logout", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "Admin Logout", "tags": [ "Admin Auth" ] } }, "/api/admin/auth/me": { "get": { "description": "Returns the active administrator session context.", "operationId": "get__api__admin__auth__me", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "Admin Session", "tags": [ "Admin Auth" ] } }, "/api/admin/auth/oidc/authorize": { "get": { "description": "Auto-generated reference for `GET /api/admin/auth/oidc/authorize`.", "operationId": "get__api__admin__auth__oidc__authorize", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Auth Oidc Authorize", "tags": [ "Admin Auth" ] } }, "/api/admin/auth/oidc/callback": { "get": { "description": "Auto-generated reference for `GET /api/admin/auth/oidc/callback`.", "operationId": "get__api__admin__auth__oidc__callback", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Auth Oidc Callback", "tags": [ "Admin Auth" ] } }, "/api/admin/auth/oidc/config": { "get": { "description": "Auto-generated reference for `GET /api/admin/auth/oidc/config`.", "operationId": "get__api__admin__auth__oidc__config", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Auth Oidc Config", "tags": [ "Admin Auth" ] } }, "/api/admin/auth/oidc/exchange": { "post": { "description": "Auto-generated reference for `POST /api/admin/auth/oidc/exchange`.", "operationId": "post__api__admin__auth__oidc__exchange", "requestBody": { "content": { "application/json": { "schema": { "properties": { "ticket": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "ticket": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Auth Oidc Exchange", "tags": [ "Admin Auth" ] } }, "/api/admin/auth/register": { "post": { "description": "Creates an administrator account and signs it in. The account is created without super-admin status and without any role assignment.", "operationId": "post__api__admin__auth__register", "requestBody": { "content": { "application/json": { "schema": { "properties": { "account": { "type": "string" }, "captchaAnswer": { "type": "string" }, "captchaId": { "type": "string" }, "displayName": { "type": "string" }, "email": { "type": "string" }, "password": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "account": { "type": "string" }, "captchaAnswer": { "type": "string" }, "captchaId": { "type": "string" }, "displayName": { "type": "string" }, "email": { "type": "string" }, "password": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "Admin Register", "tags": [ "Admin Auth" ] } }, "/api/admin/auth/saml/authorize": { "get": { "description": "Auto-generated reference for `GET /api/admin/auth/saml/authorize`.", "operationId": "get__api__admin__auth__saml__authorize", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Auth Saml Authorize", "tags": [ "Admin Auth" ] } }, "/api/admin/auth/saml/callback": { "get": { "description": "Auto-generated reference for `GET /api/admin/auth/saml/callback`.", "operationId": "get__api__admin__auth__saml__callback", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Auth Saml Callback", "tags": [ "Admin Auth" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/auth/saml/callback`.", "operationId": "post__api__admin__auth__saml__callback", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Auth Saml Callback", "tags": [ "Admin Auth" ] } }, "/api/admin/auth/saml/config": { "get": { "description": "Auto-generated reference for `GET /api/admin/auth/saml/config`.", "operationId": "get__api__admin__auth__saml__config", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Auth Saml Config", "tags": [ "Admin Auth" ] } }, "/api/admin/auth/saml/exchange": { "post": { "description": "Auto-generated reference for `POST /api/admin/auth/saml/exchange`.", "operationId": "post__api__admin__auth__saml__exchange", "requestBody": { "content": { "application/json": { "schema": { "properties": { "ticket": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "ticket": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Auth Saml Exchange", "tags": [ "Admin Auth" ] } }, "/api/admin/auth/saml/metadata": { "get": { "description": "Auto-generated reference for `GET /api/admin/auth/saml/metadata`.", "operationId": "get__api__admin__auth__saml__metadata", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Auth Saml Metadata", "tags": [ "Admin Auth" ] } }, "/api/admin/auth/self-service": { "get": { "description": "Auto-generated reference for `GET /api/admin/auth/self-service`.", "operationId": "get__api__admin__auth__self_dash_service", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Auth Self Service", "tags": [ "Admin Auth" ] } }, "/api/admin/auth/verify-mfa": { "post": { "description": "Auto-generated reference for `POST /api/admin/auth/verify-mfa`.", "operationId": "post__api__admin__auth__verify_dash_mfa", "requestBody": { "content": { "application/json": { "schema": { "properties": { "challengeId": { "type": "string" }, "code": { "type": "string" }, "recoveryCode": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "challengeId": { "type": "string" }, "code": { "type": "string" }, "recoveryCode": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Auth Verify Mfa", "tags": [ "Admin Auth" ] } }, "/api/admin/avatar": { "post": { "description": "Auto-generated reference for `POST /api/admin/avatar`.", "operationId": "post__api__admin__avatar", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Avatar", "tags": [ "Admin" ] } }, "/api/admin/avatar/upload": { "post": { "description": "Auto-generated reference for `POST /api/admin/avatar/upload`.", "operationId": "post__api__admin__avatar__upload", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Avatar Upload", "tags": [ "Admin" ] } }, "/api/admin/captcha/config": { "get": { "description": "Auto-generated reference for `GET /api/admin/captcha/config`.", "operationId": "get__api__admin__captcha__config", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Captcha Config", "tags": [ "Admin" ] } }, "/api/admin/captcha/generate": { "post": { "description": "Auto-generated reference for `POST /api/admin/captcha/generate`.", "operationId": "post__api__admin__captcha__generate", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "purpose": { "type": "string" }, "type": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "purpose": { "type": "string" }, "type": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Captcha Generate", "tags": [ "Admin" ] } }, "/api/admin/captcha/verify": { "post": { "description": "Auto-generated reference for `POST /api/admin/captcha/verify`.", "operationId": "post__api__admin__captcha__verify", "requestBody": { "content": { "application/json": { "schema": { "properties": { "answer": { "type": "string" }, "captchaId": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "answer": { "type": "string" }, "captchaId": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Captcha Verify", "tags": [ "Admin" ] } }, "/api/admin/captcha/verify-click": { "post": { "description": "Auto-generated reference for `POST /api/admin/captcha/verify-click`.", "operationId": "post__api__admin__captcha__verify_dash_click", "requestBody": { "content": { "application/json": { "schema": { "properties": { "captchaId": { "type": "string" }, "clicks": { "items": { "properties": { "x": { "format": "double", "type": "number" }, "y": { "format": "double", "type": "number" } }, "type": "object" }, "type": "array" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "captchaId": { "type": "string" }, "clicks": { "items": { "properties": { "x": { "format": "double", "type": "number" }, "y": { "format": "double", "type": "number" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Captcha Verify Click", "tags": [ "Admin" ] } }, "/api/admin/dashboard": { "get": { "description": "Auto-generated reference for `GET /api/admin/dashboard`.", "operationId": "get__api__admin__dashboard", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Dashboard", "tags": [ "Admin" ] } }, "/api/admin/notifications": { "get": { "description": "Auto-generated reference for `GET /api/admin/notifications`.", "operationId": "get__api__admin__notifications", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Notifications", "tags": [ "Admin" ] } }, "/api/admin/notifications/delete": { "post": { "description": "Auto-generated reference for `POST /api/admin/notifications/delete`.", "operationId": "post__api__admin__notifications__delete", "requestBody": { "content": { "application/json": { "schema": { "properties": { "ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "onlyRead": { "type": "boolean" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "onlyRead": { "type": "boolean" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Notifications Delete", "tags": [ "Admin" ] } }, "/api/admin/notifications/read": { "post": { "description": "Auto-generated reference for `POST /api/admin/notifications/read`.", "operationId": "post__api__admin__notifications__read", "requestBody": { "content": { "application/json": { "schema": { "properties": { "ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "onlyRead": { "type": "boolean" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "onlyRead": { "type": "boolean" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Notifications Read", "tags": [ "Admin" ] } }, "/api/admin/notifications/unread-count": { "get": { "description": "Auto-generated reference for `GET /api/admin/notifications/unread-count`.", "operationId": "get__api__admin__notifications__unread_dash_count", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Notifications Unread Count", "tags": [ "Admin" ] } }, "/api/admin/notify/catalog": { "get": { "description": "Auto-generated reference for `GET /api/admin/notify/catalog`.", "operationId": "get__api__admin__notify__catalog", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Notify Catalog", "tags": [ "Admin" ] } }, "/api/admin/notify/channels": { "get": { "description": "Auto-generated reference for `GET /api/admin/notify/channels`.", "operationId": "get__api__admin__notify__channels", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Notify Channels", "tags": [ "Admin" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/notify/channels`.", "operationId": "post__api__admin__notify__channels", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config": { "additionalProperties": {}, "type": "object" }, "enabled": { "nullable": true, "type": "boolean" }, "key": { "nullable": true, "type": "string" }, "kind": { "nullable": true, "type": "string" }, "name": { "nullable": true, "type": "string" }, "rateLimitPerMinute": { "nullable": true, "type": "integer" }, "secret": { "nullable": true, "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config": { "additionalProperties": {}, "type": "object" }, "enabled": { "nullable": true, "type": "boolean" }, "key": { "nullable": true, "type": "string" }, "kind": { "nullable": true, "type": "string" }, "name": { "nullable": true, "type": "string" }, "rateLimitPerMinute": { "nullable": true, "type": "integer" }, "secret": { "nullable": true, "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Notify Channels", "tags": [ "Admin" ] } }, "/api/admin/notify/channels/{id}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/notify/channels/{id}`.", "operationId": "delete__api__admin__notify__channels___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Notify Channels Id", "tags": [ "Admin" ] }, "get": { "description": "Auto-generated reference for `GET /api/admin/notify/channels/{id}`.", "operationId": "get__api__admin__notify__channels___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Notify Channels Id", "tags": [ "Admin" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/notify/channels/{id}`.", "operationId": "put__api__admin__notify__channels___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config": { "additionalProperties": {}, "type": "object" }, "enabled": { "nullable": true, "type": "boolean" }, "key": { "nullable": true, "type": "string" }, "kind": { "nullable": true, "type": "string" }, "name": { "nullable": true, "type": "string" }, "rateLimitPerMinute": { "nullable": true, "type": "integer" }, "secret": { "nullable": true, "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config": { "additionalProperties": {}, "type": "object" }, "enabled": { "nullable": true, "type": "boolean" }, "key": { "nullable": true, "type": "string" }, "kind": { "nullable": true, "type": "string" }, "name": { "nullable": true, "type": "string" }, "rateLimitPerMinute": { "nullable": true, "type": "integer" }, "secret": { "nullable": true, "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin Notify Channels Id", "tags": [ "Admin" ] } }, "/api/admin/notify/channels/{id}/test": { "post": { "description": "Auto-generated reference for `POST /api/admin/notify/channels/{id}/test`.", "operationId": "post__api__admin__notify__channels___by_id__test", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Notify Channels Id Test", "tags": [ "Admin" ] } }, "/api/admin/notify/deliveries": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/notify/deliveries`.", "operationId": "delete__api__admin__notify__deliveries", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Notify Deliveries", "tags": [ "Admin" ] }, "get": { "description": "Auto-generated reference for `GET /api/admin/notify/deliveries`.", "operationId": "get__api__admin__notify__deliveries", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Notify Deliveries", "tags": [ "Admin" ] } }, "/api/admin/notify/deliveries/stats": { "get": { "description": "Auto-generated reference for `GET /api/admin/notify/deliveries/stats`.", "operationId": "get__api__admin__notify__deliveries__stats", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Notify Deliveries Stats", "tags": [ "Admin" ] } }, "/api/admin/notify/subscriptions": { "get": { "description": "Auto-generated reference for `GET /api/admin/notify/subscriptions`.", "operationId": "get__api__admin__notify__subscriptions", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Notify Subscriptions", "tags": [ "Admin" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/notify/subscriptions`.", "operationId": "post__api__admin__notify__subscriptions", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "nullable": true, "type": "integer" }, "categoryIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "channelId": { "format": "int64", "type": "integer" }, "enabled": { "nullable": true, "type": "boolean" }, "eventKey": { "type": "string" }, "minPriority": { "type": "string" }, "quietHours": { "nullable": true, "properties": { "end": { "type": "string" }, "start": { "type": "string" }, "timezone": { "type": "string" } }, "type": "object" }, "templateId": { "format": "int64", "nullable": true, "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "nullable": true, "type": "integer" }, "categoryIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "channelId": { "format": "int64", "type": "integer" }, "enabled": { "nullable": true, "type": "boolean" }, "eventKey": { "type": "string" }, "minPriority": { "type": "string" }, "quietHours": { "nullable": true, "properties": { "end": { "type": "string" }, "start": { "type": "string" }, "timezone": { "type": "string" } }, "type": "object" }, "templateId": { "format": "int64", "nullable": true, "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Notify Subscriptions", "tags": [ "Admin" ] } }, "/api/admin/notify/subscriptions/{id}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/notify/subscriptions/{id}`.", "operationId": "delete__api__admin__notify__subscriptions___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Notify Subscriptions Id", "tags": [ "Admin" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/notify/subscriptions/{id}`.", "operationId": "put__api__admin__notify__subscriptions___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "nullable": true, "type": "integer" }, "categoryIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "channelId": { "format": "int64", "type": "integer" }, "enabled": { "nullable": true, "type": "boolean" }, "eventKey": { "type": "string" }, "minPriority": { "type": "string" }, "quietHours": { "nullable": true, "properties": { "end": { "type": "string" }, "start": { "type": "string" }, "timezone": { "type": "string" } }, "type": "object" }, "templateId": { "format": "int64", "nullable": true, "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "nullable": true, "type": "integer" }, "categoryIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "channelId": { "format": "int64", "type": "integer" }, "enabled": { "nullable": true, "type": "boolean" }, "eventKey": { "type": "string" }, "minPriority": { "type": "string" }, "quietHours": { "nullable": true, "properties": { "end": { "type": "string" }, "start": { "type": "string" }, "timezone": { "type": "string" } }, "type": "object" }, "templateId": { "format": "int64", "nullable": true, "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin Notify Subscriptions Id", "tags": [ "Admin" ] } }, "/api/admin/notify/templates": { "get": { "description": "Auto-generated reference for `GET /api/admin/notify/templates`.", "operationId": "get__api__admin__notify__templates", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Notify Templates", "tags": [ "Admin" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/notify/templates`.", "operationId": "post__api__admin__notify__templates", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "bodyTemplate": { "nullable": true, "type": "string" }, "cardTemplate": { "additionalProperties": {}, "type": "object" }, "channelKind": { "nullable": true, "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "eventKey": { "nullable": true, "type": "string" }, "key": { "nullable": true, "type": "string" }, "name": { "nullable": true, "type": "string" }, "titleTemplate": { "nullable": true, "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "bodyTemplate": { "nullable": true, "type": "string" }, "cardTemplate": { "additionalProperties": {}, "type": "object" }, "channelKind": { "nullable": true, "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "eventKey": { "nullable": true, "type": "string" }, "key": { "nullable": true, "type": "string" }, "name": { "nullable": true, "type": "string" }, "titleTemplate": { "nullable": true, "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Notify Templates", "tags": [ "Admin" ] } }, "/api/admin/notify/templates/preview": { "post": { "description": "Auto-generated reference for `POST /api/admin/notify/templates/preview`.", "operationId": "post__api__admin__notify__templates__preview", "requestBody": { "content": { "application/json": { "schema": { "properties": { "bodyTemplate": { "type": "string" }, "titleTemplate": { "type": "string" }, "vars": { "additionalProperties": {}, "type": "object" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "bodyTemplate": { "type": "string" }, "titleTemplate": { "type": "string" }, "vars": { "additionalProperties": {}, "type": "object" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Notify Templates Preview", "tags": [ "Admin" ] } }, "/api/admin/notify/templates/{id}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/notify/templates/{id}`.", "operationId": "delete__api__admin__notify__templates___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Notify Templates Id", "tags": [ "Admin" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/notify/templates/{id}`.", "operationId": "put__api__admin__notify__templates___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "bodyTemplate": { "nullable": true, "type": "string" }, "cardTemplate": { "additionalProperties": {}, "type": "object" }, "channelKind": { "nullable": true, "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "eventKey": { "nullable": true, "type": "string" }, "key": { "nullable": true, "type": "string" }, "name": { "nullable": true, "type": "string" }, "titleTemplate": { "nullable": true, "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "bodyTemplate": { "nullable": true, "type": "string" }, "cardTemplate": { "additionalProperties": {}, "type": "object" }, "channelKind": { "nullable": true, "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "eventKey": { "nullable": true, "type": "string" }, "key": { "nullable": true, "type": "string" }, "name": { "nullable": true, "type": "string" }, "titleTemplate": { "nullable": true, "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin Notify Templates Id", "tags": [ "Admin" ] } }, "/api/admin/oauth-providers/templates": { "get": { "description": "Auto-generated reference for `GET /api/admin/oauth-providers/templates`.", "operationId": "get__api__admin__oauth_dash_providers__templates", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Oauth Providers Templates", "tags": [ "Admin" ] } }, "/api/admin/platform/apps": { "get": { "description": "Auto-generated reference for `GET /api/admin/platform/apps`.", "operationId": "get__api__admin__platform__apps", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Platform Apps", "tags": [ "Admin" ] } }, "/api/admin/platform/apps/batch-governance": { "post": { "description": "Auto-generated reference for `POST /api/admin/platform/apps/batch-governance`.", "operationId": "post__api__admin__platform__apps__batch_dash_governance", "requestBody": { "content": { "application/json": { "schema": { "properties": { "action": { "type": "string" }, "appids": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "durationSeconds": { "format": "int64", "type": "integer" }, "endAt": { "type": "string" }, "evidence": { "additionalProperties": {}, "type": "object" }, "notifyAdmins": { "type": "boolean" }, "reason": { "type": "string" }, "restrictions": { "nullable": true, "properties": { "blockAdminWrite": { "type": "boolean" }, "blockApi": { "type": "boolean" }, "blockLogin": { "type": "boolean" }, "blockNotification": { "type": "boolean" }, "blockPayment": { "type": "boolean" }, "blockRegister": { "type": "boolean" }, "blockStorage": { "type": "boolean" } }, "type": "object" }, "revokeSessions": { "type": "boolean" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "action": { "type": "string" }, "appids": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "durationSeconds": { "format": "int64", "type": "integer" }, "endAt": { "type": "string" }, "evidence": { "additionalProperties": {}, "type": "object" }, "notifyAdmins": { "type": "boolean" }, "reason": { "type": "string" }, "restrictions": { "nullable": true, "properties": { "blockAdminWrite": { "type": "boolean" }, "blockApi": { "type": "boolean" }, "blockLogin": { "type": "boolean" }, "blockNotification": { "type": "boolean" }, "blockPayment": { "type": "boolean" }, "blockRegister": { "type": "boolean" }, "blockStorage": { "type": "boolean" } }, "type": "object" }, "revokeSessions": { "type": "boolean" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Platform Apps Batch Governance", "tags": [ "Admin" ] } }, "/api/admin/platform/apps/{appkey}/governance": { "get": { "description": "Auto-generated reference for `GET /api/admin/platform/apps/{appkey}/governance`.", "operationId": "get__api__admin__platform__apps___by_appkey__governance", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Platform Apps Appkey Governance", "tags": [ "Admin" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/platform/apps/{appkey}/governance`.", "operationId": "post__api__admin__platform__apps___by_appkey__governance", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "action": { "type": "string" }, "durationSeconds": { "format": "int64", "type": "integer" }, "endAt": { "type": "string" }, "evidence": { "additionalProperties": {}, "type": "object" }, "notifyAdmins": { "type": "boolean" }, "reason": { "type": "string" }, "restrictions": { "nullable": true, "properties": { "blockAdminWrite": { "type": "boolean" }, "blockApi": { "type": "boolean" }, "blockLogin": { "type": "boolean" }, "blockNotification": { "type": "boolean" }, "blockPayment": { "type": "boolean" }, "blockRegister": { "type": "boolean" }, "blockStorage": { "type": "boolean" } }, "type": "object" }, "revokeSessions": { "type": "boolean" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "action": { "type": "string" }, "durationSeconds": { "format": "int64", "type": "integer" }, "endAt": { "type": "string" }, "evidence": { "additionalProperties": {}, "type": "object" }, "notifyAdmins": { "type": "boolean" }, "reason": { "type": "string" }, "restrictions": { "nullable": true, "properties": { "blockAdminWrite": { "type": "boolean" }, "blockApi": { "type": "boolean" }, "blockLogin": { "type": "boolean" }, "blockNotification": { "type": "boolean" }, "blockPayment": { "type": "boolean" }, "blockRegister": { "type": "boolean" }, "blockStorage": { "type": "boolean" } }, "type": "object" }, "revokeSessions": { "type": "boolean" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Platform Apps Appkey Governance", "tags": [ "Admin" ] } }, "/api/admin/platform/apps/{appkey}/revoke-sessions": { "post": { "description": "Auto-generated reference for `POST /api/admin/platform/apps/{appkey}/revoke-sessions`.", "operationId": "post__api__admin__platform__apps___by_appkey__revoke_dash_sessions", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "reason": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "reason": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Platform Apps Appkey Revoke Sessions", "tags": [ "Admin" ] } }, "/api/admin/platform/catalog": { "get": { "description": "Auto-generated reference for `GET /api/admin/platform/catalog`.", "operationId": "get__api__admin__platform__catalog", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Platform Catalog", "tags": [ "Admin" ] } }, "/api/admin/platform/governance/actions": { "get": { "description": "Auto-generated reference for `GET /api/admin/platform/governance/actions`.", "operationId": "get__api__admin__platform__governance__actions", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Platform Governance Actions", "tags": [ "Admin" ] } }, "/api/admin/platform/governance/appeals": { "get": { "description": "Auto-generated reference for `GET /api/admin/platform/governance/appeals`.", "operationId": "get__api__admin__platform__governance__appeals", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Platform Governance Appeals", "tags": [ "Admin" ] } }, "/api/admin/platform/governance/appeals/{appealId}/review": { "post": { "description": "Auto-generated reference for `POST /api/admin/platform/governance/appeals/{appealId}/review`.", "operationId": "post__api__admin__platform__governance__appeals___by_appealId__review", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appealId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "decision": { "type": "string" }, "note": { "type": "string" }, "restore": { "nullable": true, "type": "boolean" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "decision": { "type": "string" }, "note": { "type": "string" }, "restore": { "nullable": true, "type": "boolean" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Platform Governance Appeals AppealId Review", "tags": [ "Admin" ] } }, "/api/admin/platform/overview": { "get": { "description": "Auto-generated reference for `GET /api/admin/platform/overview`.", "operationId": "get__api__admin__platform__overview", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Platform Overview", "tags": [ "Admin" ] } }, "/api/admin/platform/storage-config/create": { "post": { "description": "Auto-generated reference for `POST /api/admin/platform/storage-config/create`.", "operationId": "post__api__admin__platform__storage_dash_config__create", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_mode": { "type": "string" }, "appid": { "format": "int64", "type": "integer" }, "base_url": { "type": "string" }, "config_data": { "additionalProperties": {}, "type": "object" }, "config_id": { "format": "int64", "type": "integer" }, "config_name": { "type": "string" }, "description": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "is_default": { "nullable": true, "type": "boolean" }, "provider": { "type": "string" }, "proxy_download": { "nullable": true, "type": "boolean" }, "root_path": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "access_mode": { "type": "string" }, "appid": { "format": "int64", "type": "integer" }, "base_url": { "type": "string" }, "config_data": { "additionalProperties": {}, "type": "object" }, "config_id": { "format": "int64", "type": "integer" }, "config_name": { "type": "string" }, "description": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "is_default": { "nullable": true, "type": "boolean" }, "provider": { "type": "string" }, "proxy_download": { "nullable": true, "type": "boolean" }, "root_path": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Platform Storage Config Create", "tags": [ "Admin" ] } }, "/api/admin/platform/storage-config/delete": { "post": { "description": "Auto-generated reference for `POST /api/admin/platform/storage-config/delete`.", "operationId": "post__api__admin__platform__storage_dash_config__delete", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Platform Storage Config Delete", "tags": [ "Admin" ] } }, "/api/admin/platform/storage-config/detail": { "post": { "description": "Auto-generated reference for `POST /api/admin/platform/storage-config/detail`.", "operationId": "post__api__admin__platform__storage_dash_config__detail", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Platform Storage Config Detail", "tags": [ "Admin" ] } }, "/api/admin/platform/storage-config/list": { "post": { "description": "Auto-generated reference for `POST /api/admin/platform/storage-config/list`.", "operationId": "post__api__admin__platform__storage_dash_config__list", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "provider": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "provider": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Platform Storage Config List", "tags": [ "Admin" ] } }, "/api/admin/platform/storage-config/test": { "post": { "description": "Auto-generated reference for `POST /api/admin/platform/storage-config/test`.", "operationId": "post__api__admin__platform__storage_dash_config__test", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Platform Storage Config Test", "tags": [ "Admin" ] } }, "/api/admin/platform/storage-config/update": { "post": { "description": "Auto-generated reference for `POST /api/admin/platform/storage-config/update`.", "operationId": "post__api__admin__platform__storage_dash_config__update", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_mode": { "type": "string" }, "appid": { "format": "int64", "type": "integer" }, "base_url": { "type": "string" }, "config_data": { "additionalProperties": {}, "type": "object" }, "config_id": { "format": "int64", "type": "integer" }, "config_name": { "type": "string" }, "description": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "is_default": { "nullable": true, "type": "boolean" }, "provider": { "type": "string" }, "proxy_download": { "nullable": true, "type": "boolean" }, "root_path": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "access_mode": { "type": "string" }, "appid": { "format": "int64", "type": "integer" }, "base_url": { "type": "string" }, "config_data": { "additionalProperties": {}, "type": "object" }, "config_id": { "format": "int64", "type": "integer" }, "config_name": { "type": "string" }, "description": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "is_default": { "nullable": true, "type": "boolean" }, "provider": { "type": "string" }, "proxy_download": { "nullable": true, "type": "boolean" }, "root_path": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Platform Storage Config Update", "tags": [ "Admin" ] } }, "/api/admin/profile": { "get": { "description": "Returns the current administrator profile and assignment information.", "operationId": "get__api__admin__profile", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "Get Admin Profile", "tags": [ "Admin Auth" ] }, "put": { "description": "Updates the current administrator profile fields.", "operationId": "put__api__admin__profile", "requestBody": { "content": { "application/json": { "schema": { "properties": { "avatar": { "type": "string" }, "bio": { "type": "string" }, "birthday": { "type": "string" }, "contacts": { "items": { "properties": { "label": { "type": "string" }, "platform": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "type": "array" }, "displayName": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "avatar": { "type": "string" }, "bio": { "type": "string" }, "birthday": { "type": "string" }, "contacts": { "items": { "properties": { "label": { "type": "string" }, "platform": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "type": "array" }, "displayName": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "Update Admin Profile", "tags": [ "Admin Auth" ] } }, "/api/admin/profile/avatar": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/profile/avatar`.", "operationId": "delete__api__admin__profile__avatar", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Profile Avatar", "tags": [ "Admin" ] }, "post": { "description": "Uploads the current administrator avatar using multipart form data.", "operationId": "post__api__admin__profile__avatar", "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "cache_control": { "type": "string" }, "config_name": { "type": "string" }, "content_type": { "type": "string" }, "file": { "format": "binary", "type": "string" }, "file_name": { "type": "string" }, "metadata": { "additionalProperties": true, "type": "object" }, "object_key": { "type": "string" } }, "required": [ "file" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "Upload Admin Avatar", "tags": [ "Admin Auth" ] } }, "/api/admin/profile/passkey": { "get": { "description": "Auto-generated reference for `GET /api/admin/profile/passkey`.", "operationId": "get__api__admin__profile__passkey", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Profile Passkey", "tags": [ "Admin" ] } }, "/api/admin/profile/passkey/register": { "post": { "description": "Auto-generated reference for `POST /api/admin/profile/passkey/register`.", "operationId": "post__api__admin__profile__passkey__register", "requestBody": { "content": { "application/json": { "schema": { "properties": { "challengeId": { "type": "string" }, "credential": {}, "credentialName": { "type": "string" }, "payload": {} }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "challengeId": { "type": "string" }, "credential": {}, "credentialName": { "type": "string" }, "payload": {} }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Profile Passkey Register", "tags": [ "Admin" ] } }, "/api/admin/profile/passkey/register/options": { "post": { "description": "Auto-generated reference for `POST /api/admin/profile/passkey/register/options`.", "operationId": "post__api__admin__profile__passkey__register__options", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Profile Passkey Register Options", "tags": [ "Admin" ] } }, "/api/admin/profile/passkey/{credentialId}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/profile/passkey/{credentialId}`.", "operationId": "delete__api__admin__profile__passkey___by_credentialId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "credentialId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Profile Passkey CredentialId", "tags": [ "Admin" ] } }, "/api/admin/profile/roles": { "get": { "description": "Auto-generated reference for `GET /api/admin/profile/roles`.", "operationId": "get__api__admin__profile__roles", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Profile Roles", "tags": [ "Admin" ] } }, "/api/admin/profile/roles/permissions": { "get": { "description": "Auto-generated reference for `GET /api/admin/profile/roles/permissions`.", "operationId": "get__api__admin__profile__roles__permissions", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Profile Roles Permissions", "tags": [ "Admin" ] } }, "/api/admin/profile/security": { "get": { "description": "Auto-generated reference for `GET /api/admin/profile/security`.", "operationId": "get__api__admin__profile__security", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Profile Security", "tags": [ "Admin" ] } }, "/api/admin/profile/two-factor/disable": { "post": { "description": "Auto-generated reference for `POST /api/admin/profile/two-factor/disable`.", "operationId": "post__api__admin__profile__two_dash_factor__disable", "requestBody": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "recoveryCode": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "code": { "type": "string" }, "recoveryCode": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Profile Two Factor Disable", "tags": [ "Admin" ] } }, "/api/admin/profile/two-factor/enable": { "post": { "description": "Auto-generated reference for `POST /api/admin/profile/two-factor/enable`.", "operationId": "post__api__admin__profile__two_dash_factor__enable", "requestBody": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "enrollmentId": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "code": { "type": "string" }, "enrollmentId": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Profile Two Factor Enable", "tags": [ "Admin" ] } }, "/api/admin/profile/two-factor/enroll": { "post": { "description": "Auto-generated reference for `POST /api/admin/profile/two-factor/enroll`.", "operationId": "post__api__admin__profile__two_dash_factor__enroll", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Profile Two Factor Enroll", "tags": [ "Admin" ] } }, "/api/admin/profile/two-factor/recovery-codes": { "get": { "description": "Auto-generated reference for `GET /api/admin/profile/two-factor/recovery-codes`.", "operationId": "get__api__admin__profile__two_dash_factor__recovery_dash_codes", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Profile Two Factor Recovery Codes", "tags": [ "Admin" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/profile/two-factor/recovery-codes`.", "operationId": "post__api__admin__profile__two_dash_factor__recovery_dash_codes", "requestBody": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "recoveryCode": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "code": { "type": "string" }, "recoveryCode": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Profile Two Factor Recovery Codes", "tags": [ "Admin" ] } }, "/api/admin/profile/two-factor/recovery-codes/regenerate": { "post": { "description": "Auto-generated reference for `POST /api/admin/profile/two-factor/recovery-codes/regenerate`.", "operationId": "post__api__admin__profile__two_dash_factor__recovery_dash_codes__regenerate", "requestBody": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "recoveryCode": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "code": { "type": "string" }, "recoveryCode": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Profile Two Factor Recovery Codes Regenerate", "tags": [ "Admin" ] } }, "/api/admin/profile/upload-avatar": { "post": { "description": "Auto-generated reference for `POST /api/admin/profile/upload-avatar`.", "operationId": "post__api__admin__profile__upload_dash_avatar", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Profile Upload Avatar", "tags": [ "Admin" ] } }, "/api/admin/system/admins": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/admins`.", "operationId": "get__api__admin__system__admins", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Admins", "tags": [ "Admin System" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/system/admins`.", "operationId": "post__api__admin__system__admins", "requestBody": { "content": { "application/json": { "schema": { "properties": { "account": { "type": "string" }, "assignments": { "items": { "properties": { "appid": { "format": "int64", "nullable": true, "type": "integer" }, "roleKey": { "type": "string" } }, "type": "object" }, "type": "array" }, "displayName": { "type": "string" }, "email": { "type": "string" }, "isSuperAdmin": { "type": "boolean" }, "password": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "account": { "type": "string" }, "assignments": { "items": { "properties": { "appid": { "format": "int64", "nullable": true, "type": "integer" }, "roleKey": { "type": "string" } }, "type": "object" }, "type": "array" }, "displayName": { "type": "string" }, "email": { "type": "string" }, "isSuperAdmin": { "type": "boolean" }, "password": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Admins", "tags": [ "Admin System" ] } }, "/api/admin/system/admins/online": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/admins/online`.", "operationId": "get__api__admin__system__admins__online", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Admins Online", "tags": [ "Admin System" ] } }, "/api/admin/system/admins/{adminId}/access": { "put": { "description": "Auto-generated reference for `PUT /api/admin/system/admins/{adminId}/access`.", "operationId": "put__api__admin__system__admins___by_adminId__access", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "adminId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "assignments": { "items": { "properties": { "appid": { "format": "int64", "nullable": true, "type": "integer" }, "roleKey": { "type": "string" } }, "type": "object" }, "type": "array" }, "isSuperAdmin": { "type": "boolean" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "assignments": { "items": { "properties": { "appid": { "format": "int64", "nullable": true, "type": "integer" }, "roleKey": { "type": "string" } }, "type": "object" }, "type": "array" }, "isSuperAdmin": { "type": "boolean" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin System Admins AdminId Access", "tags": [ "Admin System" ] } }, "/api/admin/system/admins/{adminId}/force-logout": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/admins/{adminId}/force-logout`.", "operationId": "post__api__admin__system__admins___by_adminId__force_dash_logout", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "adminId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Admins AdminId Force Logout", "tags": [ "Admin System" ] } }, "/api/admin/system/admins/{adminId}/sessions": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/admins/{adminId}/sessions`.", "operationId": "get__api__admin__system__admins___by_adminId__sessions", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "adminId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Admins AdminId Sessions", "tags": [ "Admin System" ] } }, "/api/admin/system/admins/{adminId}/status": { "put": { "description": "Auto-generated reference for `PUT /api/admin/system/admins/{adminId}/status`.", "operationId": "put__api__admin__system__admins___by_adminId__status", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "adminId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin System Admins AdminId Status", "tags": [ "Admin System" ] } }, "/api/admin/system/announcements": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/announcements`.", "operationId": "get__api__admin__system__announcements", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Announcements", "tags": [ "Admin System" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/system/announcements`.", "operationId": "post__api__admin__system__announcements", "requestBody": { "content": { "application/json": { "schema": { "properties": { "content": { "type": "string" }, "expiresAt": { "nullable": true, "type": "string" }, "level": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "pinned": { "nullable": true, "type": "boolean" }, "title": { "type": "string" }, "type": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "content": { "type": "string" }, "expiresAt": { "nullable": true, "type": "string" }, "level": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "pinned": { "nullable": true, "type": "boolean" }, "title": { "type": "string" }, "type": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Announcements", "tags": [ "Admin System" ] } }, "/api/admin/system/announcements/{id}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/announcements/{id}`.", "operationId": "delete__api__admin__system__announcements___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System Announcements Id", "tags": [ "Admin System" ] }, "get": { "description": "Auto-generated reference for `GET /api/admin/system/announcements/{id}`.", "operationId": "get__api__admin__system__announcements___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Announcements Id", "tags": [ "Admin System" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/system/announcements/{id}`.", "operationId": "put__api__admin__system__announcements___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "content": { "type": "string" }, "expiresAt": { "nullable": true, "type": "string" }, "level": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "pinned": { "nullable": true, "type": "boolean" }, "title": { "type": "string" }, "type": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "content": { "type": "string" }, "expiresAt": { "nullable": true, "type": "string" }, "level": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "pinned": { "nullable": true, "type": "boolean" }, "title": { "type": "string" }, "type": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin System Announcements Id", "tags": [ "Admin System" ] } }, "/api/admin/system/announcements/{id}/archive": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/announcements/{id}/archive`.", "operationId": "post__api__admin__system__announcements___by_id__archive", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Announcements Id Archive", "tags": [ "Admin System" ] } }, "/api/admin/system/announcements/{id}/publish": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/announcements/{id}/publish`.", "operationId": "post__api__admin__system__announcements___by_id__publish", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Announcements Id Publish", "tags": [ "Admin System" ] } }, "/api/admin/system/audit-logs": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/audit-logs`.", "operationId": "get__api__admin__system__audit_dash_logs", "parameters": [ { "in": "query", "name": "action", "schema": { "type": "string" } }, { "in": "query", "name": "resource", "schema": { "type": "string" } }, { "in": "query", "name": "category", "schema": { "type": "string" } }, { "in": "query", "name": "severity", "schema": { "type": "string" } }, { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "statusCode", "schema": { "type": "integer" } }, { "in": "query", "name": "adminId", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "ip", "schema": { "type": "string" } }, { "in": "query", "name": "country", "schema": { "type": "string" } }, { "in": "query", "name": "requestId", "schema": { "type": "string" } }, { "in": "query", "name": "traceId", "schema": { "type": "string" } }, { "in": "query", "name": "keyword", "schema": { "type": "string" } }, { "in": "query", "name": "startTime", "schema": { "type": "string" } }, { "in": "query", "name": "endTime", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Audit Logs", "tags": [ "Admin System" ] } }, "/api/admin/system/audit-logs/export": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/audit-logs/export`.", "operationId": "get__api__admin__system__audit_dash_logs__export", "parameters": [ { "in": "query", "name": "action", "schema": { "type": "string" } }, { "in": "query", "name": "resource", "schema": { "type": "string" } }, { "in": "query", "name": "category", "schema": { "type": "string" } }, { "in": "query", "name": "severity", "schema": { "type": "string" } }, { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "statusCode", "schema": { "type": "integer" } }, { "in": "query", "name": "adminId", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "ip", "schema": { "type": "string" } }, { "in": "query", "name": "country", "schema": { "type": "string" } }, { "in": "query", "name": "requestId", "schema": { "type": "string" } }, { "in": "query", "name": "traceId", "schema": { "type": "string" } }, { "in": "query", "name": "keyword", "schema": { "type": "string" } }, { "in": "query", "name": "startTime", "schema": { "type": "string" } }, { "in": "query", "name": "endTime", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Audit Logs Export", "tags": [ "Admin System" ] } }, "/api/admin/system/audit-logs/stats": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/audit-logs/stats`.", "operationId": "get__api__admin__system__audit_dash_logs__stats", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Audit Logs Stats", "tags": [ "Admin System" ] } }, "/api/admin/system/audit-logs/{id}": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/audit-logs/{id}`.", "operationId": "get__api__admin__system__audit_dash_logs___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Audit Logs Id", "tags": [ "Admin System" ] } }, "/api/admin/system/authz/admins/{adminId}/grants": { "put": { "description": "Auto-generated reference for `PUT /api/admin/system/authz/admins/{adminId}/grants`.", "operationId": "put__api__admin__system__authz__admins___by_adminId__grants", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "adminId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "grants": { "items": { "properties": { "appid": { "format": "int64", "nullable": true, "type": "integer" }, "effect": { "type": "string" }, "note": { "type": "string" }, "permission": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "grants": { "items": { "properties": { "appid": { "format": "int64", "nullable": true, "type": "integer" }, "effect": { "type": "string" }, "note": { "type": "string" }, "permission": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin System Authz Admins AdminId Grants", "tags": [ "Admin System" ] } }, "/api/admin/system/authz/explain": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/authz/explain`.", "operationId": "post__api__admin__system__authz__explain", "requestBody": { "content": { "application/json": { "schema": { "properties": { "adminId": { "format": "int64", "type": "integer" }, "appid": { "format": "int64", "nullable": true, "type": "integer" }, "permission": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "adminId": { "format": "int64", "type": "integer" }, "appid": { "format": "int64", "nullable": true, "type": "integer" }, "permission": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Authz Explain", "tags": [ "Admin System" ] } }, "/api/admin/system/authz/model": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/authz/model`.", "operationId": "get__api__admin__system__authz__model", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Authz Model", "tags": [ "Admin System" ] } }, "/api/admin/system/authz/policies": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/authz/policies`.", "operationId": "get__api__admin__system__authz__policies", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Authz Policies", "tags": [ "Admin System" ] } }, "/api/admin/system/authz/policies/subject": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/authz/policies/subject`.", "operationId": "get__api__admin__system__authz__policies__subject", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Authz Policies Subject", "tags": [ "Admin System" ] } }, "/api/admin/system/authz/reload": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/authz/reload`.", "operationId": "post__api__admin__system__authz__reload", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Authz Reload", "tags": [ "Admin System" ] } }, "/api/admin/system/authz/roles/override": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/authz/roles/override`.", "operationId": "post__api__admin__system__authz__roles__override", "requestBody": { "content": { "application/json": { "schema": { "properties": { "allow": { "items": { "type": "string" }, "type": "array" }, "deny": { "items": { "type": "string" }, "type": "array" }, "inherits": { "items": { "type": "string" }, "type": "array" }, "note": { "type": "string" }, "roleKey": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "allow": { "items": { "type": "string" }, "type": "array" }, "deny": { "items": { "type": "string" }, "type": "array" }, "inherits": { "items": { "type": "string" }, "type": "array" }, "note": { "type": "string" }, "roleKey": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Authz Roles Override", "tags": [ "Admin System" ] } }, "/api/admin/system/banners": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/banners`.", "operationId": "get__api__admin__system__banners", "parameters": [ { "in": "query", "name": "status", "schema": { "type": "boolean" } }, { "in": "query", "name": "type", "schema": { "type": "string" } }, { "in": "query", "name": "keyword", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Banners", "tags": [ "Admin System" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/system/banners`.", "operationId": "post__api__admin__system__banners", "requestBody": { "content": { "application/json": { "schema": { "properties": { "clickUrl": { "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "endTime": { "format": "date-time", "nullable": true, "type": "string" }, "imageUrl": { "nullable": true, "type": "string" }, "position": { "nullable": true, "type": "integer" }, "startTime": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "nullable": true, "type": "boolean" }, "title": { "nullable": true, "type": "string" }, "type": { "nullable": true, "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "clickUrl": { "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "endTime": { "format": "date-time", "nullable": true, "type": "string" }, "imageUrl": { "nullable": true, "type": "string" }, "position": { "nullable": true, "type": "integer" }, "startTime": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "nullable": true, "type": "boolean" }, "title": { "nullable": true, "type": "string" }, "type": { "nullable": true, "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Banners", "tags": [ "Admin System" ] } }, "/api/admin/system/banners/active": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/banners/active`.", "operationId": "get__api__admin__system__banners__active", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Banners Active", "tags": [ "Admin System" ] } }, "/api/admin/system/banners/bulk-delete": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/banners/bulk-delete`.", "operationId": "post__api__admin__system__banners__bulk_dash_delete", "requestBody": { "content": { "application/json": { "schema": { "properties": { "ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Banners Bulk Delete", "tags": [ "Admin System" ] } }, "/api/admin/system/banners/upload": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/banners/upload`.", "operationId": "post__api__admin__system__banners__upload", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Banners Upload", "tags": [ "Admin System" ] } }, "/api/admin/system/banners/{id}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/banners/{id}`.", "operationId": "delete__api__admin__system__banners___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System Banners Id", "tags": [ "Admin System" ] }, "get": { "description": "Auto-generated reference for `GET /api/admin/system/banners/{id}`.", "operationId": "get__api__admin__system__banners___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Banners Id", "tags": [ "Admin System" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/system/banners/{id}`.", "operationId": "put__api__admin__system__banners___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "clickUrl": { "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "endTime": { "format": "date-time", "nullable": true, "type": "string" }, "imageUrl": { "nullable": true, "type": "string" }, "position": { "nullable": true, "type": "integer" }, "startTime": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "nullable": true, "type": "boolean" }, "title": { "nullable": true, "type": "string" }, "type": { "nullable": true, "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "clickUrl": { "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "endTime": { "format": "date-time", "nullable": true, "type": "string" }, "imageUrl": { "nullable": true, "type": "string" }, "position": { "nullable": true, "type": "integer" }, "startTime": { "format": "date-time", "nullable": true, "type": "string" }, "status": { "nullable": true, "type": "boolean" }, "title": { "nullable": true, "type": "string" }, "type": { "nullable": true, "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin System Banners Id", "tags": [ "Admin System" ] } }, "/api/admin/system/captcha/preview": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/captcha/preview`.", "operationId": "post__api__admin__system__captcha__preview", "requestBody": { "content": { "application/json": { "schema": { "properties": { "frameDelayMs": { "type": "integer" }, "frames": { "type": "integer" }, "height": { "type": "integer" }, "length": { "type": "integer" }, "mode": { "type": "string" }, "noise": { "type": "integer" }, "width": { "type": "integer" }, "wobble": { "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "frameDelayMs": { "type": "integer" }, "frames": { "type": "integer" }, "height": { "type": "integer" }, "length": { "type": "integer" }, "mode": { "type": "string" }, "noise": { "type": "integer" }, "width": { "type": "integer" }, "wobble": { "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Captcha Preview", "tags": [ "Admin System" ] } }, "/api/admin/system/crashlogs": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/crashlogs`.", "operationId": "get__api__admin__system__crashlogs", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Crashlogs", "tags": [ "Admin System" ] } }, "/api/admin/system/crashlogs/{filename}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/crashlogs/{filename}`.", "operationId": "delete__api__admin__system__crashlogs___by_filename", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "filename", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System Crashlogs Filename", "tags": [ "Admin System" ] }, "get": { "description": "Auto-generated reference for `GET /api/admin/system/crashlogs/{filename}`.", "operationId": "get__api__admin__system__crashlogs___by_filename", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "filename", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Crashlogs Filename", "tags": [ "Admin System" ] } }, "/api/admin/system/database/history": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/database/history`.", "operationId": "get__api__admin__system__database__history", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Database History", "tags": [ "Admin System" ] } }, "/api/admin/system/database/leak": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/database/leak`.", "operationId": "get__api__admin__system__database__leak", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Database Leak", "tags": [ "Admin System" ] } }, "/api/admin/system/database/maintenance": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/database/maintenance`.", "operationId": "get__api__admin__system__database__maintenance", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Database Maintenance", "tags": [ "Admin System" ] } }, "/api/admin/system/database/refresh": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/database/refresh`.", "operationId": "post__api__admin__system__database__refresh", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Database Refresh", "tags": [ "Admin System" ] } }, "/api/admin/system/database/sessions": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/database/sessions`.", "operationId": "get__api__admin__system__database__sessions", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Database Sessions", "tags": [ "Admin System" ] } }, "/api/admin/system/database/sessions/{pid}/cancel": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/database/sessions/{pid}/cancel`.", "operationId": "post__api__admin__system__database__sessions___by_pid__cancel", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "pid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Database Sessions Pid Cancel", "tags": [ "Admin System" ] } }, "/api/admin/system/database/sessions/{pid}/terminate": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/database/sessions/{pid}/terminate`.", "operationId": "post__api__admin__system__database__sessions___by_pid__terminate", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "pid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Database Sessions Pid Terminate", "tags": [ "Admin System" ] } }, "/api/admin/system/database/slow-queries": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/database/slow-queries`.", "operationId": "get__api__admin__system__database__slow_dash_queries", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Database Slow Queries", "tags": [ "Admin System" ] } }, "/api/admin/system/database/snapshot": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/database/snapshot`.", "operationId": "get__api__admin__system__database__snapshot", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Database Snapshot", "tags": [ "Admin System" ] } }, "/api/admin/system/database/warmup": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/database/warmup`.", "operationId": "post__api__admin__system__database__warmup", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Database Warmup", "tags": [ "Admin System" ] } }, "/api/admin/system/delegations": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/delegations`.", "operationId": "get__api__admin__system__delegations", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Delegations", "tags": [ "Admin System" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/system/delegations`.", "operationId": "post__api__admin__system__delegations", "requestBody": { "content": { "application/json": { "schema": { "properties": { "delegateId": { "format": "int64", "type": "integer" }, "delegatorId": { "format": "int64", "type": "integer" }, "expiresAt": { "type": "string" }, "reason": { "type": "string" }, "scope": { "type": "string" }, "scopeId": { "format": "int64", "nullable": true, "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "delegateId": { "format": "int64", "type": "integer" }, "delegatorId": { "format": "int64", "type": "integer" }, "expiresAt": { "type": "string" }, "reason": { "type": "string" }, "scope": { "type": "string" }, "scopeId": { "format": "int64", "nullable": true, "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Delegations", "tags": [ "Admin System" ] } }, "/api/admin/system/delegations/{delegationId}/revoke": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/delegations/{delegationId}/revoke`.", "operationId": "post__api__admin__system__delegations___by_delegationId__revoke", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "delegationId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Delegations DelegationId Revoke", "tags": [ "Admin System" ] } }, "/api/admin/system/device-marketing-names": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/device-marketing-names`.", "operationId": "get__api__admin__system__device_dash_marketing_dash_names", "parameters": [ { "in": "query", "name": "platform", "schema": { "type": "string" } }, { "in": "query", "name": "keyword", "schema": { "type": "string" } }, { "in": "query", "name": "source", "schema": { "type": "string" } }, { "in": "query", "name": "manufacturer", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Device Marketing Names", "tags": [ "Admin System" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/system/device-marketing-names`.", "operationId": "post__api__admin__system__device_dash_marketing_dash_names", "requestBody": { "content": { "application/json": { "schema": { "properties": { "deviceImageUrl": { "type": "string" }, "identifier": { "type": "string" }, "manufacturer": { "type": "string" }, "manufacturerIconUrl": { "type": "string" }, "marketingName": { "type": "string" }, "notes": { "type": "string" }, "platform": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "deviceImageUrl": { "type": "string" }, "identifier": { "type": "string" }, "manufacturer": { "type": "string" }, "manufacturerIconUrl": { "type": "string" }, "marketingName": { "type": "string" }, "notes": { "type": "string" }, "platform": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Device Marketing Names", "tags": [ "Admin System" ] } }, "/api/admin/system/device-marketing-names/lookup": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/device-marketing-names/lookup`.", "operationId": "get__api__admin__system__device_dash_marketing_dash_names__lookup", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Device Marketing Names Lookup", "tags": [ "Admin System" ] } }, "/api/admin/system/device-marketing-names/manufacturers": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/device-marketing-names/manufacturers`.", "operationId": "get__api__admin__system__device_dash_marketing_dash_names__manufacturers", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Device Marketing Names Manufacturers", "tags": [ "Admin System" ] } }, "/api/admin/system/device-marketing-names/seed": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/device-marketing-names/seed`.", "operationId": "post__api__admin__system__device_dash_marketing_dash_names__seed", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Device Marketing Names Seed", "tags": [ "Admin System" ] } }, "/api/admin/system/device-marketing-names/{id}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/device-marketing-names/{id}`.", "operationId": "delete__api__admin__system__device_dash_marketing_dash_names___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System Device Marketing Names Id", "tags": [ "Admin System" ] }, "get": { "description": "Auto-generated reference for `GET /api/admin/system/device-marketing-names/{id}`.", "operationId": "get__api__admin__system__device_dash_marketing_dash_names___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Device Marketing Names Id", "tags": [ "Admin System" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/system/device-marketing-names/{id}`.", "operationId": "put__api__admin__system__device_dash_marketing_dash_names___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "deviceImageUrl": { "nullable": true, "type": "string" }, "identifier": { "nullable": true, "type": "string" }, "manufacturer": { "nullable": true, "type": "string" }, "manufacturerIconUrl": { "nullable": true, "type": "string" }, "marketingName": { "nullable": true, "type": "string" }, "notes": { "nullable": true, "type": "string" }, "platform": { "nullable": true, "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "deviceImageUrl": { "nullable": true, "type": "string" }, "identifier": { "nullable": true, "type": "string" }, "manufacturer": { "nullable": true, "type": "string" }, "manufacturerIconUrl": { "nullable": true, "type": "string" }, "marketingName": { "nullable": true, "type": "string" }, "notes": { "nullable": true, "type": "string" }, "platform": { "nullable": true, "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin System Device Marketing Names Id", "tags": [ "Admin System" ] } }, "/api/admin/system/egress": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/egress`.", "operationId": "get__api__admin__system__egress", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Egress", "tags": [ "Admin System" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/system/egress`.", "operationId": "put__api__admin__system__egress", "requestBody": { "content": { "application/json": { "schema": { "properties": { "defaultAction": { "type": "string" }, "defaultEndpoints": { "items": { "type": "string" }, "type": "array" }, "defaultStrategy": { "type": "string" }, "dialTimeoutMs": { "type": "integer" }, "enabled": { "type": "boolean" }, "endpoints": { "items": { "properties": { "address": { "type": "string" }, "clearSecrets": { "type": "boolean" }, "dialTimeoutMs": { "type": "integer" }, "enabled": { "nullable": true, "type": "boolean" }, "headers": { "additionalProperties": { "type": "string" }, "type": "object" }, "httpForwardMode": { "type": "boolean" }, "name": { "type": "string" }, "options": { "additionalProperties": { "type": "string" }, "type": "object" }, "password": { "type": "string" }, "probeUrl": { "type": "string" }, "protocol": { "type": "string" }, "region": { "type": "string" }, "remark": { "type": "string" }, "shadowsocks": { "properties": { "method": { "type": "string" }, "password": { "type": "string" } }, "type": "object" }, "ssh": { "properties": { "hostKeyFingerprint": { "type": "string" }, "keepAliveSeconds": { "type": "integer" }, "passphrase": { "type": "string" }, "password": { "type": "string" }, "privateKeyPem": { "type": "string" }, "user": { "type": "string" } }, "type": "object" }, "tls": { "properties": { "alpn": { "items": { "type": "string" }, "type": "array" }, "caPem": { "type": "string" }, "clientCertPem": { "type": "string" }, "clientKeyPem": { "type": "string" }, "enabled": { "type": "boolean" }, "insecureSkipVerify": { "type": "boolean" }, "minVersion": { "type": "string" }, "serverName": { "type": "string" } }, "type": "object" }, "username": { "type": "string" }, "via": { "type": "string" }, "weight": { "type": "integer" } }, "type": "object" }, "type": "array" }, "health": { "properties": { "allowUnhealthy": { "nullable": true, "type": "boolean" }, "cooldownSeconds": { "type": "integer" }, "enabled": { "type": "boolean" }, "failureThreshold": { "type": "integer" }, "intervalSeconds": { "type": "integer" }, "passiveEnabled": { "type": "boolean" }, "probeUrl": { "type": "string" }, "successThreshold": { "type": "integer" }, "timeoutSeconds": { "type": "integer" } }, "type": "object" }, "idleConnTimeoutMs": { "type": "integer" }, "maxIdleConnsPerHost": { "type": "integer" }, "responseHeaderTimeoutMs": { "type": "integer" }, "rules": { "items": { "properties": { "action": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "endpoints": { "items": { "type": "string" }, "type": "array" }, "match": { "properties": { "cidrs": { "items": { "type": "string" }, "type": "array" }, "domainKeywords": { "items": { "type": "string" }, "type": "array" }, "domainRegexps": { "items": { "type": "string" }, "type": "array" }, "domainSuffixes": { "items": { "type": "string" }, "type": "array" }, "domains": { "items": { "type": "string" }, "type": "array" }, "excludeDomainSuffixes": { "items": { "type": "string" }, "type": "array" }, "matchAll": { "type": "boolean" }, "ports": { "items": { "type": "integer" }, "type": "array" }, "profiles": { "items": { "type": "string" }, "type": "array" }, "schemes": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "name": { "type": "string" }, "priority": { "type": "integer" }, "remark": { "type": "string" }, "strategy": { "type": "string" } }, "type": "object" }, "type": "array" }, "tlsHandshakeTimeoutMs": { "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "defaultAction": { "type": "string" }, "defaultEndpoints": { "items": { "type": "string" }, "type": "array" }, "defaultStrategy": { "type": "string" }, "dialTimeoutMs": { "type": "integer" }, "enabled": { "type": "boolean" }, "endpoints": { "items": { "properties": { "address": { "type": "string" }, "clearSecrets": { "type": "boolean" }, "dialTimeoutMs": { "type": "integer" }, "enabled": { "nullable": true, "type": "boolean" }, "headers": { "additionalProperties": { "type": "string" }, "type": "object" }, "httpForwardMode": { "type": "boolean" }, "name": { "type": "string" }, "options": { "additionalProperties": { "type": "string" }, "type": "object" }, "password": { "type": "string" }, "probeUrl": { "type": "string" }, "protocol": { "type": "string" }, "region": { "type": "string" }, "remark": { "type": "string" }, "shadowsocks": { "properties": { "method": { "type": "string" }, "password": { "type": "string" } }, "type": "object" }, "ssh": { "properties": { "hostKeyFingerprint": { "type": "string" }, "keepAliveSeconds": { "type": "integer" }, "passphrase": { "type": "string" }, "password": { "type": "string" }, "privateKeyPem": { "type": "string" }, "user": { "type": "string" } }, "type": "object" }, "tls": { "properties": { "alpn": { "items": { "type": "string" }, "type": "array" }, "caPem": { "type": "string" }, "clientCertPem": { "type": "string" }, "clientKeyPem": { "type": "string" }, "enabled": { "type": "boolean" }, "insecureSkipVerify": { "type": "boolean" }, "minVersion": { "type": "string" }, "serverName": { "type": "string" } }, "type": "object" }, "username": { "type": "string" }, "via": { "type": "string" }, "weight": { "type": "integer" } }, "type": "object" }, "type": "array" }, "health": { "properties": { "allowUnhealthy": { "nullable": true, "type": "boolean" }, "cooldownSeconds": { "type": "integer" }, "enabled": { "type": "boolean" }, "failureThreshold": { "type": "integer" }, "intervalSeconds": { "type": "integer" }, "passiveEnabled": { "type": "boolean" }, "probeUrl": { "type": "string" }, "successThreshold": { "type": "integer" }, "timeoutSeconds": { "type": "integer" } }, "type": "object" }, "idleConnTimeoutMs": { "type": "integer" }, "maxIdleConnsPerHost": { "type": "integer" }, "responseHeaderTimeoutMs": { "type": "integer" }, "rules": { "items": { "properties": { "action": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "endpoints": { "items": { "type": "string" }, "type": "array" }, "match": { "properties": { "cidrs": { "items": { "type": "string" }, "type": "array" }, "domainKeywords": { "items": { "type": "string" }, "type": "array" }, "domainRegexps": { "items": { "type": "string" }, "type": "array" }, "domainSuffixes": { "items": { "type": "string" }, "type": "array" }, "domains": { "items": { "type": "string" }, "type": "array" }, "excludeDomainSuffixes": { "items": { "type": "string" }, "type": "array" }, "matchAll": { "type": "boolean" }, "ports": { "items": { "type": "integer" }, "type": "array" }, "profiles": { "items": { "type": "string" }, "type": "array" }, "schemes": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "name": { "type": "string" }, "priority": { "type": "integer" }, "remark": { "type": "string" }, "strategy": { "type": "string" } }, "type": "object" }, "type": "array" }, "tlsHandshakeTimeoutMs": { "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin System Egress", "tags": [ "Admin System" ] } }, "/api/admin/system/egress/explain": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/egress/explain`.", "operationId": "post__api__admin__system__egress__explain", "requestBody": { "content": { "application/json": { "schema": { "properties": { "host": { "type": "string" }, "port": { "type": "integer" }, "profile": { "type": "string" }, "scheme": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "host": { "type": "string" }, "port": { "type": "integer" }, "profile": { "type": "string" }, "scheme": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Egress Explain", "tags": [ "Admin System" ] } }, "/api/admin/system/egress/probe": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/egress/probe`.", "operationId": "post__api__admin__system__egress__probe", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Egress Probe", "tags": [ "Admin System" ] } }, "/api/admin/system/egress/reset": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/egress/reset`.", "operationId": "post__api__admin__system__egress__reset", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Egress Reset", "tags": [ "Admin System" ] } }, "/api/admin/system/egress/test": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/egress/test`.", "operationId": "post__api__admin__system__egress__test", "requestBody": { "content": { "application/json": { "schema": { "properties": { "endpoint": { "type": "string" }, "profile": { "type": "string" }, "timeoutMs": { "type": "integer" }, "url": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "endpoint": { "type": "string" }, "profile": { "type": "string" }, "timeoutMs": { "type": "integer" }, "url": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Egress Test", "tags": [ "Admin System" ] } }, "/api/admin/system/email/channel": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/email/channel`.", "operationId": "get__api__admin__system__email__channel", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Email Channel", "tags": [ "Admin System" ] } }, "/api/admin/system/email/configs": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/email/configs`.", "operationId": "get__api__admin__system__email__configs", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Email Configs", "tags": [ "Admin System" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/system/email/configs`.", "operationId": "post__api__admin__system__email__configs", "requestBody": { "content": { "application/json": { "schema": { "properties": { "clear_secrets": { "items": { "type": "string" }, "type": "array" }, "config_name": { "type": "string" }, "description": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "is_default": { "nullable": true, "type": "boolean" }, "provider": { "type": "string" }, "replace_settings": { "type": "boolean" }, "secrets": { "additionalProperties": { "type": "string" }, "type": "object" }, "settings": { "additionalProperties": { "type": "string" }, "type": "object" }, "shared": { "nullable": true, "type": "boolean" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "clear_secrets": { "items": { "type": "string" }, "type": "array" }, "config_name": { "type": "string" }, "description": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "is_default": { "nullable": true, "type": "boolean" }, "provider": { "type": "string" }, "replace_settings": { "type": "boolean" }, "secrets": { "additionalProperties": { "type": "string" }, "type": "object" }, "settings": { "additionalProperties": { "type": "string" }, "type": "object" }, "shared": { "nullable": true, "type": "boolean" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Email Configs", "tags": [ "Admin System" ] } }, "/api/admin/system/email/configs/{configId}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/email/configs/{configId}`.", "operationId": "delete__api__admin__system__email__configs___by_configId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "configId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System Email Configs ConfigId", "tags": [ "Admin System" ] }, "get": { "description": "Auto-generated reference for `GET /api/admin/system/email/configs/{configId}`.", "operationId": "get__api__admin__system__email__configs___by_configId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "configId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Email Configs ConfigId", "tags": [ "Admin System" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/system/email/configs/{configId}`.", "operationId": "put__api__admin__system__email__configs___by_configId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "configId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "clear_secrets": { "items": { "type": "string" }, "type": "array" }, "config_name": { "type": "string" }, "description": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "is_default": { "nullable": true, "type": "boolean" }, "provider": { "type": "string" }, "replace_settings": { "type": "boolean" }, "secrets": { "additionalProperties": { "type": "string" }, "type": "object" }, "settings": { "additionalProperties": { "type": "string" }, "type": "object" }, "shared": { "nullable": true, "type": "boolean" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "clear_secrets": { "items": { "type": "string" }, "type": "array" }, "config_name": { "type": "string" }, "description": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "is_default": { "nullable": true, "type": "boolean" }, "provider": { "type": "string" }, "replace_settings": { "type": "boolean" }, "secrets": { "additionalProperties": { "type": "string" }, "type": "object" }, "settings": { "additionalProperties": { "type": "string" }, "type": "object" }, "shared": { "nullable": true, "type": "boolean" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin System Email Configs ConfigId", "tags": [ "Admin System" ] } }, "/api/admin/system/email/configs/{configId}/test": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/email/configs/{configId}/test`.", "operationId": "post__api__admin__system__email__configs___by_configId__test", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "configId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "test_email": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "test_email": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Email Configs ConfigId Test", "tags": [ "Admin System" ] } }, "/api/admin/system/email/deliveries": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/email/deliveries`.", "operationId": "get__api__admin__system__email__deliveries", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Email Deliveries", "tags": [ "Admin System" ] } }, "/api/admin/system/email/providers": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/email/providers`.", "operationId": "get__api__admin__system__email__providers", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Email Providers", "tags": [ "Admin System" ] } }, "/api/admin/system/email/stats": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/email/stats`.", "operationId": "get__api__admin__system__email__stats", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Email Stats", "tags": [ "Admin System" ] } }, "/api/admin/system/firewall/bans": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/firewall/bans`.", "operationId": "get__api__admin__system__firewall__bans", "parameters": [ { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "pageSize", "schema": { "type": "integer" } }, { "in": "query", "name": "ip", "schema": { "type": "string" } }, { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "source", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Firewall Bans", "tags": [ "Admin System" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/system/firewall/bans`.", "operationId": "post__api__admin__system__firewall__bans", "requestBody": { "content": { "application/json": { "schema": { "properties": { "delayMs": { "type": "integer" }, "duration": { "format": "int64", "type": "integer" }, "ip": { "type": "string" }, "mode": { "type": "string" }, "reason": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "delayMs": { "type": "integer" }, "duration": { "format": "int64", "type": "integer" }, "ip": { "type": "string" }, "mode": { "type": "string" }, "reason": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Firewall Bans", "tags": [ "Admin System" ] } }, "/api/admin/system/firewall/bans/modes": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/firewall/bans/modes`.", "operationId": "get__api__admin__system__firewall__bans__modes", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Firewall Bans Modes", "tags": [ "Admin System" ] } }, "/api/admin/system/firewall/bans/{banId}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/firewall/bans/{banId}`.", "operationId": "delete__api__admin__system__firewall__bans___by_banId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "banId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System Firewall Bans BanId", "tags": [ "Admin System" ] } }, "/api/admin/system/firewall/geo-bans": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/firewall/geo-bans`.", "operationId": "get__api__admin__system__firewall__geo_dash_bans", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Firewall Geo Bans", "tags": [ "Admin System" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/system/firewall/geo-bans`.", "operationId": "post__api__admin__system__firewall__geo_dash_bans", "requestBody": { "content": { "application/json": { "schema": { "properties": { "enabled": { "nullable": true, "type": "boolean" }, "expiresAt": { "type": "string" }, "mode": { "type": "string" }, "reason": { "type": "string" }, "scopeType": { "type": "string" }, "scopeValue": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "enabled": { "nullable": true, "type": "boolean" }, "expiresAt": { "type": "string" }, "mode": { "type": "string" }, "reason": { "type": "string" }, "scopeType": { "type": "string" }, "scopeValue": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Firewall Geo Bans", "tags": [ "Admin System" ] } }, "/api/admin/system/firewall/geo-bans/{id}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/firewall/geo-bans/{id}`.", "operationId": "delete__api__admin__system__firewall__geo_dash_bans___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System Firewall Geo Bans Id", "tags": [ "Admin System" ] }, "patch": { "description": "Auto-generated reference for `PATCH /api/admin/system/firewall/geo-bans/{id}`.", "operationId": "patch__api__admin__system__firewall__geo_dash_bans___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "enabled": { "type": "boolean" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "enabled": { "type": "boolean" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PATCH Api Admin System Firewall Geo Bans Id", "tags": [ "Admin System" ] } }, "/api/admin/system/firewall/geo-fences": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/firewall/geo-fences`.", "operationId": "get__api__admin__system__firewall__geo_dash_fences", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Firewall Geo Fences", "tags": [ "Admin System" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/system/firewall/geo-fences`.", "operationId": "post__api__admin__system__firewall__geo_dash_fences", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appId": { "format": "int64", "nullable": true, "type": "integer" }, "banMode": { "type": "string" }, "centerLat": { "format": "double", "nullable": true, "type": "number" }, "centerLng": { "format": "double", "nullable": true, "type": "number" }, "enabled": { "nullable": true, "type": "boolean" }, "expiresAt": { "type": "string" }, "fence": {}, "mode": { "type": "string" }, "name": { "type": "string" }, "radiusM": { "format": "double", "nullable": true, "type": "number" }, "reason": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appId": { "format": "int64", "nullable": true, "type": "integer" }, "banMode": { "type": "string" }, "centerLat": { "format": "double", "nullable": true, "type": "number" }, "centerLng": { "format": "double", "nullable": true, "type": "number" }, "enabled": { "nullable": true, "type": "boolean" }, "expiresAt": { "type": "string" }, "fence": {}, "mode": { "type": "string" }, "name": { "type": "string" }, "radiusM": { "format": "double", "nullable": true, "type": "number" }, "reason": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Firewall Geo Fences", "tags": [ "Admin System" ] } }, "/api/admin/system/firewall/geo-fences/preview": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/firewall/geo-fences/preview`.", "operationId": "post__api__admin__system__firewall__geo_dash_fences__preview", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appId": { "format": "int64", "nullable": true, "type": "integer" }, "banMode": { "type": "string" }, "centerLat": { "format": "double", "nullable": true, "type": "number" }, "centerLng": { "format": "double", "nullable": true, "type": "number" }, "enabled": { "nullable": true, "type": "boolean" }, "expiresAt": { "type": "string" }, "fence": {}, "mode": { "type": "string" }, "name": { "type": "string" }, "radiusM": { "format": "double", "nullable": true, "type": "number" }, "reason": { "type": "string" }, "windowDays": { "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appId": { "format": "int64", "nullable": true, "type": "integer" }, "banMode": { "type": "string" }, "centerLat": { "format": "double", "nullable": true, "type": "number" }, "centerLng": { "format": "double", "nullable": true, "type": "number" }, "enabled": { "nullable": true, "type": "boolean" }, "expiresAt": { "type": "string" }, "fence": {}, "mode": { "type": "string" }, "name": { "type": "string" }, "radiusM": { "format": "double", "nullable": true, "type": "number" }, "reason": { "type": "string" }, "windowDays": { "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Firewall Geo Fences Preview", "tags": [ "Admin System" ] } }, "/api/admin/system/firewall/geo-fences/{id}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/firewall/geo-fences/{id}`.", "operationId": "delete__api__admin__system__firewall__geo_dash_fences___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System Firewall Geo Fences Id", "tags": [ "Admin System" ] }, "patch": { "description": "Auto-generated reference for `PATCH /api/admin/system/firewall/geo-fences/{id}`.", "operationId": "patch__api__admin__system__firewall__geo_dash_fences___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "enabled": { "type": "boolean" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "enabled": { "type": "boolean" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PATCH Api Admin System Firewall Geo Fences Id", "tags": [ "Admin System" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/system/firewall/geo-fences/{id}`.", "operationId": "put__api__admin__system__firewall__geo_dash_fences___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "appId": { "format": "int64", "nullable": true, "type": "integer" }, "banMode": { "type": "string" }, "centerLat": { "format": "double", "nullable": true, "type": "number" }, "centerLng": { "format": "double", "nullable": true, "type": "number" }, "enabled": { "nullable": true, "type": "boolean" }, "expiresAt": { "type": "string" }, "fence": {}, "mode": { "type": "string" }, "name": { "type": "string" }, "radiusM": { "format": "double", "nullable": true, "type": "number" }, "reason": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appId": { "format": "int64", "nullable": true, "type": "integer" }, "banMode": { "type": "string" }, "centerLat": { "format": "double", "nullable": true, "type": "number" }, "centerLng": { "format": "double", "nullable": true, "type": "number" }, "enabled": { "nullable": true, "type": "boolean" }, "expiresAt": { "type": "string" }, "fence": {}, "mode": { "type": "string" }, "name": { "type": "string" }, "radiusM": { "format": "double", "nullable": true, "type": "number" }, "reason": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin System Firewall Geo Fences Id", "tags": [ "Admin System" ] } }, "/api/admin/system/firewall/logs": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/firewall/logs`.", "operationId": "delete__api__admin__system__firewall__logs", "requestBody": { "content": { "application/json": { "schema": { "properties": { "before": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "before": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System Firewall Logs", "tags": [ "Admin System" ] }, "get": { "description": "Auto-generated reference for `GET /api/admin/system/firewall/logs`.", "operationId": "get__api__admin__system__firewall__logs", "parameters": [ { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "pageSize", "schema": { "type": "integer" } }, { "in": "query", "name": "startTime", "schema": { "type": "string" } }, { "in": "query", "name": "endTime", "schema": { "type": "string" } }, { "in": "query", "name": "ip", "schema": { "type": "string" } }, { "in": "query", "name": "country", "schema": { "type": "string" } }, { "in": "query", "name": "reason", "schema": { "type": "string" } }, { "in": "query", "name": "wafRuleId", "schema": { "type": "integer" } }, { "in": "query", "name": "pathPattern", "schema": { "type": "string" } }, { "in": "query", "name": "severity", "schema": { "type": "string" } }, { "in": "query", "name": "sortBy", "schema": { "type": "string" } }, { "in": "query", "name": "sortOrder", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Firewall Logs", "tags": [ "Admin System" ] } }, "/api/admin/system/firewall/logs/{logId}": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/firewall/logs/{logId}`.", "operationId": "get__api__admin__system__firewall__logs___by_logId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "logId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Firewall Logs LogId", "tags": [ "Admin System" ] } }, "/api/admin/system/firewall/stats": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/firewall/stats`.", "operationId": "get__api__admin__system__firewall__stats", "parameters": [ { "in": "query", "name": "startTime", "schema": { "type": "string" } }, { "in": "query", "name": "endTime", "schema": { "type": "string" } }, { "in": "query", "name": "granularity", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Firewall Stats", "tags": [ "Admin System" ] } }, "/api/admin/system/geo/clusters": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/geo/clusters`.", "operationId": "get__api__admin__system__geo__clusters", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Geo Clusters", "tags": [ "Admin System" ] } }, "/api/admin/system/geo/heatmap": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/geo/heatmap`.", "operationId": "get__api__admin__system__geo__heatmap", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Geo Heatmap", "tags": [ "Admin System" ] } }, "/api/admin/system/geo/trail": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/geo/trail`.", "operationId": "get__api__admin__system__geo__trail", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Geo Trail", "tags": [ "Admin System" ] } }, "/api/admin/system/ldap/test": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/ldap/test`.", "operationId": "post__api__admin__system__ldap__test", "requestBody": { "content": { "application/json": { "schema": { "properties": { "baseDN": { "type": "string" }, "bindDN": { "type": "string" }, "bindPassword": { "type": "string" }, "connectionTimeoutSeconds": { "type": "integer" }, "port": { "type": "integer" }, "server": { "type": "string" }, "skipTLSVerify": { "type": "boolean" }, "testAccount": { "type": "string" }, "useStartTLS": { "type": "boolean" }, "useTLS": { "type": "boolean" }, "userFilter": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "baseDN": { "type": "string" }, "bindDN": { "type": "string" }, "bindPassword": { "type": "string" }, "connectionTimeoutSeconds": { "type": "integer" }, "port": { "type": "integer" }, "server": { "type": "string" }, "skipTLSVerify": { "type": "boolean" }, "testAccount": { "type": "string" }, "useStartTLS": { "type": "boolean" }, "useTLS": { "type": "boolean" }, "userFilter": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Ldap Test", "tags": [ "Admin System" ] } }, "/api/admin/system/legal/documents": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/legal/documents`.", "operationId": "get__api__admin__system__legal__documents", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Legal Documents", "tags": [ "Admin System" ] } }, "/api/admin/system/legal/documents/{docType}/{locale}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/legal/documents/{docType}/{locale}`.", "operationId": "delete__api__admin__system__legal__documents___by_docType___by_locale", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "docType", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "locale", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System Legal Documents DocType Locale", "tags": [ "Admin System" ] }, "get": { "description": "Auto-generated reference for `GET /api/admin/system/legal/documents/{docType}/{locale}`.", "operationId": "get__api__admin__system__legal__documents___by_docType___by_locale", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "docType", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "locale", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Legal Documents DocType Locale", "tags": [ "Admin System" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/system/legal/documents/{docType}/{locale}`.", "operationId": "put__api__admin__system__legal__documents___by_docType___by_locale", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "docType", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "locale", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "body": { "type": "string" }, "effectiveAt": { "type": "string" }, "published": { "nullable": true, "type": "boolean" }, "title": { "type": "string" }, "version": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "body": { "type": "string" }, "effectiveAt": { "type": "string" }, "published": { "nullable": true, "type": "boolean" }, "title": { "type": "string" }, "version": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin System Legal Documents DocType Locale", "tags": [ "Admin System" ] } }, "/api/admin/system/legal/documents/{docType}/{locale}/preview": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/legal/documents/{docType}/{locale}/preview`.", "operationId": "post__api__admin__system__legal__documents___by_docType___by_locale__preview", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "docType", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "locale", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "body": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "body": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Legal Documents DocType Locale Preview", "tags": [ "Admin System" ] } }, "/api/admin/system/memory/cache": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/memory/cache`.", "operationId": "delete__api__admin__system__memory__cache", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System Memory Cache", "tags": [ "Admin System" ] }, "get": { "description": "Auto-generated reference for `GET /api/admin/system/memory/cache`.", "operationId": "get__api__admin__system__memory__cache", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Memory Cache", "tags": [ "Admin System" ] } }, "/api/admin/system/memory/gc": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/memory/gc`.", "operationId": "post__api__admin__system__memory__gc", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Memory Gc", "tags": [ "Admin System" ] } }, "/api/admin/system/memory/gogc": { "put": { "description": "Auto-generated reference for `PUT /api/admin/system/memory/gogc`.", "operationId": "put__api__admin__system__memory__gogc", "requestBody": { "content": { "application/json": { "schema": { "properties": { "value": { "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "value": { "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin System Memory Gogc", "tags": [ "Admin System" ] } }, "/api/admin/system/memory/history": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/memory/history`.", "operationId": "get__api__admin__system__memory__history", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Memory History", "tags": [ "Admin System" ] } }, "/api/admin/system/memory/leak": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/memory/leak`.", "operationId": "get__api__admin__system__memory__leak", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Memory Leak", "tags": [ "Admin System" ] } }, "/api/admin/system/memory/pools": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/memory/pools`.", "operationId": "get__api__admin__system__memory__pools", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Memory Pools", "tags": [ "Admin System" ] } }, "/api/admin/system/memory/snapshot": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/memory/snapshot`.", "operationId": "get__api__admin__system__memory__snapshot", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Memory Snapshot", "tags": [ "Admin System" ] } }, "/api/admin/system/oidc/test": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/oidc/test`.", "operationId": "post__api__admin__system__oidc__test", "requestBody": { "content": { "application/json": { "schema": { "properties": { "issuerURL": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "issuerURL": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Oidc Test", "tags": [ "Admin System" ] } }, "/api/admin/system/online/apps/{appkey}": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/online/apps/{appkey}`.", "operationId": "get__api__admin__system__online__apps___by_appkey", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Online Apps Appkey", "tags": [ "Admin System" ] } }, "/api/admin/system/online/apps/{appkey}/users": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/online/apps/{appkey}/users`.", "operationId": "get__api__admin__system__online__apps___by_appkey__users", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Online Apps Appkey Users", "tags": [ "Admin System" ] } }, "/api/admin/system/online/stats": { "get": { "description": "Returns the aggregated online status overview across applications.", "operationId": "get__api__admin__system__online__stats", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "Get Online Overview", "tags": [ "Admin System" ] } }, "/api/admin/system/org-approvals/pending": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/org-approvals/pending`.", "operationId": "get__api__admin__system__org_dash_approvals__pending", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Org Approvals Pending", "tags": [ "Admin System" ] } }, "/api/admin/system/org-approvals/{instanceId}/decision": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/org-approvals/{instanceId}/decision`.", "operationId": "post__api__admin__system__org_dash_approvals___by_instanceId__decision", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "instanceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "action": { "type": "string" }, "comment": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "action": { "type": "string" }, "comment": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Org Approvals InstanceId Decision", "tags": [ "Admin System" ] } }, "/api/admin/system/org-invitations": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/org-invitations`.", "operationId": "get__api__admin__system__org_dash_invitations", "parameters": [ { "in": "query", "name": "role", "schema": { "type": "string" } }, { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "orgId", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Org Invitations", "tags": [ "Admin System" ] } }, "/api/admin/system/org-invitations/count": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/org-invitations/count`.", "operationId": "get__api__admin__system__org_dash_invitations__count", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Org Invitations Count", "tags": [ "Admin System" ] } }, "/api/admin/system/org-invitations/{inviteId}/{action}": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/org-invitations/{inviteId}/{action}`.", "operationId": "post__api__admin__system__org_dash_invitations___by_inviteId___by_action", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "inviteId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "action", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Org Invitations InviteId Action", "tags": [ "Admin System" ] } }, "/api/admin/system/org-metadata": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/org-metadata`.", "operationId": "get__api__admin__system__org_dash_metadata", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Org Metadata", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/organizations`.", "operationId": "get__api__admin__system__organizations", "parameters": [ { "in": "query", "name": "keyword", "schema": { "type": "string" } }, { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "kind", "schema": { "type": "string" } }, { "in": "query", "name": "parentId", "schema": { "type": "string" } }, { "in": "query", "name": "onlyMine", "schema": { "type": "boolean" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Organizations", "tags": [ "Admin System" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/system/organizations`.", "operationId": "post__api__admin__system__organizations", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appLimit": { "type": "integer" }, "code": { "type": "string" }, "contactEmail": { "type": "string" }, "contactName": { "type": "string" }, "contactPhone": { "type": "string" }, "deptLimit": { "type": "integer" }, "description": { "type": "string" }, "expiresAt": { "type": "string" }, "industry": { "type": "string" }, "kind": { "type": "string" }, "logoURL": { "type": "string" }, "memberLimit": { "type": "integer" }, "name": { "type": "string" }, "ownerAdminId": { "format": "int64", "type": "integer" }, "parentId": { "type": "string" }, "region": { "type": "string" }, "settings": { "additionalProperties": {}, "type": "object" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appLimit": { "type": "integer" }, "code": { "type": "string" }, "contactEmail": { "type": "string" }, "contactName": { "type": "string" }, "contactPhone": { "type": "string" }, "deptLimit": { "type": "integer" }, "description": { "type": "string" }, "expiresAt": { "type": "string" }, "industry": { "type": "string" }, "kind": { "type": "string" }, "logoURL": { "type": "string" }, "memberLimit": { "type": "integer" }, "name": { "type": "string" }, "ownerAdminId": { "format": "int64", "type": "integer" }, "parentId": { "type": "string" }, "region": { "type": "string" }, "settings": { "additionalProperties": {}, "type": "object" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Organizations", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/tree": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/organizations/tree`.", "operationId": "get__api__admin__system__organizations__tree", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Organizations Tree", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/organizations/{orgId}`.", "operationId": "delete__api__admin__system__organizations___by_orgId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System Organizations OrgId", "tags": [ "Admin System" ] }, "get": { "description": "Auto-generated reference for `GET /api/admin/system/organizations/{orgId}`.", "operationId": "get__api__admin__system__organizations___by_orgId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Organizations OrgId", "tags": [ "Admin System" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/system/organizations/{orgId}`.", "operationId": "put__api__admin__system__organizations___by_orgId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "appLimit": { "nullable": true, "type": "integer" }, "clearExpiry": { "type": "boolean" }, "code": { "nullable": true, "type": "string" }, "contactEmail": { "nullable": true, "type": "string" }, "contactName": { "nullable": true, "type": "string" }, "contactPhone": { "nullable": true, "type": "string" }, "deptLimit": { "nullable": true, "type": "integer" }, "description": { "nullable": true, "type": "string" }, "expiresAt": { "nullable": true, "type": "string" }, "industry": { "nullable": true, "type": "string" }, "kind": { "nullable": true, "type": "string" }, "logoURL": { "nullable": true, "type": "string" }, "memberLimit": { "nullable": true, "type": "integer" }, "name": { "nullable": true, "type": "string" }, "region": { "nullable": true, "type": "string" }, "settings": { "additionalProperties": {}, "type": "object" }, "status": { "nullable": true, "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appLimit": { "nullable": true, "type": "integer" }, "clearExpiry": { "type": "boolean" }, "code": { "nullable": true, "type": "string" }, "contactEmail": { "nullable": true, "type": "string" }, "contactName": { "nullable": true, "type": "string" }, "contactPhone": { "nullable": true, "type": "string" }, "deptLimit": { "nullable": true, "type": "integer" }, "description": { "nullable": true, "type": "string" }, "expiresAt": { "nullable": true, "type": "string" }, "industry": { "nullable": true, "type": "string" }, "kind": { "nullable": true, "type": "string" }, "logoURL": { "nullable": true, "type": "string" }, "memberLimit": { "nullable": true, "type": "integer" }, "name": { "nullable": true, "type": "string" }, "region": { "nullable": true, "type": "string" }, "settings": { "additionalProperties": {}, "type": "object" }, "status": { "nullable": true, "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin System Organizations OrgId", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}/activity": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/organizations/{orgId}/activity`.", "operationId": "get__api__admin__system__organizations___by_orgId__activity", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Organizations OrgId Activity", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}/approval-chains": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/organizations/{orgId}/approval-chains`.", "operationId": "get__api__admin__system__organizations___by_orgId__approval_dash_chains", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Organizations OrgId Approval Chains", "tags": [ "Admin System" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/system/organizations/{orgId}/approval-chains`.", "operationId": "post__api__admin__system__organizations___by_orgId__approval_dash_chains", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "isActive": { "nullable": true, "type": "boolean" }, "name": { "type": "string" }, "steps": { "items": { "properties": { "approverId": { "format": "int64", "type": "integer" }, "approverRole": { "type": "string" }, "approverType": { "type": "string" }, "name": { "type": "string" }, "order": { "type": "integer" } }, "type": "object" }, "type": "array" }, "triggerType": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "isActive": { "nullable": true, "type": "boolean" }, "name": { "type": "string" }, "steps": { "items": { "properties": { "approverId": { "format": "int64", "type": "integer" }, "approverRole": { "type": "string" }, "approverType": { "type": "string" }, "name": { "type": "string" }, "order": { "type": "integer" } }, "type": "object" }, "type": "array" }, "triggerType": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Organizations OrgId Approval Chains", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}/approval-chains/{chainId}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/organizations/{orgId}/approval-chains/{chainId}`.", "operationId": "delete__api__admin__system__organizations___by_orgId__approval_dash_chains___by_chainId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "chainId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System Organizations OrgId Approval Chains ChainId", "tags": [ "Admin System" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/system/organizations/{orgId}/approval-chains/{chainId}`.", "operationId": "put__api__admin__system__organizations___by_orgId__approval_dash_chains___by_chainId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "chainId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "isActive": { "nullable": true, "type": "boolean" }, "name": { "nullable": true, "type": "string" }, "steps": { "items": { "properties": { "approverId": { "format": "int64", "type": "integer" }, "approverRole": { "type": "string" }, "approverType": { "type": "string" }, "name": { "type": "string" }, "order": { "type": "integer" } }, "type": "object" }, "nullable": true, "type": "array" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "isActive": { "nullable": true, "type": "boolean" }, "name": { "nullable": true, "type": "string" }, "steps": { "items": { "properties": { "approverId": { "format": "int64", "type": "integer" }, "approverRole": { "type": "string" }, "approverType": { "type": "string" }, "name": { "type": "string" }, "order": { "type": "integer" } }, "type": "object" }, "nullable": true, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin System Organizations OrgId Approval Chains ChainId", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}/approvals": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/organizations/{orgId}/approvals`.", "operationId": "get__api__admin__system__organizations___by_orgId__approvals", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Organizations OrgId Approvals", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}/approvals/{instanceId}": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/organizations/{orgId}/approvals/{instanceId}`.", "operationId": "get__api__admin__system__organizations___by_orgId__approvals___by_instanceId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "instanceId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Organizations OrgId Approvals InstanceId", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}/apps": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/organizations/{orgId}/apps`.", "operationId": "get__api__admin__system__organizations___by_orgId__apps", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Organizations OrgId Apps", "tags": [ "Admin System" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/system/organizations/{orgId}/apps`.", "operationId": "post__api__admin__system__organizations___by_orgId__apps", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "appId": { "format": "int64", "type": "integer" }, "owned": { "type": "boolean" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appId": { "format": "int64", "type": "integer" }, "owned": { "type": "boolean" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Organizations OrgId Apps", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}/apps/{appId}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/organizations/{orgId}/apps/{appId}`.", "operationId": "delete__api__admin__system__organizations___by_orgId__apps___by_appId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "appId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System Organizations OrgId Apps AppId", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}/assignable-admins": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/organizations/{orgId}/assignable-admins`.", "operationId": "get__api__admin__system__organizations___by_orgId__assignable_dash_admins", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Organizations OrgId Assignable Admins", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}/collab-groups": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/organizations/{orgId}/collab-groups`.", "operationId": "get__api__admin__system__organizations___by_orgId__collab_dash_groups", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Organizations OrgId Collab Groups", "tags": [ "Admin System" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/system/organizations/{orgId}/collab-groups`.", "operationId": "post__api__admin__system__organizations___by_orgId__collab_dash_groups", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "deptIds": { "items": { "type": "string" }, "type": "array" }, "description": { "type": "string" }, "name": { "type": "string" }, "permissions": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "deptIds": { "items": { "type": "string" }, "type": "array" }, "description": { "type": "string" }, "name": { "type": "string" }, "permissions": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Organizations OrgId Collab Groups", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}/collab-groups/{groupId}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/organizations/{orgId}/collab-groups/{groupId}`.", "operationId": "delete__api__admin__system__organizations___by_orgId__collab_dash_groups___by_groupId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "groupId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System Organizations OrgId Collab Groups GroupId", "tags": [ "Admin System" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/system/organizations/{orgId}/collab-groups/{groupId}`.", "operationId": "put__api__admin__system__organizations___by_orgId__collab_dash_groups___by_groupId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "groupId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "deptIds": { "items": { "type": "string" }, "type": "array" }, "description": { "type": "string" }, "name": { "type": "string" }, "permissions": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "deptIds": { "items": { "type": "string" }, "type": "array" }, "description": { "type": "string" }, "name": { "type": "string" }, "permissions": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin System Organizations OrgId Collab Groups GroupId", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}/departments": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/organizations/{orgId}/departments`.", "operationId": "get__api__admin__system__organizations___by_orgId__departments", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Organizations OrgId Departments", "tags": [ "Admin System" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/system/organizations/{orgId}/departments`.", "operationId": "post__api__admin__system__organizations___by_orgId__departments", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "description": { "type": "string" }, "kind": { "type": "string" }, "leaderId": { "format": "int64", "type": "integer" }, "memberLimit": { "type": "integer" }, "name": { "type": "string" }, "parentId": { "type": "string" }, "settings": { "additionalProperties": {}, "type": "object" }, "sortOrder": { "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "code": { "type": "string" }, "description": { "type": "string" }, "kind": { "type": "string" }, "leaderId": { "format": "int64", "type": "integer" }, "memberLimit": { "type": "integer" }, "name": { "type": "string" }, "parentId": { "type": "string" }, "settings": { "additionalProperties": {}, "type": "object" }, "sortOrder": { "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Organizations OrgId Departments", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}/departments/{deptId}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/organizations/{orgId}/departments/{deptId}`.", "operationId": "delete__api__admin__system__organizations___by_orgId__departments___by_deptId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "deptId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System Organizations OrgId Departments DeptId", "tags": [ "Admin System" ] }, "get": { "description": "Auto-generated reference for `GET /api/admin/system/organizations/{orgId}/departments/{deptId}`.", "operationId": "get__api__admin__system__organizations___by_orgId__departments___by_deptId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "deptId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Organizations OrgId Departments DeptId", "tags": [ "Admin System" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/system/organizations/{orgId}/departments/{deptId}`.", "operationId": "put__api__admin__system__organizations___by_orgId__departments___by_deptId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "deptId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "clearLeader": { "type": "boolean" }, "code": { "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "kind": { "nullable": true, "type": "string" }, "leaderId": { "format": "int64", "nullable": true, "type": "integer" }, "memberLimit": { "nullable": true, "type": "integer" }, "name": { "nullable": true, "type": "string" }, "settings": { "additionalProperties": {}, "type": "object" }, "sortOrder": { "nullable": true, "type": "integer" }, "status": { "nullable": true, "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "clearLeader": { "type": "boolean" }, "code": { "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "kind": { "nullable": true, "type": "string" }, "leaderId": { "format": "int64", "nullable": true, "type": "integer" }, "memberLimit": { "nullable": true, "type": "integer" }, "name": { "nullable": true, "type": "string" }, "settings": { "additionalProperties": {}, "type": "object" }, "sortOrder": { "nullable": true, "type": "integer" }, "status": { "nullable": true, "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin System Organizations OrgId Departments DeptId", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}/departments/{deptId}/members": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/organizations/{orgId}/departments/{deptId}/members`.", "operationId": "get__api__admin__system__organizations___by_orgId__departments___by_deptId__members", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "deptId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Organizations OrgId Departments DeptId Members", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}/departments/{deptId}/members/{adminId}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/organizations/{orgId}/departments/{deptId}/members/{adminId}`.", "operationId": "delete__api__admin__system__organizations___by_orgId__departments___by_deptId__members___by_adminId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "deptId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "adminId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System Organizations OrgId Departments DeptId Members AdminId", "tags": [ "Admin System" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/system/organizations/{orgId}/departments/{deptId}/members/{adminId}`.", "operationId": "put__api__admin__system__organizations___by_orgId__departments___by_deptId__members___by_adminId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "deptId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "adminId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "clearDelegate": { "type": "boolean" }, "clearReporting": { "type": "boolean" }, "delegateExpiresAt": { "nullable": true, "type": "string" }, "delegateTo": { "format": "int64", "nullable": true, "type": "integer" }, "isLeader": { "nullable": true, "type": "boolean" }, "jobTitle": { "nullable": true, "type": "string" }, "positionId": { "nullable": true, "type": "string" }, "reportingTo": { "format": "int64", "nullable": true, "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "clearDelegate": { "type": "boolean" }, "clearReporting": { "type": "boolean" }, "delegateExpiresAt": { "nullable": true, "type": "string" }, "delegateTo": { "format": "int64", "nullable": true, "type": "integer" }, "isLeader": { "nullable": true, "type": "boolean" }, "jobTitle": { "nullable": true, "type": "string" }, "positionId": { "nullable": true, "type": "string" }, "reportingTo": { "format": "int64", "nullable": true, "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin System Organizations OrgId Departments DeptId Members AdminId", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}/departments/{deptId}/members/{adminId}/reporting-chain": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/organizations/{orgId}/departments/{deptId}/members/{adminId}/reporting-chain`.", "operationId": "get__api__admin__system__organizations___by_orgId__departments___by_deptId__members___by_adminId__reporting_dash_chain", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "deptId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "adminId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Organizations OrgId Departments DeptId Members AdminId Reporting Chain", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}/departments/{deptId}/members/{adminId}/reports": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/organizations/{orgId}/departments/{deptId}/members/{adminId}/reports`.", "operationId": "get__api__admin__system__organizations___by_orgId__departments___by_deptId__members___by_adminId__reports", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "deptId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "adminId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Organizations OrgId Departments DeptId Members AdminId Reports", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}/departments/{deptId}/move": { "put": { "description": "Auto-generated reference for `PUT /api/admin/system/organizations/{orgId}/departments/{deptId}/move`.", "operationId": "put__api__admin__system__organizations___by_orgId__departments___by_deptId__move", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "deptId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "parentId": { "type": "string" }, "sortOrder": { "nullable": true, "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "parentId": { "type": "string" }, "sortOrder": { "nullable": true, "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin System Organizations OrgId Departments DeptId Move", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}/dept-order": { "put": { "description": "Auto-generated reference for `PUT /api/admin/system/organizations/{orgId}/dept-order`.", "operationId": "put__api__admin__system__organizations___by_orgId__dept_dash_order", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "order": { "additionalProperties": { "type": "integer" }, "type": "object" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "order": { "additionalProperties": { "type": "integer" }, "type": "object" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin System Organizations OrgId Dept Order", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}/export": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/organizations/{orgId}/export`.", "operationId": "get__api__admin__system__organizations___by_orgId__export", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Organizations OrgId Export", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}/import": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/organizations/{orgId}/import`.", "operationId": "post__api__admin__system__organizations___by_orgId__import", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Organizations OrgId Import", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}/import-template": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/organizations/{orgId}/import-template`.", "operationId": "get__api__admin__system__organizations___by_orgId__import_dash_template", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Organizations OrgId Import Template", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}/invitations": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/organizations/{orgId}/invitations`.", "operationId": "post__api__admin__system__organizations___by_orgId__invitations", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "adminIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "deptId": { "type": "string" }, "isLeader": { "type": "boolean" }, "message": { "type": "string" }, "orgRole": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "adminIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "deptId": { "type": "string" }, "isLeader": { "type": "boolean" }, "message": { "type": "string" }, "orgRole": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Organizations OrgId Invitations", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}/members": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/organizations/{orgId}/members`.", "operationId": "get__api__admin__system__organizations___by_orgId__members", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "keyword", "schema": { "type": "string" } }, { "in": "query", "name": "orgRole", "schema": { "type": "string" } }, { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "deptId", "schema": { "type": "string" } }, { "in": "query", "name": "includeSubDepts", "schema": { "type": "boolean" } }, { "in": "query", "name": "unassigned", "schema": { "type": "boolean" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Organizations OrgId Members", "tags": [ "Admin System" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/system/organizations/{orgId}/members`.", "operationId": "post__api__admin__system__organizations___by_orgId__members", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "adminId": { "format": "int64", "type": "integer" }, "deptIds": { "items": { "type": "string" }, "type": "array" }, "employeeNo": { "type": "string" }, "orgRole": { "type": "string" }, "primaryDeptId": { "type": "string" }, "title": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "adminId": { "format": "int64", "type": "integer" }, "deptIds": { "items": { "type": "string" }, "type": "array" }, "employeeNo": { "type": "string" }, "orgRole": { "type": "string" }, "primaryDeptId": { "type": "string" }, "title": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Organizations OrgId Members", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}/members/{adminId}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/organizations/{orgId}/members/{adminId}`.", "operationId": "delete__api__admin__system__organizations___by_orgId__members___by_adminId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "adminId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System Organizations OrgId Members AdminId", "tags": [ "Admin System" ] }, "get": { "description": "Auto-generated reference for `GET /api/admin/system/organizations/{orgId}/members/{adminId}`.", "operationId": "get__api__admin__system__organizations___by_orgId__members___by_adminId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "adminId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Organizations OrgId Members AdminId", "tags": [ "Admin System" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/system/organizations/{orgId}/members/{adminId}`.", "operationId": "put__api__admin__system__organizations___by_orgId__members___by_adminId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "adminId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "employeeNo": { "nullable": true, "type": "string" }, "orgRole": { "nullable": true, "type": "string" }, "primaryDeptId": { "nullable": true, "type": "string" }, "status": { "nullable": true, "type": "string" }, "title": { "nullable": true, "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "employeeNo": { "nullable": true, "type": "string" }, "orgRole": { "nullable": true, "type": "string" }, "primaryDeptId": { "nullable": true, "type": "string" }, "status": { "nullable": true, "type": "string" }, "title": { "nullable": true, "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin System Organizations OrgId Members AdminId", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}/members/{adminId}/departments": { "put": { "description": "Auto-generated reference for `PUT /api/admin/system/organizations/{orgId}/members/{adminId}/departments`.", "operationId": "put__api__admin__system__organizations___by_orgId__members___by_adminId__departments", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "adminId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "deptIds": { "items": { "type": "string" }, "type": "array" }, "primaryDeptId": { "type": "string" }, "replace": { "type": "boolean" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "deptIds": { "items": { "type": "string" }, "type": "array" }, "primaryDeptId": { "type": "string" }, "replace": { "type": "boolean" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin System Organizations OrgId Members AdminId Departments", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}/overview": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/organizations/{orgId}/overview`.", "operationId": "get__api__admin__system__organizations___by_orgId__overview", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Organizations OrgId Overview", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}/perm-templates": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/organizations/{orgId}/perm-templates`.", "operationId": "get__api__admin__system__organizations___by_orgId__perm_dash_templates", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Organizations OrgId Perm Templates", "tags": [ "Admin System" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/system/organizations/{orgId}/perm-templates`.", "operationId": "post__api__admin__system__organizations___by_orgId__perm_dash_templates", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "description": { "type": "string" }, "isDefault": { "type": "boolean" }, "name": { "type": "string" }, "permissions": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "description": { "type": "string" }, "isDefault": { "type": "boolean" }, "name": { "type": "string" }, "permissions": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Organizations OrgId Perm Templates", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}/perm-templates/{templateId}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/organizations/{orgId}/perm-templates/{templateId}`.", "operationId": "delete__api__admin__system__organizations___by_orgId__perm_dash_templates___by_templateId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "templateId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System Organizations OrgId Perm Templates TemplateId", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}/perm-templates/{templateId}/apply": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/organizations/{orgId}/perm-templates/{templateId}/apply`.", "operationId": "post__api__admin__system__organizations___by_orgId__perm_dash_templates___by_templateId__apply", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "templateId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "adminIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "roleName": { "type": "string" }, "scopeDeptId": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "adminIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "roleName": { "type": "string" }, "scopeDeptId": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Organizations OrgId Perm Templates TemplateId Apply", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}/positions": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/organizations/{orgId}/positions`.", "operationId": "get__api__admin__system__organizations___by_orgId__positions", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Organizations OrgId Positions", "tags": [ "Admin System" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/system/organizations/{orgId}/positions`.", "operationId": "post__api__admin__system__organizations___by_orgId__positions", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "description": { "type": "string" }, "level": { "type": "integer" }, "name": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "code": { "type": "string" }, "description": { "type": "string" }, "level": { "type": "integer" }, "name": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Organizations OrgId Positions", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}/positions/{posId}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/organizations/{orgId}/positions/{posId}`.", "operationId": "delete__api__admin__system__organizations___by_orgId__positions___by_posId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "posId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System Organizations OrgId Positions PosId", "tags": [ "Admin System" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/system/organizations/{orgId}/positions/{posId}`.", "operationId": "put__api__admin__system__organizations___by_orgId__positions___by_posId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "posId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "description": { "type": "string" }, "level": { "type": "integer" }, "name": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "code": { "type": "string" }, "description": { "type": "string" }, "level": { "type": "integer" }, "name": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin System Organizations OrgId Positions PosId", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}/roles": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/organizations/{orgId}/roles`.", "operationId": "get__api__admin__system__organizations___by_orgId__roles", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Organizations OrgId Roles", "tags": [ "Admin System" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/system/organizations/{orgId}/roles`.", "operationId": "post__api__admin__system__organizations___by_orgId__roles", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "permissions": { "items": { "type": "string" }, "type": "array" }, "roleKey": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "permissions": { "items": { "type": "string" }, "type": "array" }, "roleKey": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Organizations OrgId Roles", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}/roles/{roleId}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/organizations/{orgId}/roles/{roleId}`.", "operationId": "delete__api__admin__system__organizations___by_orgId__roles___by_roleId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "roleId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System Organizations OrgId Roles RoleId", "tags": [ "Admin System" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/system/organizations/{orgId}/roles/{roleId}`.", "operationId": "put__api__admin__system__organizations___by_orgId__roles___by_roleId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "roleId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "permissions": { "items": { "type": "string" }, "type": "array" }, "roleKey": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "permissions": { "items": { "type": "string" }, "type": "array" }, "roleKey": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin System Organizations OrgId Roles RoleId", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}/roles/{roleId}/grants": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/organizations/{orgId}/roles/{roleId}/grants`.", "operationId": "get__api__admin__system__organizations___by_orgId__roles___by_roleId__grants", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "roleId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Organizations OrgId Roles RoleId Grants", "tags": [ "Admin System" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/system/organizations/{orgId}/roles/{roleId}/grants`.", "operationId": "post__api__admin__system__organizations___by_orgId__roles___by_roleId__grants", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "roleId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "adminIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "scopeDeptId": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "adminIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "scopeDeptId": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Organizations OrgId Roles RoleId Grants", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}/roles/{roleId}/grants/{adminId}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/organizations/{orgId}/roles/{roleId}/grants/{adminId}`.", "operationId": "delete__api__admin__system__organizations___by_orgId__roles___by_roleId__grants___by_adminId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "roleId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "adminId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System Organizations OrgId Roles RoleId Grants AdminId", "tags": [ "Admin System" ] } }, "/api/admin/system/organizations/{orgId}/transfer": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/organizations/{orgId}/transfer`.", "operationId": "post__api__admin__system__organizations___by_orgId__transfer", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orgId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "newOwnerAdminId": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "newOwnerAdminId": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Organizations OrgId Transfer", "tags": [ "Admin System" ] } }, "/api/admin/system/plugins": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/plugins`.", "operationId": "get__api__admin__system__plugins", "parameters": [ { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "type", "schema": { "type": "string" } }, { "in": "query", "name": "keyword", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Plugins", "tags": [ "Admin System" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/system/plugins`.", "operationId": "post__api__admin__system__plugins", "requestBody": { "content": { "application/json": { "schema": { "properties": { "config": { "additionalProperties": {}, "type": "object" }, "description": { "type": "string" }, "displayName": { "type": "string" }, "exprScript": { "type": "string" }, "hooks": { "items": { "properties": { "hookName": { "type": "string" }, "phase": { "type": "string" }, "priority": { "type": "integer" } }, "type": "object" }, "type": "array" }, "name": { "type": "string" }, "priority": { "type": "integer" }, "type": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "config": { "additionalProperties": {}, "type": "object" }, "description": { "type": "string" }, "displayName": { "type": "string" }, "exprScript": { "type": "string" }, "hooks": { "items": { "properties": { "hookName": { "type": "string" }, "phase": { "type": "string" }, "priority": { "type": "integer" } }, "type": "object" }, "type": "array" }, "name": { "type": "string" }, "priority": { "type": "integer" }, "type": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Plugins", "tags": [ "Admin System" ] } }, "/api/admin/system/plugins/executions": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/plugins/executions`.", "operationId": "get__api__admin__system__plugins__executions", "parameters": [ { "in": "query", "name": "pluginId", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "hookName", "schema": { "type": "string" } }, { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Plugins Executions", "tags": [ "Admin System" ] } }, "/api/admin/system/plugins/registry": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/plugins/registry`.", "operationId": "get__api__admin__system__plugins__registry", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Plugins Registry", "tags": [ "Admin System" ] } }, "/api/admin/system/plugins/{id}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/plugins/{id}`.", "operationId": "delete__api__admin__system__plugins___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System Plugins Id", "tags": [ "Admin System" ] }, "get": { "description": "Auto-generated reference for `GET /api/admin/system/plugins/{id}`.", "operationId": "get__api__admin__system__plugins___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Plugins Id", "tags": [ "Admin System" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/system/plugins/{id}`.", "operationId": "put__api__admin__system__plugins___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "config": { "additionalProperties": {}, "type": "object" }, "description": { "nullable": true, "type": "string" }, "displayName": { "nullable": true, "type": "string" }, "exprScript": { "nullable": true, "type": "string" }, "hooks": { "items": { "properties": { "hookName": { "type": "string" }, "phase": { "type": "string" }, "priority": { "type": "integer" } }, "type": "object" }, "type": "array" }, "priority": { "nullable": true, "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "config": { "additionalProperties": {}, "type": "object" }, "description": { "nullable": true, "type": "string" }, "displayName": { "nullable": true, "type": "string" }, "exprScript": { "nullable": true, "type": "string" }, "hooks": { "items": { "properties": { "hookName": { "type": "string" }, "phase": { "type": "string" }, "priority": { "type": "integer" } }, "type": "object" }, "type": "array" }, "priority": { "nullable": true, "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin System Plugins Id", "tags": [ "Admin System" ] } }, "/api/admin/system/plugins/{id}/disable": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/plugins/{id}/disable`.", "operationId": "post__api__admin__system__plugins___by_id__disable", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Plugins Id Disable", "tags": [ "Admin System" ] } }, "/api/admin/system/plugins/{id}/enable": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/plugins/{id}/enable`.", "operationId": "post__api__admin__system__plugins___by_id__enable", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Plugins Id Enable", "tags": [ "Admin System" ] } }, "/api/admin/system/risk/actions": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/risk/actions`.", "operationId": "get__api__admin__system__risk__actions", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Risk Actions", "tags": [ "Admin System" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/system/risk/actions`.", "operationId": "post__api__admin__system__risk__actions", "requestBody": { "content": { "application/json": { "schema": { "properties": { "action": { "type": "string" }, "banDuration": { "type": "integer" }, "description": { "type": "string" }, "maxScore": { "nullable": true, "type": "integer" }, "minScore": { "type": "integer" }, "scene": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "action": { "type": "string" }, "banDuration": { "type": "integer" }, "description": { "type": "string" }, "maxScore": { "nullable": true, "type": "integer" }, "minScore": { "type": "integer" }, "scene": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Risk Actions", "tags": [ "Admin System" ] } }, "/api/admin/system/risk/actions/{id}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/risk/actions/{id}`.", "operationId": "delete__api__admin__system__risk__actions___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System Risk Actions Id", "tags": [ "Admin System" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/system/risk/actions/{id}`.", "operationId": "put__api__admin__system__risk__actions___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "action": { "nullable": true, "type": "string" }, "banDuration": { "nullable": true, "type": "integer" }, "description": { "nullable": true, "type": "string" }, "isActive": { "nullable": true, "type": "boolean" }, "maxScore": { "nullable": true, "type": "integer" }, "minScore": { "nullable": true, "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "action": { "nullable": true, "type": "string" }, "banDuration": { "nullable": true, "type": "integer" }, "description": { "nullable": true, "type": "string" }, "isActive": { "nullable": true, "type": "boolean" }, "maxScore": { "nullable": true, "type": "integer" }, "minScore": { "nullable": true, "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin System Risk Actions Id", "tags": [ "Admin System" ] } }, "/api/admin/system/risk/assessments": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/risk/assessments`.", "operationId": "delete__api__admin__system__risk__assessments", "requestBody": { "content": { "application/json": { "schema": { "properties": { "days": { "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "days": { "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System Risk Assessments", "tags": [ "Admin System" ] }, "get": { "description": "Auto-generated reference for `GET /api/admin/system/risk/assessments`.", "operationId": "get__api__admin__system__risk__assessments", "parameters": [ { "in": "query", "name": "scene", "schema": { "type": "string" } }, { "in": "query", "name": "riskLevel", "schema": { "type": "string" } }, { "in": "query", "name": "action", "schema": { "type": "string" } }, { "in": "query", "name": "ip", "schema": { "type": "string" } }, { "in": "query", "name": "deviceId", "schema": { "type": "string" } }, { "in": "query", "name": "account", "schema": { "type": "string" } }, { "in": "query", "name": "keyword", "schema": { "type": "string" } }, { "in": "query", "name": "ruleId", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "reviewed", "schema": { "type": "string" } }, { "in": "query", "name": "minScore", "schema": { "type": "integer" } }, { "in": "query", "name": "maxScore", "schema": { "type": "integer" } }, { "in": "query", "name": "start", "schema": { "type": "string" } }, { "in": "query", "name": "end", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "pageSize", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Risk Assessments", "tags": [ "Admin System" ] } }, "/api/admin/system/risk/assessments/{id}": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/risk/assessments/{id}`.", "operationId": "get__api__admin__system__risk__assessments___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Risk Assessments Id", "tags": [ "Admin System" ] } }, "/api/admin/system/risk/assessments/{id}/replay": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/risk/assessments/{id}/replay`.", "operationId": "post__api__admin__system__risk__assessments___by_id__replay", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Risk Assessments Id Replay", "tags": [ "Admin System" ] } }, "/api/admin/system/risk/assessments/{id}/review": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/risk/assessments/{id}/review`.", "operationId": "post__api__admin__system__risk__assessments___by_id__review", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "comment": { "type": "string" }, "result": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "comment": { "type": "string" }, "result": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Risk Assessments Id Review", "tags": [ "Admin System" ] } }, "/api/admin/system/risk/dashboard": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/risk/dashboard`.", "operationId": "get__api__admin__system__risk__dashboard", "parameters": [ { "in": "query", "name": "start", "schema": { "type": "string" } }, { "in": "query", "name": "end", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Risk Dashboard", "tags": [ "Admin System" ] } }, "/api/admin/system/risk/devices": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/risk/devices`.", "operationId": "get__api__admin__system__risk__devices", "parameters": [ { "in": "query", "name": "keyword", "schema": { "type": "string" } }, { "in": "query", "name": "tag", "schema": { "type": "string" } }, { "in": "query", "name": "onlyRisk", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "pageSize", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Risk Devices", "tags": [ "Admin System" ] } }, "/api/admin/system/risk/devices/suspicious": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/risk/devices/suspicious`.", "operationId": "get__api__admin__system__risk__devices__suspicious", "parameters": [ { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "pageSize", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Risk Devices Suspicious", "tags": [ "Admin System" ] } }, "/api/admin/system/risk/devices/{deviceId}": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/risk/devices/{deviceId}`.", "operationId": "get__api__admin__system__risk__devices___by_deviceId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "deviceId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Risk Devices DeviceId", "tags": [ "Admin System" ] } }, "/api/admin/system/risk/devices/{id}/tag": { "put": { "description": "Auto-generated reference for `PUT /api/admin/system/risk/devices/{id}/tag`.", "operationId": "put__api__admin__system__risk__devices___by_id__tag", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "note": { "type": "string" }, "tag": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "note": { "type": "string" }, "tag": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin System Risk Devices Id Tag", "tags": [ "Admin System" ] } }, "/api/admin/system/risk/evaluate": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/risk/evaluate`.", "operationId": "post__api__admin__system__risk__evaluate", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appId": { "format": "int64", "nullable": true, "type": "integer" }, "deviceId": { "type": "string" }, "extra": { "additionalProperties": {}, "type": "object" }, "ip": { "type": "string" }, "scene": { "type": "string" }, "userAgent": { "type": "string" }, "userId": { "format": "int64", "nullable": true, "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appId": { "format": "int64", "nullable": true, "type": "integer" }, "deviceId": { "type": "string" }, "extra": { "additionalProperties": {}, "type": "object" }, "ip": { "type": "string" }, "scene": { "type": "string" }, "userAgent": { "type": "string" }, "userId": { "format": "int64", "nullable": true, "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Risk Evaluate", "tags": [ "Admin System" ] } }, "/api/admin/system/risk/expression/validate": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/risk/expression/validate`.", "operationId": "post__api__admin__system__risk__expression__validate", "requestBody": { "content": { "application/json": { "schema": { "properties": { "expression": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "expression": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Risk Expression Validate", "tags": [ "Admin System" ] } }, "/api/admin/system/risk/ips": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/risk/ips`.", "operationId": "get__api__admin__system__risk__ips", "parameters": [ { "in": "query", "name": "keyword", "schema": { "type": "string" } }, { "in": "query", "name": "tag", "schema": { "type": "string" } }, { "in": "query", "name": "onlyRisk", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "pageSize", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Risk Ips", "tags": [ "Admin System" ] } }, "/api/admin/system/risk/ips/{id}/tag": { "put": { "description": "Auto-generated reference for `PUT /api/admin/system/risk/ips/{id}/tag`.", "operationId": "put__api__admin__system__risk__ips___by_id__tag", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "note": { "type": "string" }, "tag": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "note": { "type": "string" }, "tag": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin System Risk Ips Id Tag", "tags": [ "Admin System" ] } }, "/api/admin/system/risk/ips/{ip}": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/risk/ips/{ip}`.", "operationId": "get__api__admin__system__risk__ips___by_ip", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "ip", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Risk Ips Ip", "tags": [ "Admin System" ] } }, "/api/admin/system/risk/ips/{ip}/refresh": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/risk/ips/{ip}/refresh`.", "operationId": "post__api__admin__system__risk__ips___by_ip__refresh", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "ip", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Risk Ips Ip Refresh", "tags": [ "Admin System" ] } }, "/api/admin/system/risk/metadata": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/risk/metadata`.", "operationId": "get__api__admin__system__risk__metadata", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Risk Metadata", "tags": [ "Admin System" ] } }, "/api/admin/system/risk/reviews/pending": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/risk/reviews/pending`.", "operationId": "get__api__admin__system__risk__reviews__pending", "parameters": [ { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "pageSize", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Risk Reviews Pending", "tags": [ "Admin System" ] } }, "/api/admin/system/risk/rules": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/risk/rules`.", "operationId": "get__api__admin__system__risk__rules", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Risk Rules", "tags": [ "Admin System" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/system/risk/rules`.", "operationId": "post__api__admin__system__risk__rules", "requestBody": { "content": { "application/json": { "schema": { "properties": { "conditionData": { "additionalProperties": {}, "type": "object" }, "conditionType": { "type": "string" }, "description": { "type": "string" }, "isActive": { "nullable": true, "type": "boolean" }, "name": { "type": "string" }, "priority": { "type": "integer" }, "scene": { "type": "string" }, "score": { "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "conditionData": { "additionalProperties": {}, "type": "object" }, "conditionType": { "type": "string" }, "description": { "type": "string" }, "isActive": { "nullable": true, "type": "boolean" }, "name": { "type": "string" }, "priority": { "type": "integer" }, "scene": { "type": "string" }, "score": { "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Risk Rules", "tags": [ "Admin System" ] } }, "/api/admin/system/risk/rules/{id}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/risk/rules/{id}`.", "operationId": "delete__api__admin__system__risk__rules___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System Risk Rules Id", "tags": [ "Admin System" ] }, "get": { "description": "Auto-generated reference for `GET /api/admin/system/risk/rules/{id}`.", "operationId": "get__api__admin__system__risk__rules___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Risk Rules Id", "tags": [ "Admin System" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/system/risk/rules/{id}`.", "operationId": "put__api__admin__system__risk__rules___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "conditionData": { "additionalProperties": {}, "nullable": true, "type": "object" }, "conditionType": { "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "isActive": { "nullable": true, "type": "boolean" }, "name": { "nullable": true, "type": "string" }, "priority": { "nullable": true, "type": "integer" }, "scene": { "nullable": true, "type": "string" }, "score": { "nullable": true, "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "conditionData": { "additionalProperties": {}, "nullable": true, "type": "object" }, "conditionType": { "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "isActive": { "nullable": true, "type": "boolean" }, "name": { "nullable": true, "type": "string" }, "priority": { "nullable": true, "type": "integer" }, "scene": { "nullable": true, "type": "string" }, "score": { "nullable": true, "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin System Risk Rules Id", "tags": [ "Admin System" ] } }, "/api/admin/system/risk/rules/{id}/simulate": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/risk/rules/{id}/simulate`.", "operationId": "post__api__admin__system__risk__rules___by_id__simulate", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "account": { "type": "string" }, "appId": { "format": "int64", "nullable": true, "type": "integer" }, "deviceId": { "type": "string" }, "draft": { "nullable": true, "properties": { "conditionData": { "additionalProperties": {}, "type": "object" }, "conditionType": { "type": "string" }, "name": { "type": "string" }, "scene": { "type": "string" }, "score": { "type": "integer" } }, "type": "object" }, "ip": { "type": "string" }, "overrides": { "additionalProperties": {}, "type": "object" }, "ruleIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "scene": { "type": "string" }, "userAgent": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "account": { "type": "string" }, "appId": { "format": "int64", "nullable": true, "type": "integer" }, "deviceId": { "type": "string" }, "draft": { "nullable": true, "properties": { "conditionData": { "additionalProperties": {}, "type": "object" }, "conditionType": { "type": "string" }, "name": { "type": "string" }, "scene": { "type": "string" }, "score": { "type": "integer" } }, "type": "object" }, "ip": { "type": "string" }, "overrides": { "additionalProperties": {}, "type": "object" }, "ruleIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "scene": { "type": "string" }, "userAgent": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Risk Rules Id Simulate", "tags": [ "Admin System" ] } }, "/api/admin/system/risk/simulate": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/risk/simulate`.", "operationId": "post__api__admin__system__risk__simulate", "requestBody": { "content": { "application/json": { "schema": { "properties": { "account": { "type": "string" }, "appId": { "format": "int64", "nullable": true, "type": "integer" }, "deviceId": { "type": "string" }, "draft": { "nullable": true, "properties": { "conditionData": { "additionalProperties": {}, "type": "object" }, "conditionType": { "type": "string" }, "name": { "type": "string" }, "scene": { "type": "string" }, "score": { "type": "integer" } }, "type": "object" }, "ip": { "type": "string" }, "overrides": { "additionalProperties": {}, "type": "object" }, "ruleIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "scene": { "type": "string" }, "userAgent": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "account": { "type": "string" }, "appId": { "format": "int64", "nullable": true, "type": "integer" }, "deviceId": { "type": "string" }, "draft": { "nullable": true, "properties": { "conditionData": { "additionalProperties": {}, "type": "object" }, "conditionType": { "type": "string" }, "name": { "type": "string" }, "scene": { "type": "string" }, "score": { "type": "integer" } }, "type": "object" }, "ip": { "type": "string" }, "overrides": { "additionalProperties": {}, "type": "object" }, "ruleIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "scene": { "type": "string" }, "userAgent": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Risk Simulate", "tags": [ "Admin System" ] } }, "/api/admin/system/roles": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/roles`.", "operationId": "get__api__admin__system__roles", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Roles", "tags": [ "Admin System" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/system/roles`.", "operationId": "post__api__admin__system__roles", "requestBody": { "content": { "application/json": { "schema": { "properties": { "baseRole": { "type": "string" }, "description": { "type": "string" }, "level": { "type": "integer" }, "name": { "type": "string" }, "permissions": { "items": { "type": "string" }, "type": "array" }, "roleKey": { "type": "string" }, "scope": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "baseRole": { "type": "string" }, "description": { "type": "string" }, "level": { "type": "integer" }, "name": { "type": "string" }, "permissions": { "items": { "type": "string" }, "type": "array" }, "roleKey": { "type": "string" }, "scope": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Roles", "tags": [ "Admin System" ] } }, "/api/admin/system/roles/graph": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/roles/graph`.", "operationId": "get__api__admin__system__roles__graph", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Roles Graph", "tags": [ "Admin System" ] } }, "/api/admin/system/roles/matrix": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/roles/matrix`.", "operationId": "get__api__admin__system__roles__matrix", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Roles Matrix", "tags": [ "Admin System" ] } }, "/api/admin/system/roles/permissions": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/roles/permissions`.", "operationId": "get__api__admin__system__roles__permissions", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Roles Permissions", "tags": [ "Admin System" ] } }, "/api/admin/system/roles/{roleKey}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/roles/{roleKey}`.", "operationId": "delete__api__admin__system__roles___by_roleKey", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "roleKey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System Roles RoleKey", "tags": [ "Admin System" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/system/roles/{roleKey}`.", "operationId": "put__api__admin__system__roles___by_roleKey", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "roleKey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "description": { "type": "string" }, "level": { "type": "integer" }, "name": { "type": "string" }, "permissions": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "description": { "type": "string" }, "level": { "type": "integer" }, "name": { "type": "string" }, "permissions": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin System Roles RoleKey", "tags": [ "Admin System" ] } }, "/api/admin/system/roles/{roleKey}/impact": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/roles/{roleKey}/impact`.", "operationId": "get__api__admin__system__roles___by_roleKey__impact", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "roleKey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Roles RoleKey Impact", "tags": [ "Admin System" ] } }, "/api/admin/system/runtime": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/runtime`.", "operationId": "get__api__admin__system__runtime", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Runtime", "tags": [ "Admin System" ] } }, "/api/admin/system/saml/test": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/saml/test`.", "operationId": "post__api__admin__system__saml__test", "requestBody": { "content": { "application/json": { "schema": { "properties": { "idpMetadataURL": { "type": "string" }, "idpMetadataXML": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "idpMetadataURL": { "type": "string" }, "idpMetadataXML": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Saml Test", "tags": [ "Admin System" ] } }, "/api/admin/system/sessions": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/sessions`.", "operationId": "get__api__admin__system__sessions", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Sessions", "tags": [ "Admin System" ] } }, "/api/admin/system/sessions/{sessionId}/revoke": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/sessions/{sessionId}/revoke`.", "operationId": "post__api__admin__system__sessions___by_sessionId__revoke", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "sessionId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Sessions SessionId Revoke", "tags": [ "Admin System" ] } }, "/api/admin/system/settings": { "get": { "description": "Returns the current platform-level system settings snapshot.", "operationId": "get__api__admin__system__settings", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "Get System Settings", "tags": [ "Admin System" ] }, "put": { "description": "Updates platform-level system settings and applies them through hot reload.", "operationId": "put__api__admin__system__settings", "requestBody": { "content": { "application/json": { "schema": { "properties": { "adminCaptcha": { "properties": { "audioLang": { "nullable": true, "type": "string" }, "dynamic": { "nullable": true, "properties": { "frameDelayMs": { "type": "integer" }, "frames": { "type": "integer" }, "height": { "type": "integer" }, "length": { "type": "integer" }, "mode": { "type": "string" }, "noise": { "type": "integer" }, "width": { "type": "integer" }, "wobble": { "type": "integer" } }, "type": "object" }, "enabled": { "nullable": true, "type": "boolean" }, "requireForLogin": { "nullable": true, "type": "boolean" }, "requireForRegister": { "nullable": true, "type": "boolean" }, "type": { "nullable": true, "type": "string" } }, "type": "object" }, "branding": { "properties": { "accentColor": { "nullable": true, "type": "string" }, "consoleName": { "nullable": true, "type": "string" }, "customCSS": { "nullable": true, "type": "string" }, "faviconURL": { "nullable": true, "type": "string" }, "footerText": { "nullable": true, "type": "string" }, "loginBgColor": { "nullable": true, "type": "string" }, "loginBgURL": { "nullable": true, "type": "string" }, "logoDarkURL": { "nullable": true, "type": "string" }, "logoURL": { "nullable": true, "type": "string" }, "platformName": { "nullable": true, "type": "string" }, "primaryColor": { "nullable": true, "type": "string" }, "primaryColorDark": { "nullable": true, "type": "string" } }, "type": "object" }, "firewall": { "properties": { "adminRate": { "nullable": true, "type": "string" }, "allowedCIDRs": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "authRate": { "nullable": true, "type": "string" }, "blockedCIDRs": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "blockedPathPrefix": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "blockedUserAgents": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "corazaEnabled": { "nullable": true, "type": "boolean" }, "corazaParanoia": { "nullable": true, "type": "integer" }, "enabled": { "nullable": true, "type": "boolean" }, "globalRate": { "nullable": true, "type": "string" }, "maxPathLength": { "nullable": true, "type": "integer" }, "maxQueryLength": { "nullable": true, "type": "integer" }, "requestBodyLimit": { "nullable": true, "type": "integer" }, "requestBodyMemory": { "nullable": true, "type": "integer" } }, "type": "object" }, "ldap": { "properties": { "adminGroupDN": { "nullable": true, "type": "string" }, "attrMapping": { "nullable": true, "properties": { "account": { "nullable": true, "type": "string" }, "displayName": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "phone": { "nullable": true, "type": "string" } }, "type": "object" }, "baseDN": { "nullable": true, "type": "string" }, "bindDN": { "nullable": true, "type": "string" }, "bindPassword": { "nullable": true, "type": "string" }, "connectionTimeoutSeconds": { "nullable": true, "type": "integer" }, "enabled": { "nullable": true, "type": "boolean" }, "fallbackToLocal": { "nullable": true, "type": "boolean" }, "groupAttribute": { "nullable": true, "type": "string" }, "groupBaseDN": { "nullable": true, "type": "string" }, "groupFilter": { "nullable": true, "type": "string" }, "port": { "nullable": true, "type": "integer" }, "searchTimeoutSeconds": { "nullable": true, "type": "integer" }, "server": { "nullable": true, "type": "string" }, "skipTLSVerify": { "nullable": true, "type": "boolean" }, "useStartTLS": { "nullable": true, "type": "boolean" }, "useTLS": { "nullable": true, "type": "boolean" }, "userAttribute": { "nullable": true, "type": "string" }, "userFilter": { "nullable": true, "type": "string" } }, "type": "object" }, "oidc": { "properties": { "adminGroupClaim": { "nullable": true, "type": "string" }, "adminGroupValue": { "nullable": true, "type": "string" }, "allowedDomains": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "attrMapping": { "nullable": true, "properties": { "account": { "nullable": true, "type": "string" }, "displayName": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "phone": { "nullable": true, "type": "string" } }, "type": "object" }, "clientID": { "nullable": true, "type": "string" }, "clientSecret": { "nullable": true, "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "fallbackToLocal": { "nullable": true, "type": "boolean" }, "frontendCallbackURL": { "nullable": true, "type": "string" }, "issuerURL": { "nullable": true, "type": "string" }, "redirectURL": { "nullable": true, "type": "string" }, "scopes": { "items": { "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "saml": { "properties": { "acsURL": { "nullable": true, "type": "string" }, "adminGroupAttribute": { "nullable": true, "type": "string" }, "adminGroupValue": { "nullable": true, "type": "string" }, "allowIdpInitiated": { "nullable": true, "type": "boolean" }, "allowedDomains": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "attrMapping": { "nullable": true, "properties": { "account": { "nullable": true, "type": "string" }, "displayName": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "groups": { "nullable": true, "type": "string" }, "phone": { "nullable": true, "type": "string" } }, "type": "object" }, "enabled": { "nullable": true, "type": "boolean" }, "entityID": { "nullable": true, "type": "string" }, "fallbackToLocal": { "nullable": true, "type": "boolean" }, "forceAuthn": { "nullable": true, "type": "boolean" }, "frontendCallbackURL": { "nullable": true, "type": "string" }, "idpMetadataURL": { "nullable": true, "type": "string" }, "idpMetadataXML": { "nullable": true, "type": "string" }, "metadataURL": { "nullable": true, "type": "string" }, "nameIDFormat": { "nullable": true, "type": "string" }, "signAuthnRequests": { "nullable": true, "type": "boolean" }, "spCertificate": { "nullable": true, "type": "string" }, "spPrivateKey": { "nullable": true, "type": "string" } }, "type": "object" }, "security": { "properties": { "challengeTTLSeconds": { "format": "int64", "nullable": true, "type": "integer" }, "modules": { "properties": { "passkeyEnabled": { "nullable": true, "type": "boolean" }, "recoveryCodesEnabled": { "nullable": true, "type": "boolean" }, "totpEnabled": { "nullable": true, "type": "boolean" } }, "type": "object" }, "passkey": { "properties": { "challengeTTLSeconds": { "format": "int64", "nullable": true, "type": "integer" }, "enabled": { "nullable": true, "type": "boolean" }, "rpDisplayName": { "nullable": true, "type": "string" }, "rpId": { "nullable": true, "type": "string" }, "rpOrigins": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "rpTopOrigins": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "userVerification": { "nullable": true, "type": "string" } }, "type": "object" }, "recoveryCodes": { "properties": { "count": { "nullable": true, "type": "integer" }, "enabled": { "nullable": true, "type": "boolean" }, "length": { "nullable": true, "type": "integer" } }, "type": "object" }, "totp": { "properties": { "digits": { "nullable": true, "type": "integer" }, "enabled": { "nullable": true, "type": "boolean" }, "enrollmentTTLSeconds": { "format": "int64", "nullable": true, "type": "integer" }, "issuer": { "nullable": true, "type": "string" }, "skew": { "minimum": 0, "nullable": true, "type": "integer" } }, "type": "object" } }, "type": "object" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "adminCaptcha": { "properties": { "audioLang": { "nullable": true, "type": "string" }, "dynamic": { "nullable": true, "properties": { "frameDelayMs": { "type": "integer" }, "frames": { "type": "integer" }, "height": { "type": "integer" }, "length": { "type": "integer" }, "mode": { "type": "string" }, "noise": { "type": "integer" }, "width": { "type": "integer" }, "wobble": { "type": "integer" } }, "type": "object" }, "enabled": { "nullable": true, "type": "boolean" }, "requireForLogin": { "nullable": true, "type": "boolean" }, "requireForRegister": { "nullable": true, "type": "boolean" }, "type": { "nullable": true, "type": "string" } }, "type": "object" }, "branding": { "properties": { "accentColor": { "nullable": true, "type": "string" }, "consoleName": { "nullable": true, "type": "string" }, "customCSS": { "nullable": true, "type": "string" }, "faviconURL": { "nullable": true, "type": "string" }, "footerText": { "nullable": true, "type": "string" }, "loginBgColor": { "nullable": true, "type": "string" }, "loginBgURL": { "nullable": true, "type": "string" }, "logoDarkURL": { "nullable": true, "type": "string" }, "logoURL": { "nullable": true, "type": "string" }, "platformName": { "nullable": true, "type": "string" }, "primaryColor": { "nullable": true, "type": "string" }, "primaryColorDark": { "nullable": true, "type": "string" } }, "type": "object" }, "firewall": { "properties": { "adminRate": { "nullable": true, "type": "string" }, "allowedCIDRs": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "authRate": { "nullable": true, "type": "string" }, "blockedCIDRs": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "blockedPathPrefix": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "blockedUserAgents": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "corazaEnabled": { "nullable": true, "type": "boolean" }, "corazaParanoia": { "nullable": true, "type": "integer" }, "enabled": { "nullable": true, "type": "boolean" }, "globalRate": { "nullable": true, "type": "string" }, "maxPathLength": { "nullable": true, "type": "integer" }, "maxQueryLength": { "nullable": true, "type": "integer" }, "requestBodyLimit": { "nullable": true, "type": "integer" }, "requestBodyMemory": { "nullable": true, "type": "integer" } }, "type": "object" }, "ldap": { "properties": { "adminGroupDN": { "nullable": true, "type": "string" }, "attrMapping": { "nullable": true, "properties": { "account": { "nullable": true, "type": "string" }, "displayName": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "phone": { "nullable": true, "type": "string" } }, "type": "object" }, "baseDN": { "nullable": true, "type": "string" }, "bindDN": { "nullable": true, "type": "string" }, "bindPassword": { "nullable": true, "type": "string" }, "connectionTimeoutSeconds": { "nullable": true, "type": "integer" }, "enabled": { "nullable": true, "type": "boolean" }, "fallbackToLocal": { "nullable": true, "type": "boolean" }, "groupAttribute": { "nullable": true, "type": "string" }, "groupBaseDN": { "nullable": true, "type": "string" }, "groupFilter": { "nullable": true, "type": "string" }, "port": { "nullable": true, "type": "integer" }, "searchTimeoutSeconds": { "nullable": true, "type": "integer" }, "server": { "nullable": true, "type": "string" }, "skipTLSVerify": { "nullable": true, "type": "boolean" }, "useStartTLS": { "nullable": true, "type": "boolean" }, "useTLS": { "nullable": true, "type": "boolean" }, "userAttribute": { "nullable": true, "type": "string" }, "userFilter": { "nullable": true, "type": "string" } }, "type": "object" }, "oidc": { "properties": { "adminGroupClaim": { "nullable": true, "type": "string" }, "adminGroupValue": { "nullable": true, "type": "string" }, "allowedDomains": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "attrMapping": { "nullable": true, "properties": { "account": { "nullable": true, "type": "string" }, "displayName": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "phone": { "nullable": true, "type": "string" } }, "type": "object" }, "clientID": { "nullable": true, "type": "string" }, "clientSecret": { "nullable": true, "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "fallbackToLocal": { "nullable": true, "type": "boolean" }, "frontendCallbackURL": { "nullable": true, "type": "string" }, "issuerURL": { "nullable": true, "type": "string" }, "redirectURL": { "nullable": true, "type": "string" }, "scopes": { "items": { "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "saml": { "properties": { "acsURL": { "nullable": true, "type": "string" }, "adminGroupAttribute": { "nullable": true, "type": "string" }, "adminGroupValue": { "nullable": true, "type": "string" }, "allowIdpInitiated": { "nullable": true, "type": "boolean" }, "allowedDomains": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "attrMapping": { "nullable": true, "properties": { "account": { "nullable": true, "type": "string" }, "displayName": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "groups": { "nullable": true, "type": "string" }, "phone": { "nullable": true, "type": "string" } }, "type": "object" }, "enabled": { "nullable": true, "type": "boolean" }, "entityID": { "nullable": true, "type": "string" }, "fallbackToLocal": { "nullable": true, "type": "boolean" }, "forceAuthn": { "nullable": true, "type": "boolean" }, "frontendCallbackURL": { "nullable": true, "type": "string" }, "idpMetadataURL": { "nullable": true, "type": "string" }, "idpMetadataXML": { "nullable": true, "type": "string" }, "metadataURL": { "nullable": true, "type": "string" }, "nameIDFormat": { "nullable": true, "type": "string" }, "signAuthnRequests": { "nullable": true, "type": "boolean" }, "spCertificate": { "nullable": true, "type": "string" }, "spPrivateKey": { "nullable": true, "type": "string" } }, "type": "object" }, "security": { "properties": { "challengeTTLSeconds": { "format": "int64", "nullable": true, "type": "integer" }, "modules": { "properties": { "passkeyEnabled": { "nullable": true, "type": "boolean" }, "recoveryCodesEnabled": { "nullable": true, "type": "boolean" }, "totpEnabled": { "nullable": true, "type": "boolean" } }, "type": "object" }, "passkey": { "properties": { "challengeTTLSeconds": { "format": "int64", "nullable": true, "type": "integer" }, "enabled": { "nullable": true, "type": "boolean" }, "rpDisplayName": { "nullable": true, "type": "string" }, "rpId": { "nullable": true, "type": "string" }, "rpOrigins": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "rpTopOrigins": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "userVerification": { "nullable": true, "type": "string" } }, "type": "object" }, "recoveryCodes": { "properties": { "count": { "nullable": true, "type": "integer" }, "enabled": { "nullable": true, "type": "boolean" }, "length": { "nullable": true, "type": "integer" } }, "type": "object" }, "totp": { "properties": { "digits": { "nullable": true, "type": "integer" }, "enabled": { "nullable": true, "type": "boolean" }, "enrollmentTTLSeconds": { "format": "int64", "nullable": true, "type": "integer" }, "issuer": { "nullable": true, "type": "string" }, "skew": { "minimum": 0, "nullable": true, "type": "integer" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "Update System Settings", "tags": [ "Admin System" ] } }, "/api/admin/system/storage/cdn/{configId}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/storage/cdn/{configId}`.", "operationId": "delete__api__admin__system__storage__cdn___by_configId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "configId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System Storage Cdn ConfigId", "tags": [ "Admin System" ] }, "get": { "description": "Auto-generated reference for `GET /api/admin/system/storage/cdn/{configId}`.", "operationId": "get__api__admin__system__storage__cdn___by_configId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "configId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Storage Cdn ConfigId", "tags": [ "Admin System" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/system/storage/cdn/{configId}`.", "operationId": "put__api__admin__system__storage__cdn___by_configId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "configId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "cacheMaxAge": { "type": "integer" }, "cdnDomain": { "type": "string" }, "cdnProtocol": { "type": "string" }, "ipWhitelist": { "items": { "type": "string" }, "type": "array" }, "refererBlacklist": { "items": { "type": "string" }, "type": "array" }, "refererWhitelist": { "items": { "type": "string" }, "type": "array" }, "signUrlEnabled": { "type": "boolean" }, "signUrlSecret": { "type": "string" }, "signUrlTtl": { "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "cacheMaxAge": { "type": "integer" }, "cdnDomain": { "type": "string" }, "cdnProtocol": { "type": "string" }, "ipWhitelist": { "items": { "type": "string" }, "type": "array" }, "refererBlacklist": { "items": { "type": "string" }, "type": "array" }, "refererWhitelist": { "items": { "type": "string" }, "type": "array" }, "signUrlEnabled": { "type": "boolean" }, "signUrlSecret": { "type": "string" }, "signUrlTtl": { "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin System Storage Cdn ConfigId", "tags": [ "Admin System" ] } }, "/api/admin/system/storage/image-rules": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/storage/image-rules`.", "operationId": "get__api__admin__system__storage__image_dash_rules", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Storage Image Rules", "tags": [ "Admin System" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/system/storage/image-rules`.", "operationId": "post__api__admin__system__storage__image_dash_rules", "requestBody": { "content": { "application/json": { "schema": { "properties": { "configId": { "format": "int64", "nullable": true, "type": "integer" }, "name": { "type": "string" }, "ruleData": { "additionalProperties": {}, "type": "object" }, "ruleType": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "configId": { "format": "int64", "nullable": true, "type": "integer" }, "name": { "type": "string" }, "ruleData": { "additionalProperties": {}, "type": "object" }, "ruleType": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Storage Image Rules", "tags": [ "Admin System" ] } }, "/api/admin/system/storage/image-rules/{ruleId}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/storage/image-rules/{ruleId}`.", "operationId": "delete__api__admin__system__storage__image_dash_rules___by_ruleId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "ruleId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System Storage Image Rules RuleId", "tags": [ "Admin System" ] } }, "/api/admin/system/storage/objects": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/storage/objects`.", "operationId": "get__api__admin__system__storage__objects", "parameters": [ { "in": "query", "name": "configId", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "appId", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "prefix", "schema": { "type": "string" } }, { "in": "query", "name": "folder", "schema": { "type": "string" } }, { "in": "query", "name": "folderView", "schema": { "type": "boolean" } }, { "in": "query", "name": "keyword", "schema": { "type": "string" } }, { "in": "query", "name": "contentType", "schema": { "type": "string" } }, { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "statuses", "schema": { "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "uploaderType", "schema": { "type": "string" } }, { "in": "query", "name": "uploadedBy", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "minSize", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "maxSize", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "createdFrom", "schema": { "type": "string" } }, { "in": "query", "name": "createdTo", "schema": { "type": "string" } }, { "in": "query", "name": "sort", "schema": { "type": "string" } }, { "in": "query", "name": "order", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Storage Objects", "tags": [ "Admin System" ] } }, "/api/admin/system/storage/objects/batch": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/storage/objects/batch`.", "operationId": "post__api__admin__system__storage__objects__batch", "requestBody": { "content": { "application/json": { "schema": { "properties": { "action": { "type": "string" }, "ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "action": { "type": "string" }, "ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Storage Objects Batch", "tags": [ "Admin System" ] } }, "/api/admin/system/storage/objects/{objectId}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/storage/objects/{objectId}`.", "operationId": "delete__api__admin__system__storage__objects___by_objectId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System Storage Objects ObjectId", "tags": [ "Admin System" ] }, "get": { "description": "Auto-generated reference for `GET /api/admin/system/storage/objects/{objectId}`.", "operationId": "get__api__admin__system__storage__objects___by_objectId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Storage Objects ObjectId", "tags": [ "Admin System" ] } }, "/api/admin/system/storage/objects/{objectId}/link": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/storage/objects/{objectId}/link`.", "operationId": "post__api__admin__system__storage__objects___by_objectId__link", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "download": { "type": "boolean" }, "expiresIn": { "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "download": { "type": "boolean" }, "expiresIn": { "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Storage Objects ObjectId Link", "tags": [ "Admin System" ] } }, "/api/admin/system/storage/objects/{objectId}/permanent": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/storage/objects/{objectId}/permanent`.", "operationId": "delete__api__admin__system__storage__objects___by_objectId__permanent", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System Storage Objects ObjectId Permanent", "tags": [ "Admin System" ] } }, "/api/admin/system/storage/objects/{objectId}/restore": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/storage/objects/{objectId}/restore`.", "operationId": "post__api__admin__system__storage__objects___by_objectId__restore", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Storage Objects ObjectId Restore", "tags": [ "Admin System" ] } }, "/api/admin/system/storage/objects/{objectId}/thumbnail": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/storage/objects/{objectId}/thumbnail`.", "operationId": "get__api__admin__system__storage__objects___by_objectId__thumbnail", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Storage Objects ObjectId Thumbnail", "tags": [ "Admin System" ] } }, "/api/admin/system/storage/rules": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/storage/rules`.", "operationId": "get__api__admin__system__storage__rules", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Storage Rules", "tags": [ "Admin System" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/system/storage/rules`.", "operationId": "post__api__admin__system__storage__rules", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appId": { "format": "int64", "nullable": true, "type": "integer" }, "configId": { "format": "int64", "nullable": true, "type": "integer" }, "name": { "type": "string" }, "ruleData": { "additionalProperties": {}, "type": "object" }, "ruleType": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appId": { "format": "int64", "nullable": true, "type": "integer" }, "configId": { "format": "int64", "nullable": true, "type": "integer" }, "name": { "type": "string" }, "ruleData": { "additionalProperties": {}, "type": "object" }, "ruleType": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Storage Rules", "tags": [ "Admin System" ] } }, "/api/admin/system/storage/rules/{ruleId}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/storage/rules/{ruleId}`.", "operationId": "delete__api__admin__system__storage__rules___by_ruleId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "ruleId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System Storage Rules RuleId", "tags": [ "Admin System" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/system/storage/rules/{ruleId}`.", "operationId": "put__api__admin__system__storage__rules___by_ruleId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "ruleId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "isActive": { "nullable": true, "type": "boolean" }, "name": { "nullable": true, "type": "string" }, "ruleData": { "additionalProperties": {}, "nullable": true, "type": "object" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "isActive": { "nullable": true, "type": "boolean" }, "name": { "nullable": true, "type": "string" }, "ruleData": { "additionalProperties": {}, "nullable": true, "type": "object" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin System Storage Rules RuleId", "tags": [ "Admin System" ] } }, "/api/admin/system/storage/trash": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/storage/trash`.", "operationId": "get__api__admin__system__storage__trash", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Storage Trash", "tags": [ "Admin System" ] } }, "/api/admin/system/storage/trash/cleanup": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/storage/trash/cleanup`.", "operationId": "post__api__admin__system__storage__trash__cleanup", "requestBody": { "content": { "application/json": { "schema": { "properties": { "olderThanDays": { "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "olderThanDays": { "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Storage Trash Cleanup", "tags": [ "Admin System" ] } }, "/api/admin/system/storage/usage": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/storage/usage`.", "operationId": "get__api__admin__system__storage__usage", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Storage Usage", "tags": [ "Admin System" ] } }, "/api/admin/system/storage/usage/history": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/storage/usage/history`.", "operationId": "get__api__admin__system__storage__usage__history", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Storage Usage History", "tags": [ "Admin System" ] } }, "/api/admin/system/temp-permissions": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/temp-permissions`.", "operationId": "get__api__admin__system__temp_dash_permissions", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Temp Permissions", "tags": [ "Admin System" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/system/temp-permissions`.", "operationId": "post__api__admin__system__temp_dash_permissions", "requestBody": { "content": { "application/json": { "schema": { "properties": { "adminId": { "format": "int64", "type": "integer" }, "appId": { "format": "int64", "nullable": true, "type": "integer" }, "expiresAt": { "type": "string" }, "permission": { "type": "string" }, "reason": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "adminId": { "format": "int64", "type": "integer" }, "appId": { "format": "int64", "nullable": true, "type": "integer" }, "expiresAt": { "type": "string" }, "permission": { "type": "string" }, "reason": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Temp Permissions", "tags": [ "Admin System" ] } }, "/api/admin/system/temp-permissions/{permId}/revoke": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/temp-permissions/{permId}/revoke`.", "operationId": "post__api__admin__system__temp_dash_permissions___by_permId__revoke", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "permId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Temp Permissions PermId Revoke", "tags": [ "Admin System" ] } }, "/api/admin/system/templates": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/templates`.", "operationId": "get__api__admin__system__templates", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Templates", "tags": [ "Admin System" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/system/templates`.", "operationId": "post__api__admin__system__templates", "requestBody": { "content": { "application/json": { "schema": { "properties": { "bodyHtml": { "type": "string" }, "bodyText": { "type": "string" }, "channel": { "type": "string" }, "code": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "subject": { "type": "string" }, "variables": { "items": { "properties": { "description": { "type": "string" }, "example": { "type": "string" }, "key": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "bodyHtml": { "type": "string" }, "bodyText": { "type": "string" }, "channel": { "type": "string" }, "code": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "subject": { "type": "string" }, "variables": { "items": { "properties": { "description": { "type": "string" }, "example": { "type": "string" }, "key": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Templates", "tags": [ "Admin System" ] } }, "/api/admin/system/templates/{code}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/templates/{code}`.", "operationId": "delete__api__admin__system__templates___by_code", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "code", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System Templates Code", "tags": [ "Admin System" ] }, "get": { "description": "Auto-generated reference for `GET /api/admin/system/templates/{code}`.", "operationId": "get__api__admin__system__templates___by_code", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "code", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System Templates Code", "tags": [ "Admin System" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/system/templates/{code}`.", "operationId": "put__api__admin__system__templates___by_code", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "code", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "bodyHtml": { "nullable": true, "type": "string" }, "bodyText": { "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "name": { "nullable": true, "type": "string" }, "subject": { "nullable": true, "type": "string" }, "variables": { "items": { "properties": { "description": { "type": "string" }, "example": { "type": "string" }, "key": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "bodyHtml": { "nullable": true, "type": "string" }, "bodyText": { "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "name": { "nullable": true, "type": "string" }, "subject": { "nullable": true, "type": "string" }, "variables": { "items": { "properties": { "description": { "type": "string" }, "example": { "type": "string" }, "key": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin System Templates Code", "tags": [ "Admin System" ] } }, "/api/admin/system/templates/{code}/preview": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/templates/{code}/preview`.", "operationId": "post__api__admin__system__templates___by_code__preview", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "code", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "additionalProperties": { "type": "string" }, "type": "object" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "data": { "additionalProperties": { "type": "string" }, "type": "object" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System Templates Code Preview", "tags": [ "Admin System" ] } }, "/api/admin/system/user-master/appeals": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/user-master/appeals`.", "operationId": "get__api__admin__system__user_dash_master__appeals", "parameters": [ { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System User Master Appeals", "tags": [ "Admin System" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/system/user-master/appeals`.", "operationId": "post__api__admin__system__user_dash_master__appeals", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appealType": { "type": "string" }, "evidence": { "type": "string" }, "identityId": { "format": "int64", "type": "integer" }, "reason": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appealType": { "type": "string" }, "evidence": { "type": "string" }, "identityId": { "format": "int64", "type": "integer" }, "reason": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System User Master Appeals", "tags": [ "Admin System" ] } }, "/api/admin/system/user-master/appeals/{id}": { "put": { "description": "Auto-generated reference for `PUT /api/admin/system/user-master/appeals/{id}`.", "operationId": "put__api__admin__system__user_dash_master__appeals___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "action": { "type": "string" }, "comment": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "action": { "type": "string" }, "comment": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin System User Master Appeals Id", "tags": [ "Admin System" ] } }, "/api/admin/system/user-master/deactivations": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/user-master/deactivations`.", "operationId": "get__api__admin__system__user_dash_master__deactivations", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System User Master Deactivations", "tags": [ "Admin System" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/system/user-master/deactivations`.", "operationId": "post__api__admin__system__user_dash_master__deactivations", "requestBody": { "content": { "application/json": { "schema": { "properties": { "coolingDays": { "type": "integer" }, "identityId": { "format": "int64", "type": "integer" }, "reason": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "coolingDays": { "type": "integer" }, "identityId": { "format": "int64", "type": "integer" }, "reason": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System User Master Deactivations", "tags": [ "Admin System" ] } }, "/api/admin/system/user-master/deactivations/{id}/cancel": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/user-master/deactivations/{id}/cancel`.", "operationId": "post__api__admin__system__user_dash_master__deactivations___by_id__cancel", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System User Master Deactivations Id Cancel", "tags": [ "Admin System" ] } }, "/api/admin/system/user-master/identities": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/user-master/identities`.", "operationId": "get__api__admin__system__user_dash_master__identities", "parameters": [ { "in": "query", "name": "keyword", "schema": { "type": "string" } }, { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "lifecycleState", "schema": { "type": "string" } }, { "in": "query", "name": "riskLevel", "schema": { "type": "string" } }, { "in": "query", "name": "tagId", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System User Master Identities", "tags": [ "Admin System" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/system/user-master/identities`.", "operationId": "post__api__admin__system__user_dash_master__identities", "requestBody": { "content": { "application/json": { "schema": { "properties": { "displayName": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "displayName": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System User Master Identities", "tags": [ "Admin System" ] } }, "/api/admin/system/user-master/identities/{id}": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/user-master/identities/{id}`.", "operationId": "get__api__admin__system__user_dash_master__identities___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System User Master Identities Id", "tags": [ "Admin System" ] } }, "/api/admin/system/user-master/identities/{id}/lifecycle": { "put": { "description": "Auto-generated reference for `PUT /api/admin/system/user-master/identities/{id}/lifecycle`.", "operationId": "put__api__admin__system__user_dash_master__identities___by_id__lifecycle", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "state": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "state": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin System User Master Identities Id Lifecycle", "tags": [ "Admin System" ] } }, "/api/admin/system/user-master/identities/{id}/mappings": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/user-master/identities/{id}/mappings`.", "operationId": "get__api__admin__system__user_dash_master__identities___by_id__mappings", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System User Master Identities Id Mappings", "tags": [ "Admin System" ] } }, "/api/admin/system/user-master/identities/{id}/risk": { "put": { "description": "Auto-generated reference for `PUT /api/admin/system/user-master/identities/{id}/risk`.", "operationId": "put__api__admin__system__user_dash_master__identities___by_id__risk", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "level": { "type": "string" }, "score": { "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "level": { "type": "string" }, "score": { "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin System User Master Identities Id Risk", "tags": [ "Admin System" ] } }, "/api/admin/system/user-master/identities/{id}/status": { "put": { "description": "Auto-generated reference for `PUT /api/admin/system/user-master/identities/{id}/status`.", "operationId": "put__api__admin__system__user_dash_master__identities___by_id__status", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin System User Master Identities Id Status", "tags": [ "Admin System" ] } }, "/api/admin/system/user-master/identities/{id}/tags": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/user-master/identities/{id}/tags`.", "operationId": "get__api__admin__system__user_dash_master__identities___by_id__tags", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System User Master Identities Id Tags", "tags": [ "Admin System" ] } }, "/api/admin/system/user-master/lists": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/user-master/lists`.", "operationId": "get__api__admin__system__user_dash_master__lists", "parameters": [ { "in": "query", "name": "listType", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System User Master Lists", "tags": [ "Admin System" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/system/user-master/lists`.", "operationId": "post__api__admin__system__user_dash_master__lists", "requestBody": { "content": { "application/json": { "schema": { "properties": { "email": { "type": "string" }, "expiresAt": { "format": "date-time", "nullable": true, "type": "string" }, "identityId": { "format": "int64", "nullable": true, "type": "integer" }, "ip": { "type": "string" }, "listType": { "type": "string" }, "phone": { "type": "string" }, "reason": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "email": { "type": "string" }, "expiresAt": { "format": "date-time", "nullable": true, "type": "string" }, "identityId": { "format": "int64", "nullable": true, "type": "integer" }, "ip": { "type": "string" }, "listType": { "type": "string" }, "phone": { "type": "string" }, "reason": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System User Master Lists", "tags": [ "Admin System" ] } }, "/api/admin/system/user-master/lists/check": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/user-master/lists/check`.", "operationId": "post__api__admin__system__user_dash_master__lists__check", "requestBody": { "content": { "application/json": { "schema": { "properties": { "email": { "type": "string" }, "ip": { "type": "string" }, "phone": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "email": { "type": "string" }, "ip": { "type": "string" }, "phone": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System User Master Lists Check", "tags": [ "Admin System" ] } }, "/api/admin/system/user-master/lists/{id}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/user-master/lists/{id}`.", "operationId": "delete__api__admin__system__user_dash_master__lists___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System User Master Lists Id", "tags": [ "Admin System" ] } }, "/api/admin/system/user-master/mappings": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/user-master/mappings`.", "operationId": "post__api__admin__system__user_dash_master__mappings", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appId": { "format": "int64", "type": "integer" }, "identityId": { "format": "int64", "type": "integer" }, "userId": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appId": { "format": "int64", "type": "integer" }, "identityId": { "format": "int64", "type": "integer" }, "userId": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System User Master Mappings", "tags": [ "Admin System" ] } }, "/api/admin/system/user-master/mappings/{id}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/user-master/mappings/{id}`.", "operationId": "delete__api__admin__system__user_dash_master__mappings___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System User Master Mappings Id", "tags": [ "Admin System" ] } }, "/api/admin/system/user-master/merges": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/user-master/merges`.", "operationId": "get__api__admin__system__user_dash_master__merges", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System User Master Merges", "tags": [ "Admin System" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/system/user-master/merges`.", "operationId": "post__api__admin__system__user_dash_master__merges", "requestBody": { "content": { "application/json": { "schema": { "properties": { "mergedId": { "format": "int64", "type": "integer" }, "primaryId": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "mergedId": { "format": "int64", "type": "integer" }, "primaryId": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System User Master Merges", "tags": [ "Admin System" ] } }, "/api/admin/system/user-master/segments": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/user-master/segments`.", "operationId": "get__api__admin__system__user_dash_master__segments", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System User Master Segments", "tags": [ "Admin System" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/system/user-master/segments`.", "operationId": "post__api__admin__system__user_dash_master__segments", "requestBody": { "content": { "application/json": { "schema": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "rules": { "additionalProperties": {}, "type": "object" }, "segmentType": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "rules": { "additionalProperties": {}, "type": "object" }, "segmentType": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System User Master Segments", "tags": [ "Admin System" ] } }, "/api/admin/system/user-master/segments/{id}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/user-master/segments/{id}`.", "operationId": "delete__api__admin__system__user_dash_master__segments___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System User Master Segments Id", "tags": [ "Admin System" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/system/user-master/segments/{id}`.", "operationId": "put__api__admin__system__user_dash_master__segments___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "rules": { "additionalProperties": {}, "type": "object" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "rules": { "additionalProperties": {}, "type": "object" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin System User Master Segments Id", "tags": [ "Admin System" ] } }, "/api/admin/system/user-master/segments/{id}/members": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/user-master/segments/{id}/members`.", "operationId": "get__api__admin__system__user_dash_master__segments___by_id__members", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System User Master Segments Id Members", "tags": [ "Admin System" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/system/user-master/segments/{id}/members`.", "operationId": "post__api__admin__system__user_dash_master__segments___by_id__members", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "identityId": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "identityId": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System User Master Segments Id Members", "tags": [ "Admin System" ] } }, "/api/admin/system/user-master/segments/{id}/members/{identityId}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/user-master/segments/{id}/members/{identityId}`.", "operationId": "delete__api__admin__system__user_dash_master__segments___by_id__members___by_identityId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "identityId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System User Master Segments Id Members IdentityId", "tags": [ "Admin System" ] } }, "/api/admin/system/user-master/sync": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/user-master/sync`.", "operationId": "post__api__admin__system__user_dash_master__sync", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appId": { "format": "int64", "type": "integer" }, "userId": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appId": { "format": "int64", "type": "integer" }, "userId": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System User Master Sync", "tags": [ "Admin System" ] } }, "/api/admin/system/user-master/sync/batch": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/user-master/sync/batch`.", "operationId": "post__api__admin__system__user_dash_master__sync__batch", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appId": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appId": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System User Master Sync Batch", "tags": [ "Admin System" ] } }, "/api/admin/system/user-master/tags": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/user-master/tags`.", "operationId": "get__api__admin__system__user_dash_master__tags", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System User Master Tags", "tags": [ "Admin System" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/system/user-master/tags`.", "operationId": "post__api__admin__system__user_dash_master__tags", "requestBody": { "content": { "application/json": { "schema": { "properties": { "color": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "color": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System User Master Tags", "tags": [ "Admin System" ] } }, "/api/admin/system/user-master/tags/assign": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/user-master/tags/assign`.", "operationId": "post__api__admin__system__user_dash_master__tags__assign", "requestBody": { "content": { "application/json": { "schema": { "properties": { "identityId": { "format": "int64", "type": "integer" }, "tagId": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "identityId": { "format": "int64", "type": "integer" }, "tagId": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System User Master Tags Assign", "tags": [ "Admin System" ] } }, "/api/admin/system/user-master/tags/remove": { "post": { "description": "Auto-generated reference for `POST /api/admin/system/user-master/tags/remove`.", "operationId": "post__api__admin__system__user_dash_master__tags__remove", "requestBody": { "content": { "application/json": { "schema": { "properties": { "identityId": { "format": "int64", "type": "integer" }, "tagId": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "identityId": { "format": "int64", "type": "integer" }, "tagId": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System User Master Tags Remove", "tags": [ "Admin System" ] } }, "/api/admin/system/user-master/tags/{id}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/user-master/tags/{id}`.", "operationId": "delete__api__admin__system__user_dash_master__tags___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System User Master Tags Id", "tags": [ "Admin System" ] } }, "/api/admin/system/user-master/user-lists": { "get": { "description": "Auto-generated reference for `GET /api/admin/system/user-master/user-lists`.", "operationId": "get__api__admin__system__user_dash_master__user_dash_lists", "parameters": [ { "in": "query", "name": "listType", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin System User Master User Lists", "tags": [ "Admin System" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/system/user-master/user-lists`.", "operationId": "post__api__admin__system__user_dash_master__user_dash_lists", "requestBody": { "content": { "application/json": { "schema": { "properties": { "email": { "type": "string" }, "expiresAt": { "format": "date-time", "nullable": true, "type": "string" }, "identityId": { "format": "int64", "nullable": true, "type": "integer" }, "ip": { "type": "string" }, "listType": { "type": "string" }, "phone": { "type": "string" }, "reason": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "email": { "type": "string" }, "expiresAt": { "format": "date-time", "nullable": true, "type": "string" }, "identityId": { "format": "int64", "nullable": true, "type": "integer" }, "ip": { "type": "string" }, "listType": { "type": "string" }, "phone": { "type": "string" }, "reason": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin System User Master User Lists", "tags": [ "Admin System" ] } }, "/api/admin/system/user-master/user-lists/{id}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/system/user-master/user-lists/{id}`.", "operationId": "delete__api__admin__system__user_dash_master__user_dash_lists___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin System User Master User Lists Id", "tags": [ "Admin System" ] } }, "/api/admin/tickets": { "get": { "description": "Auto-generated reference for `GET /api/admin/tickets`.", "operationId": "get__api__admin__tickets", "parameters": [ { "in": "query", "name": "appid", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "priority", "schema": { "type": "string" } }, { "in": "query", "name": "categoryId", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "groupId", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "assigneeId", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "unassigned", "schema": { "type": "boolean" } }, { "in": "query", "name": "requesterId", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "keyword", "schema": { "type": "string" } }, { "in": "query", "name": "tags", "schema": { "type": "string" } }, { "in": "query", "name": "slaState", "schema": { "type": "string" } }, { "in": "query", "name": "overdueOnly", "schema": { "type": "boolean" } }, { "in": "query", "name": "createdFrom", "schema": { "type": "string" } }, { "in": "query", "name": "createdTo", "schema": { "type": "string" } }, { "in": "query", "name": "rated", "schema": { "type": "boolean" } }, { "in": "query", "name": "sortBy", "schema": { "type": "string" } }, { "in": "query", "name": "sortDir", "schema": { "type": "string" } }, { "in": "query", "name": "includeClosed", "schema": { "type": "boolean" } }, { "in": "query", "name": "mine", "schema": { "type": "boolean" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Tickets", "tags": [ "Admin" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/tickets`.", "operationId": "post__api__admin__tickets", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "assigneeAdminId": { "format": "int64", "nullable": true, "type": "integer" }, "attachmentIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "categoryId": { "format": "int64", "nullable": true, "type": "integer" }, "content": { "type": "string" }, "contentType": { "type": "string" }, "groupId": { "format": "int64", "nullable": true, "type": "integer" }, "metadata": { "additionalProperties": {}, "type": "object" }, "priority": { "type": "string" }, "requesterAdminId": { "format": "int64", "nullable": true, "type": "integer" }, "requesterContact": { "type": "string" }, "requesterName": { "type": "string" }, "requesterType": { "type": "string" }, "requesterUserId": { "format": "int64", "nullable": true, "type": "integer" }, "source": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "assigneeAdminId": { "format": "int64", "nullable": true, "type": "integer" }, "attachmentIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "categoryId": { "format": "int64", "nullable": true, "type": "integer" }, "content": { "type": "string" }, "contentType": { "type": "string" }, "groupId": { "format": "int64", "nullable": true, "type": "integer" }, "metadata": { "additionalProperties": {}, "type": "object" }, "priority": { "type": "string" }, "requesterAdminId": { "format": "int64", "nullable": true, "type": "integer" }, "requesterContact": { "type": "string" }, "requesterName": { "type": "string" }, "requesterType": { "type": "string" }, "requesterUserId": { "format": "int64", "nullable": true, "type": "integer" }, "source": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Tickets", "tags": [ "Admin" ] } }, "/api/admin/tickets/agents": { "get": { "description": "Auto-generated reference for `GET /api/admin/tickets/agents`.", "operationId": "get__api__admin__tickets__agents", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Tickets Agents", "tags": [ "Admin" ] } }, "/api/admin/tickets/attachments": { "post": { "description": "Auto-generated reference for `POST /api/admin/tickets/attachments`.", "operationId": "post__api__admin__tickets__attachments", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Tickets Attachments", "tags": [ "Admin" ] } }, "/api/admin/tickets/bulk": { "post": { "description": "Auto-generated reference for `POST /api/admin/tickets/bulk`.", "operationId": "post__api__admin__tickets__bulk", "requestBody": { "content": { "application/json": { "schema": { "properties": { "action": { "type": "string" }, "assigneeAdminId": { "format": "int64", "nullable": true, "type": "integer" }, "groupId": { "format": "int64", "nullable": true, "type": "integer" }, "ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "priority": { "type": "string" }, "reason": { "type": "string" }, "status": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "action": { "type": "string" }, "assigneeAdminId": { "format": "int64", "nullable": true, "type": "integer" }, "groupId": { "format": "int64", "nullable": true, "type": "integer" }, "ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "priority": { "type": "string" }, "reason": { "type": "string" }, "status": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Tickets Bulk", "tags": [ "Admin" ] } }, "/api/admin/tickets/categories": { "get": { "description": "Auto-generated reference for `GET /api/admin/tickets/categories`.", "operationId": "get__api__admin__tickets__categories", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Tickets Categories", "tags": [ "Admin" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/tickets/categories`.", "operationId": "post__api__admin__tickets__categories", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "defaultGroupId": { "format": "int64", "nullable": true, "type": "integer" }, "defaultPriority": { "type": "string" }, "description": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "formSchema": { "items": { "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "options": { "items": { "type": "string" }, "type": "array" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "type": { "type": "string" } }, "type": "object" }, "type": "array" }, "key": { "type": "string" }, "name": { "type": "string" }, "parentId": { "format": "int64", "nullable": true, "type": "integer" }, "slaPolicyId": { "format": "int64", "nullable": true, "type": "integer" }, "sort": { "type": "integer" }, "userSubmittable": { "nullable": true, "type": "boolean" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "defaultGroupId": { "format": "int64", "nullable": true, "type": "integer" }, "defaultPriority": { "type": "string" }, "description": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "formSchema": { "items": { "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "options": { "items": { "type": "string" }, "type": "array" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "type": { "type": "string" } }, "type": "object" }, "type": "array" }, "key": { "type": "string" }, "name": { "type": "string" }, "parentId": { "format": "int64", "nullable": true, "type": "integer" }, "slaPolicyId": { "format": "int64", "nullable": true, "type": "integer" }, "sort": { "type": "integer" }, "userSubmittable": { "nullable": true, "type": "boolean" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Tickets Categories", "tags": [ "Admin" ] } }, "/api/admin/tickets/categories/{id}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/tickets/categories/{id}`.", "operationId": "delete__api__admin__tickets__categories___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Tickets Categories Id", "tags": [ "Admin" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/tickets/categories/{id}`.", "operationId": "put__api__admin__tickets__categories___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "defaultGroupId": { "format": "int64", "nullable": true, "type": "integer" }, "defaultPriority": { "type": "string" }, "description": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "formSchema": { "items": { "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "options": { "items": { "type": "string" }, "type": "array" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "type": { "type": "string" } }, "type": "object" }, "type": "array" }, "key": { "type": "string" }, "name": { "type": "string" }, "parentId": { "format": "int64", "nullable": true, "type": "integer" }, "slaPolicyId": { "format": "int64", "nullable": true, "type": "integer" }, "sort": { "type": "integer" }, "userSubmittable": { "nullable": true, "type": "boolean" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "defaultGroupId": { "format": "int64", "nullable": true, "type": "integer" }, "defaultPriority": { "type": "string" }, "description": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "formSchema": { "items": { "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "options": { "items": { "type": "string" }, "type": "array" }, "placeholder": { "type": "string" }, "required": { "type": "boolean" }, "type": { "type": "string" } }, "type": "object" }, "type": "array" }, "key": { "type": "string" }, "name": { "type": "string" }, "parentId": { "format": "int64", "nullable": true, "type": "integer" }, "slaPolicyId": { "format": "int64", "nullable": true, "type": "integer" }, "sort": { "type": "integer" }, "userSubmittable": { "nullable": true, "type": "boolean" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin Tickets Categories Id", "tags": [ "Admin" ] } }, "/api/admin/tickets/export": { "get": { "description": "Auto-generated reference for `GET /api/admin/tickets/export`.", "operationId": "get__api__admin__tickets__export", "parameters": [ { "in": "query", "name": "appid", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "priority", "schema": { "type": "string" } }, { "in": "query", "name": "categoryId", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "groupId", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "assigneeId", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "unassigned", "schema": { "type": "boolean" } }, { "in": "query", "name": "requesterId", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "keyword", "schema": { "type": "string" } }, { "in": "query", "name": "tags", "schema": { "type": "string" } }, { "in": "query", "name": "slaState", "schema": { "type": "string" } }, { "in": "query", "name": "overdueOnly", "schema": { "type": "boolean" } }, { "in": "query", "name": "createdFrom", "schema": { "type": "string" } }, { "in": "query", "name": "createdTo", "schema": { "type": "string" } }, { "in": "query", "name": "rated", "schema": { "type": "boolean" } }, { "in": "query", "name": "sortBy", "schema": { "type": "string" } }, { "in": "query", "name": "sortDir", "schema": { "type": "string" } }, { "in": "query", "name": "includeClosed", "schema": { "type": "boolean" } }, { "in": "query", "name": "mine", "schema": { "type": "boolean" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Tickets Export", "tags": [ "Admin" ] } }, "/api/admin/tickets/groups": { "get": { "description": "Auto-generated reference for `GET /api/admin/tickets/groups`.", "operationId": "get__api__admin__tickets__groups", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Tickets Groups", "tags": [ "Admin" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/tickets/groups`.", "operationId": "post__api__admin__tickets__groups", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "assignStrategy": { "type": "string" }, "description": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "key": { "type": "string" }, "name": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "assignStrategy": { "type": "string" }, "description": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "key": { "type": "string" }, "name": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Tickets Groups", "tags": [ "Admin" ] } }, "/api/admin/tickets/groups/{id}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/tickets/groups/{id}`.", "operationId": "delete__api__admin__tickets__groups___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Tickets Groups Id", "tags": [ "Admin" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/tickets/groups/{id}`.", "operationId": "put__api__admin__tickets__groups___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "assignStrategy": { "type": "string" }, "description": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "key": { "type": "string" }, "name": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "assignStrategy": { "type": "string" }, "description": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "key": { "type": "string" }, "name": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin Tickets Groups Id", "tags": [ "Admin" ] } }, "/api/admin/tickets/groups/{id}/members": { "put": { "description": "Auto-generated reference for `PUT /api/admin/tickets/groups/{id}/members`.", "operationId": "put__api__admin__tickets__groups___by_id__members", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "members": { "items": { "properties": { "adminId": { "format": "int64", "type": "integer" }, "role": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "members": { "items": { "properties": { "adminId": { "format": "int64", "type": "integer" }, "role": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin Tickets Groups Id Members", "tags": [ "Admin" ] } }, "/api/admin/tickets/metadata": { "get": { "description": "Auto-generated reference for `GET /api/admin/tickets/metadata`.", "operationId": "get__api__admin__tickets__metadata", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Tickets Metadata", "tags": [ "Admin" ] } }, "/api/admin/tickets/quick-replies": { "get": { "description": "Auto-generated reference for `GET /api/admin/tickets/quick-replies`.", "operationId": "get__api__admin__tickets__quick_dash_replies", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Tickets Quick Replies", "tags": [ "Admin" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/tickets/quick-replies`.", "operationId": "post__api__admin__tickets__quick_dash_replies", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "categoryId": { "format": "int64", "nullable": true, "type": "integer" }, "content": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "private": { "type": "boolean" }, "sort": { "type": "integer" }, "title": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "categoryId": { "format": "int64", "nullable": true, "type": "integer" }, "content": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "private": { "type": "boolean" }, "sort": { "type": "integer" }, "title": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Tickets Quick Replies", "tags": [ "Admin" ] } }, "/api/admin/tickets/quick-replies/{id}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/tickets/quick-replies/{id}`.", "operationId": "delete__api__admin__tickets__quick_dash_replies___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Tickets Quick Replies Id", "tags": [ "Admin" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/tickets/quick-replies/{id}`.", "operationId": "put__api__admin__tickets__quick_dash_replies___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "categoryId": { "format": "int64", "nullable": true, "type": "integer" }, "content": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "private": { "type": "boolean" }, "sort": { "type": "integer" }, "title": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "categoryId": { "format": "int64", "nullable": true, "type": "integer" }, "content": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "private": { "type": "boolean" }, "sort": { "type": "integer" }, "title": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin Tickets Quick Replies Id", "tags": [ "Admin" ] } }, "/api/admin/tickets/sla-policies": { "get": { "description": "Auto-generated reference for `GET /api/admin/tickets/sla-policies`.", "operationId": "get__api__admin__tickets__sla_dash_policies", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Tickets Sla Policies", "tags": [ "Admin" ] }, "post": { "description": "Auto-generated reference for `POST /api/admin/tickets/sla-policies`.", "operationId": "post__api__admin__tickets__sla_dash_policies", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "businessHours": { "nullable": true, "properties": { "days": { "items": { "type": "integer" }, "type": "array" }, "end": { "type": "string" }, "start": { "type": "string" }, "timezone": { "type": "string" } }, "type": "object" }, "description": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "firstResponseMinutes": { "additionalProperties": { "type": "integer" }, "type": "object" }, "name": { "type": "string" }, "resolveMinutes": { "additionalProperties": { "type": "integer" }, "type": "object" }, "warnRatio": { "format": "double", "type": "number" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "businessHours": { "nullable": true, "properties": { "days": { "items": { "type": "integer" }, "type": "array" }, "end": { "type": "string" }, "start": { "type": "string" }, "timezone": { "type": "string" } }, "type": "object" }, "description": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "firstResponseMinutes": { "additionalProperties": { "type": "integer" }, "type": "object" }, "name": { "type": "string" }, "resolveMinutes": { "additionalProperties": { "type": "integer" }, "type": "object" }, "warnRatio": { "format": "double", "type": "number" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Tickets Sla Policies", "tags": [ "Admin" ] } }, "/api/admin/tickets/sla-policies/{id}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/tickets/sla-policies/{id}`.", "operationId": "delete__api__admin__tickets__sla_dash_policies___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Tickets Sla Policies Id", "tags": [ "Admin" ] }, "put": { "description": "Auto-generated reference for `PUT /api/admin/tickets/sla-policies/{id}`.", "operationId": "put__api__admin__tickets__sla_dash_policies___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "businessHours": { "nullable": true, "properties": { "days": { "items": { "type": "integer" }, "type": "array" }, "end": { "type": "string" }, "start": { "type": "string" }, "timezone": { "type": "string" } }, "type": "object" }, "description": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "firstResponseMinutes": { "additionalProperties": { "type": "integer" }, "type": "object" }, "name": { "type": "string" }, "resolveMinutes": { "additionalProperties": { "type": "integer" }, "type": "object" }, "warnRatio": { "format": "double", "type": "number" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "businessHours": { "nullable": true, "properties": { "days": { "items": { "type": "integer" }, "type": "array" }, "end": { "type": "string" }, "start": { "type": "string" }, "timezone": { "type": "string" } }, "type": "object" }, "description": { "type": "string" }, "enabled": { "nullable": true, "type": "boolean" }, "firstResponseMinutes": { "additionalProperties": { "type": "integer" }, "type": "object" }, "name": { "type": "string" }, "resolveMinutes": { "additionalProperties": { "type": "integer" }, "type": "object" }, "warnRatio": { "format": "double", "type": "number" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin Tickets Sla Policies Id", "tags": [ "Admin" ] } }, "/api/admin/tickets/stats": { "get": { "description": "Auto-generated reference for `GET /api/admin/tickets/stats`.", "operationId": "get__api__admin__tickets__stats", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Tickets Stats", "tags": [ "Admin" ] } }, "/api/admin/tickets/trend": { "get": { "description": "Auto-generated reference for `GET /api/admin/tickets/trend`.", "operationId": "get__api__admin__tickets__trend", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Tickets Trend", "tags": [ "Admin" ] } }, "/api/admin/tickets/workbench": { "get": { "description": "Auto-generated reference for `GET /api/admin/tickets/workbench`.", "operationId": "get__api__admin__tickets__workbench", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Tickets Workbench", "tags": [ "Admin" ] } }, "/api/admin/tickets/{ticketId}": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/tickets/{ticketId}`.", "operationId": "delete__api__admin__tickets___by_ticketId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "ticketId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin Tickets TicketId", "tags": [ "Admin" ] }, "get": { "description": "Auto-generated reference for `GET /api/admin/tickets/{ticketId}`.", "operationId": "get__api__admin__tickets___by_ticketId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "ticketId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api Admin Tickets TicketId", "tags": [ "Admin" ] }, "patch": { "description": "Auto-generated reference for `PATCH /api/admin/tickets/{ticketId}`.", "operationId": "patch__api__admin__tickets___by_ticketId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "ticketId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "categoryId": { "format": "int64", "nullable": true, "type": "integer" }, "locked": { "nullable": true, "type": "boolean" }, "priority": { "nullable": true, "type": "string" }, "tags": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "title": { "nullable": true, "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "categoryId": { "format": "int64", "nullable": true, "type": "integer" }, "locked": { "nullable": true, "type": "boolean" }, "priority": { "nullable": true, "type": "string" }, "tags": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "title": { "nullable": true, "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PATCH Api Admin Tickets TicketId", "tags": [ "Admin" ] } }, "/api/admin/tickets/{ticketId}/assign": { "post": { "description": "Auto-generated reference for `POST /api/admin/tickets/{ticketId}/assign`.", "operationId": "post__api__admin__tickets___by_ticketId__assign", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "ticketId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "assigneeAdminId": { "format": "int64", "nullable": true, "type": "integer" }, "autoPick": { "type": "boolean" }, "groupId": { "format": "int64", "nullable": true, "type": "integer" }, "reason": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "assigneeAdminId": { "format": "int64", "nullable": true, "type": "integer" }, "autoPick": { "type": "boolean" }, "groupId": { "format": "int64", "nullable": true, "type": "integer" }, "reason": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Tickets TicketId Assign", "tags": [ "Admin" ] } }, "/api/admin/tickets/{ticketId}/replies": { "post": { "description": "Auto-generated reference for `POST /api/admin/tickets/{ticketId}/replies`.", "operationId": "post__api__admin__tickets___by_ticketId__replies", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "ticketId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "attachmentIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "content": { "type": "string" }, "contentType": { "type": "string" }, "internal": { "type": "boolean" }, "metadata": { "additionalProperties": {}, "type": "object" }, "nextStatus": { "type": "string" }, "quickReplyId": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "attachmentIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "content": { "type": "string" }, "contentType": { "type": "string" }, "internal": { "type": "boolean" }, "metadata": { "additionalProperties": {}, "type": "object" }, "nextStatus": { "type": "string" }, "quickReplyId": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Tickets TicketId Replies", "tags": [ "Admin" ] } }, "/api/admin/tickets/{ticketId}/status": { "post": { "description": "Auto-generated reference for `POST /api/admin/tickets/{ticketId}/status`.", "operationId": "post__api__admin__tickets___by_ticketId__status", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "ticketId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "reason": { "type": "string" }, "solution": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "reason": { "type": "string" }, "solution": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Tickets TicketId Status", "tags": [ "Admin" ] } }, "/api/admin/tickets/{ticketId}/watch": { "post": { "description": "Auto-generated reference for `POST /api/admin/tickets/{ticketId}/watch`.", "operationId": "post__api__admin__tickets___by_ticketId__watch", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "ticketId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin Tickets TicketId Watch", "tags": [ "Admin" ] } }, "/api/admin/tickets/{ticketId}/watchers": { "put": { "description": "Auto-generated reference for `PUT /api/admin/tickets/{ticketId}/watchers`.", "operationId": "put__api__admin__tickets___by_ticketId__watchers", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "ticketId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "adminIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "adminIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "PUT Api Admin Tickets TicketId Watchers", "tags": [ "Admin" ] } }, "/api/admin/user-settings/batch-initialize": { "post": { "description": "Auto-generated reference for `POST /api/admin/user-settings/batch-initialize`.", "operationId": "post__api__admin__user_dash_settings__batch_dash_initialize", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "batchSize": { "type": "integer" }, "categories": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "batchSize": { "type": "integer" }, "categories": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin User Settings Batch Initialize", "tags": [ "Admin" ] } }, "/api/admin/user-settings/check-integrity": { "get": { "description": "Checks application user settings integrity and optionally repairs invalid records.", "operationId": "get__api__admin__user_dash_settings__check_dash_integrity", "parameters": [ { "in": "query", "name": "appid", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "autoRepair", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "Check Settings Integrity", "tags": [ "Admin Settings" ] } }, "/api/admin/user-settings/cleanup": { "delete": { "description": "Auto-generated reference for `DELETE /api/admin/user-settings/cleanup`.", "operationId": "delete__api__admin__user_dash_settings__cleanup", "requestBody": { "content": { "application/json": { "schema": { "properties": { "AppID": { "format": "int64", "type": "integer" }, "DryRun": { "nullable": true, "type": "boolean" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "AppID": { "format": "int64", "type": "integer" }, "DryRun": { "nullable": true, "type": "boolean" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "DELETE Api Admin User Settings Cleanup", "tags": [ "Admin" ] } }, "/api/admin/user-settings/initialize-user": { "post": { "description": "Auto-generated reference for `POST /api/admin/user-settings/initialize-user`.", "operationId": "post__api__admin__user_dash_settings__initialize_dash_user", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "categories": { "items": { "type": "string" }, "type": "array" }, "userId": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "categories": { "items": { "type": "string" }, "type": "array" }, "userId": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api Admin User Settings Initialize User", "tags": [ "Admin" ] } }, "/api/admin/user-settings/stats": { "get": { "description": "Returns settings statistics for the specified application.", "operationId": "get__api__admin__user_dash_settings__stats", "parameters": [ { "in": "query", "name": "appid", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "Get User Settings Stats", "tags": [ "Admin Settings" ] } }, "/api/admin/user-settings/user": { "get": { "description": "Returns settings for a specific user under an application.", "operationId": "get__api__admin__user_dash_settings__user", "parameters": [ { "in": "query", "name": "appid", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "userId", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "Get User Settings Detail", "tags": [ "Admin Settings" ] } }, "/api/app/password-policy/get": { "post": { "description": "Auto-generated reference for `POST /api/app/password-policy/get`.", "operationId": "post__api__app__password_dash_policy__get", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Password Policy Get", "tags": [ "App Compat" ] } }, "/api/app/password-policy/reset": { "post": { "description": "Auto-generated reference for `POST /api/app/password-policy/reset`.", "operationId": "post__api__app__password_dash_policy__reset", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Password Policy Reset", "tags": [ "App Compat" ] } }, "/api/app/password-policy/set": { "post": { "description": "Auto-generated reference for `POST /api/app/password-policy/set`.", "operationId": "post__api__app__password_dash_policy__set", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "policy": { "properties": { "description": { "type": "string" }, "isDefault": { "type": "boolean" }, "maxAge": { "type": "integer" }, "maxLength": { "type": "integer" }, "minLength": { "type": "integer" }, "minScore": { "type": "integer" }, "name": { "type": "string" }, "preventReuse": { "type": "integer" }, "requireLowercase": { "type": "boolean" }, "requireNumbers": { "type": "boolean" }, "requireSpecialChars": { "type": "boolean" }, "requireUppercase": { "type": "boolean" } }, "type": "object" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "policy": { "properties": { "description": { "type": "string" }, "isDefault": { "type": "boolean" }, "maxAge": { "type": "integer" }, "maxLength": { "type": "integer" }, "minLength": { "type": "integer" }, "minScore": { "type": "integer" }, "name": { "type": "string" }, "preventReuse": { "type": "integer" }, "requireLowercase": { "type": "boolean" }, "requireNumbers": { "type": "boolean" }, "requireSpecialChars": { "type": "boolean" }, "requireUppercase": { "type": "boolean" } }, "type": "object" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Password Policy Set", "tags": [ "App Compat" ] } }, "/api/app/password-policy/templates": { "get": { "description": "Auto-generated reference for `GET /api/app/password-policy/templates`.", "operationId": "get__api__app__password_dash_policy__templates", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "GET Api App Password Policy Templates", "tags": [ "App Compat" ] } }, "/api/app/password-policy/test": { "post": { "description": "Auto-generated reference for `POST /api/app/password-policy/test`.", "operationId": "post__api__app__password_dash_policy__test", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "password": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "password": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Password Policy Test", "tags": [ "App Compat" ] } }, "/api/app/points/adjust-experience": { "post": { "description": "Auto-generated reference for `POST /api/app/points/adjust-experience`.", "operationId": "post__api__app__points__adjust_dash_experience", "requestBody": { "content": { "application/json": { "schema": { "properties": { "amount": { "format": "int64", "type": "integer" }, "appid": { "format": "int64", "type": "integer" }, "reason": { "type": "string" }, "user_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "amount": { "format": "int64", "type": "integer" }, "appid": { "format": "int64", "type": "integer" }, "reason": { "type": "string" }, "user_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Points Adjust Experience", "tags": [ "App Compat" ] } }, "/api/app/points/adjust-integral": { "post": { "description": "Auto-generated reference for `POST /api/app/points/adjust-integral`.", "operationId": "post__api__app__points__adjust_dash_integral", "requestBody": { "content": { "application/json": { "schema": { "properties": { "amount": { "format": "int64", "type": "integer" }, "appid": { "format": "int64", "type": "integer" }, "reason": { "type": "string" }, "user_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "amount": { "format": "int64", "type": "integer" }, "appid": { "format": "int64", "type": "integer" }, "reason": { "type": "string" }, "user_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Points Adjust Integral", "tags": [ "App Compat" ] } }, "/api/app/points/batch-adjust": { "post": { "description": "Auto-generated reference for `POST /api/app/points/batch-adjust`.", "operationId": "post__api__app__points__batch_dash_adjust", "requestBody": { "content": { "application/json": { "schema": { "properties": { "amount": { "format": "int64", "type": "integer" }, "appid": { "format": "int64", "type": "integer" }, "operation_type": { "type": "string" }, "reason": { "type": "string" }, "user_ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "amount": { "format": "int64", "type": "integer" }, "appid": { "format": "int64", "type": "integer" }, "operation_type": { "type": "string" }, "reason": { "type": "string" }, "user_ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Points Batch Adjust", "tags": [ "App Compat" ] } }, "/api/app/points/stats": { "post": { "description": "Auto-generated reference for `POST /api/app/points/stats`.", "operationId": "post__api__app__points__stats", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "time_range": { "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "time_range": { "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Points Stats", "tags": [ "App Compat" ] } }, "/api/app/public": { "get": { "description": "Returns public application metadata and resolved policy by application identifier.", "operationId": "get__api__app__public", "parameters": [ { "in": "query", "name": "appid", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "Get Public App Profile", "tags": [ "App" ] } }, "/api/app/workflow/create": { "post": { "description": "Auto-generated reference for `POST /api/app/workflow/create`.", "operationId": "post__api__app__workflow__create", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "category": { "type": "string" }, "definition": { "additionalProperties": {}, "type": "object" }, "description": { "type": "string" }, "name": { "type": "string" }, "permissions": { "additionalProperties": {}, "type": "object" }, "status": { "type": "string" }, "trigger_config": { "additionalProperties": {}, "type": "object" }, "ui_config": { "additionalProperties": {}, "type": "object" }, "workflow_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "category": { "type": "string" }, "definition": { "additionalProperties": {}, "type": "object" }, "description": { "type": "string" }, "name": { "type": "string" }, "permissions": { "additionalProperties": {}, "type": "object" }, "status": { "type": "string" }, "trigger_config": { "additionalProperties": {}, "type": "object" }, "ui_config": { "additionalProperties": {}, "type": "object" }, "workflow_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Workflow Create", "tags": [ "Workflow" ] } }, "/api/app/workflow/create-from-template": { "post": { "description": "Auto-generated reference for `POST /api/app/workflow/create-from-template`.", "operationId": "post__api__app__workflow__create_dash_from_dash_template", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "description": { "type": "string" }, "name": { "type": "string" }, "template_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "description": { "type": "string" }, "name": { "type": "string" }, "template_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Workflow Create From Template", "tags": [ "Workflow" ] } }, "/api/app/workflow/delete": { "post": { "description": "Auto-generated reference for `POST /api/app/workflow/delete`.", "operationId": "post__api__app__workflow__delete", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "workflow_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "workflow_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Workflow Delete", "tags": [ "Workflow" ] } }, "/api/app/workflow/detail": { "post": { "description": "Auto-generated reference for `POST /api/app/workflow/detail`.", "operationId": "post__api__app__workflow__detail", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "workflow_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "workflow_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Workflow Detail", "tags": [ "Workflow" ] } }, "/api/app/workflow/engine/status": { "post": { "description": "Auto-generated reference for `POST /api/app/workflow/engine/status`.", "operationId": "post__api__app__workflow__engine__status", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Workflow Engine Status", "tags": [ "Workflow" ] } }, "/api/app/workflow/info": { "post": { "description": "Auto-generated reference for `POST /api/app/workflow/info`.", "operationId": "post__api__app__workflow__info", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "workflow_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "workflow_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Workflow Info", "tags": [ "Workflow" ] } }, "/api/app/workflow/instance/cancel": { "post": { "description": "Auto-generated reference for `POST /api/app/workflow/instance/cancel`.", "operationId": "post__api__app__workflow__instance__cancel", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "instanceId": { "format": "int64", "type": "integer" }, "instance_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "instanceId": { "format": "int64", "type": "integer" }, "instance_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Workflow Instance Cancel", "tags": [ "Workflow" ] } }, "/api/app/workflow/instance/detail": { "post": { "description": "Auto-generated reference for `POST /api/app/workflow/instance/detail`.", "operationId": "post__api__app__workflow__instance__detail", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "instanceId": { "format": "int64", "type": "integer" }, "instance_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "instanceId": { "format": "int64", "type": "integer" }, "instance_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Workflow Instance Detail", "tags": [ "Workflow" ] } }, "/api/app/workflow/instance/pause": { "post": { "description": "Auto-generated reference for `POST /api/app/workflow/instance/pause`.", "operationId": "post__api__app__workflow__instance__pause", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "instanceId": { "format": "int64", "type": "integer" }, "instance_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "instanceId": { "format": "int64", "type": "integer" }, "instance_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Workflow Instance Pause", "tags": [ "Workflow" ] } }, "/api/app/workflow/instance/resume": { "post": { "description": "Auto-generated reference for `POST /api/app/workflow/instance/resume`.", "operationId": "post__api__app__workflow__instance__resume", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "instanceId": { "format": "int64", "type": "integer" }, "instance_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "instanceId": { "format": "int64", "type": "integer" }, "instance_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Workflow Instance Resume", "tags": [ "Workflow" ] } }, "/api/app/workflow/instances": { "post": { "description": "Auto-generated reference for `POST /api/app/workflow/instances`.", "operationId": "post__api__app__workflow__instances", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "status": { "type": "string" }, "workflowId": { "format": "int64", "type": "integer" }, "workflow_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "status": { "type": "string" }, "workflowId": { "format": "int64", "type": "integer" }, "workflow_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Workflow Instances", "tags": [ "Workflow" ] } }, "/api/app/workflow/instances/cancel": { "post": { "description": "Auto-generated reference for `POST /api/app/workflow/instances/cancel`.", "operationId": "post__api__app__workflow__instances__cancel", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "instanceId": { "format": "int64", "type": "integer" }, "instance_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "instanceId": { "format": "int64", "type": "integer" }, "instance_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Workflow Instances Cancel", "tags": [ "Workflow" ] } }, "/api/app/workflow/instances/info": { "post": { "description": "Auto-generated reference for `POST /api/app/workflow/instances/info`.", "operationId": "post__api__app__workflow__instances__info", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "instanceId": { "format": "int64", "type": "integer" }, "instance_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "instanceId": { "format": "int64", "type": "integer" }, "instance_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Workflow Instances Info", "tags": [ "Workflow" ] } }, "/api/app/workflow/instances/list": { "post": { "description": "Auto-generated reference for `POST /api/app/workflow/instances/list`.", "operationId": "post__api__app__workflow__instances__list", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "status": { "type": "string" }, "workflowId": { "format": "int64", "type": "integer" }, "workflow_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "status": { "type": "string" }, "workflowId": { "format": "int64", "type": "integer" }, "workflow_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Workflow Instances List", "tags": [ "Workflow" ] } }, "/api/app/workflow/instances/pause": { "post": { "description": "Auto-generated reference for `POST /api/app/workflow/instances/pause`.", "operationId": "post__api__app__workflow__instances__pause", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "instanceId": { "format": "int64", "type": "integer" }, "instance_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "instanceId": { "format": "int64", "type": "integer" }, "instance_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Workflow Instances Pause", "tags": [ "Workflow" ] } }, "/api/app/workflow/instances/resume": { "post": { "description": "Auto-generated reference for `POST /api/app/workflow/instances/resume`.", "operationId": "post__api__app__workflow__instances__resume", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "instanceId": { "format": "int64", "type": "integer" }, "instance_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "instanceId": { "format": "int64", "type": "integer" }, "instance_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Workflow Instances Resume", "tags": [ "Workflow" ] } }, "/api/app/workflow/list": { "post": { "description": "Auto-generated reference for `POST /api/app/workflow/list`.", "operationId": "post__api__app__workflow__list", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "category": { "type": "string" }, "keyword": { "type": "string" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "status": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "category": { "type": "string" }, "keyword": { "type": "string" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "status": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Workflow List", "tags": [ "Workflow" ] } }, "/api/app/workflow/logs": { "post": { "description": "Auto-generated reference for `POST /api/app/workflow/logs`.", "operationId": "post__api__app__workflow__logs", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "instance_id": { "format": "int64", "type": "integer" }, "limit": { "type": "integer" }, "workflow_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "instance_id": { "format": "int64", "type": "integer" }, "limit": { "type": "integer" }, "workflow_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Workflow Logs", "tags": [ "Workflow" ] } }, "/api/app/workflow/node-types": { "post": { "description": "Auto-generated reference for `POST /api/app/workflow/node-types`.", "operationId": "post__api__app__workflow__node_dash_types", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Workflow Node Types", "tags": [ "Workflow" ] } }, "/api/app/workflow/save-as-template": { "post": { "description": "Auto-generated reference for `POST /api/app/workflow/save-as-template`.", "operationId": "post__api__app__workflow__save_dash_as_dash_template", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "category": { "type": "string" }, "is_public": { "type": "boolean" }, "template_description": { "type": "string" }, "template_name": { "type": "string" }, "workflow_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "category": { "type": "string" }, "is_public": { "type": "boolean" }, "template_description": { "type": "string" }, "template_name": { "type": "string" }, "workflow_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Workflow Save As Template", "tags": [ "Workflow" ] } }, "/api/app/workflow/start": { "post": { "description": "Auto-generated reference for `POST /api/app/workflow/start`.", "operationId": "post__api__app__workflow__start", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "input_data": { "additionalProperties": {}, "type": "object" }, "instance_name": { "type": "string" }, "priority": { "type": "integer" }, "workflowId": { "format": "int64", "type": "integer" }, "workflow_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "input_data": { "additionalProperties": {}, "type": "object" }, "instance_name": { "type": "string" }, "priority": { "type": "integer" }, "workflowId": { "format": "int64", "type": "integer" }, "workflow_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Workflow Start", "tags": [ "Workflow" ] } }, "/api/app/workflow/statistics": { "post": { "description": "Auto-generated reference for `POST /api/app/workflow/statistics`.", "operationId": "post__api__app__workflow__statistics", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Workflow Statistics", "tags": [ "Workflow" ] } }, "/api/app/workflow/task/assign": { "post": { "description": "Auto-generated reference for `POST /api/app/workflow/task/assign`.", "operationId": "post__api__app__workflow__task__assign", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "assigned_to": { "format": "int64", "type": "integer" }, "comment": { "type": "string" }, "task_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "assigned_to": { "format": "int64", "type": "integer" }, "comment": { "type": "string" }, "task_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Workflow Task Assign", "tags": [ "Workflow" ] } }, "/api/app/workflow/task/complete": { "post": { "description": "Auto-generated reference for `POST /api/app/workflow/task/complete`.", "operationId": "post__api__app__workflow__task__complete", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "comment": { "type": "string" }, "output_data": { "additionalProperties": {}, "type": "object" }, "taskId": { "format": "int64", "type": "integer" }, "task_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "comment": { "type": "string" }, "output_data": { "additionalProperties": {}, "type": "object" }, "taskId": { "format": "int64", "type": "integer" }, "task_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Workflow Task Complete", "tags": [ "Workflow" ] } }, "/api/app/workflow/task/detail": { "post": { "description": "Auto-generated reference for `POST /api/app/workflow/task/detail`.", "operationId": "post__api__app__workflow__task__detail", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "task_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "task_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Workflow Task Detail", "tags": [ "Workflow" ] } }, "/api/app/workflow/task/history": { "post": { "description": "Auto-generated reference for `POST /api/app/workflow/task/history`.", "operationId": "post__api__app__workflow__task__history", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "task_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "task_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Workflow Task History", "tags": [ "Workflow" ] } }, "/api/app/workflow/tasks/complete": { "post": { "description": "Auto-generated reference for `POST /api/app/workflow/tasks/complete`.", "operationId": "post__api__app__workflow__tasks__complete", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "comment": { "type": "string" }, "output_data": { "additionalProperties": {}, "type": "object" }, "taskId": { "format": "int64", "type": "integer" }, "task_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "comment": { "type": "string" }, "output_data": { "additionalProperties": {}, "type": "object" }, "taskId": { "format": "int64", "type": "integer" }, "task_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Workflow Tasks Complete", "tags": [ "Workflow" ] } }, "/api/app/workflow/tasks/todo": { "post": { "description": "Auto-generated reference for `POST /api/app/workflow/tasks/todo`.", "operationId": "post__api__app__workflow__tasks__todo", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "priority": { "type": "integer" }, "status": { "type": "string" }, "user_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "priority": { "type": "integer" }, "status": { "type": "string" }, "user_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Workflow Tasks Todo", "tags": [ "Workflow" ] } }, "/api/app/workflow/templates": { "post": { "description": "Auto-generated reference for `POST /api/app/workflow/templates`.", "operationId": "post__api__app__workflow__templates", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "category": { "type": "string" }, "limit": { "type": "integer" }, "page": { "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "category": { "type": "string" }, "limit": { "type": "integer" }, "page": { "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Workflow Templates", "tags": [ "Workflow" ] } }, "/api/app/workflow/templates/create": { "post": { "description": "Auto-generated reference for `POST /api/app/workflow/templates/create`.", "operationId": "post__api__app__workflow__templates__create", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "description": { "type": "string" }, "name": { "type": "string" }, "template_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "description": { "type": "string" }, "name": { "type": "string" }, "template_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Workflow Templates Create", "tags": [ "Workflow" ] } }, "/api/app/workflow/templates/list": { "post": { "description": "Auto-generated reference for `POST /api/app/workflow/templates/list`.", "operationId": "post__api__app__workflow__templates__list", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "category": { "type": "string" }, "limit": { "type": "integer" }, "page": { "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "category": { "type": "string" }, "limit": { "type": "integer" }, "page": { "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Workflow Templates List", "tags": [ "Workflow" ] } }, "/api/app/workflow/update": { "post": { "description": "Auto-generated reference for `POST /api/app/workflow/update`.", "operationId": "post__api__app__workflow__update", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "category": { "type": "string" }, "definition": { "additionalProperties": {}, "type": "object" }, "description": { "type": "string" }, "name": { "type": "string" }, "permissions": { "additionalProperties": {}, "type": "object" }, "status": { "type": "string" }, "trigger_config": { "additionalProperties": {}, "type": "object" }, "ui_config": { "additionalProperties": {}, "type": "object" }, "workflow_id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "category": { "type": "string" }, "definition": { "additionalProperties": {}, "type": "object" }, "description": { "type": "string" }, "name": { "type": "string" }, "permissions": { "additionalProperties": {}, "type": "object" }, "status": { "type": "string" }, "trigger_config": { "additionalProperties": {}, "type": "object" }, "ui_config": { "additionalProperties": {}, "type": "object" }, "workflow_id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Workflow Update", "tags": [ "Workflow" ] } }, "/api/app/workflow/validate": { "post": { "description": "Auto-generated reference for `POST /api/app/workflow/validate`.", "operationId": "post__api__app__workflow__validate", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "definition": { "additionalProperties": {}, "type": "object" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "definition": { "additionalProperties": {}, "type": "object" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "adminBearerAuth": [] }, { "xAdminToken": [] } ], "summary": "POST Api App Workflow Validate", "tags": [ "Workflow" ] } }, "/api/apps/{appkey}/functions/{functionName}/invoke": { "post": { "description": "Auto-generated reference for `POST /api/apps/{appkey}/functions/{functionName}/invoke`.", "operationId": "post__api__apps___by_appkey__functions___by_functionName__invoke", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "functionName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "eventId": { "type": "string" }, "input": {} }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "eventId": { "type": "string" }, "input": {} }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api Apps Appkey Functions FunctionName Invoke", "tags": [ "API" ] } }, "/api/apps/{appkey}/vip/verify": { "post": { "description": "Auto-generated reference for `POST /api/apps/{appkey}/vip/verify`.", "operationId": "post__api__apps___by_appkey__vip__verify", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "accessToken": { "type": "string" }, "feature": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "accessToken": { "type": "string" }, "feature": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api Apps Appkey Vip Verify", "tags": [ "API" ] } }, "/api/auth/2fa/verify": { "post": { "description": "Auto-generated reference for `POST /api/auth/2fa/verify`.", "operationId": "post__api__auth__2fa__verify", "requestBody": { "content": { "application/json": { "schema": { "properties": { "challengeId": { "type": "string" }, "code": { "type": "string" }, "recoveryCode": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "challengeId": { "type": "string" }, "code": { "type": "string" }, "recoveryCode": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api Auth 2fa Verify", "tags": [ "Auth" ] } }, "/api/auth/login/password": { "post": { "description": "Authenticates a user with account and password and returns an access session payload.", "operationId": "post__api__auth__login__password", "requestBody": { "content": { "application/json": { "schema": { "properties": { "account": { "type": "string" }, "appid": { "format": "int64", "type": "integer" }, "captchaAnswer": { "type": "string" }, "captchaId": { "type": "string" }, "device": { "type": "string" }, "deviceId": { "type": "string" }, "markcode": { "type": "string" }, "password": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "account": { "type": "string" }, "appid": { "format": "int64", "type": "integer" }, "captchaAnswer": { "type": "string" }, "captchaId": { "type": "string" }, "device": { "type": "string" }, "deviceId": { "type": "string" }, "markcode": { "type": "string" }, "password": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "Password Login", "tags": [ "Auth" ] } }, "/api/auth/logout": { "post": { "description": "Revokes the current access session.", "operationId": "post__api__auth__logout", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "Logout", "tags": [ "Auth" ] } }, "/api/auth/oauth2/auth-url": { "post": { "description": "Auto-generated reference for `POST /api/auth/oauth2/auth-url`.", "operationId": "post__api__auth__oauth2__auth_dash_url", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "device": { "type": "string" }, "deviceId": { "type": "string" }, "markcode": { "type": "string" }, "provider": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "device": { "type": "string" }, "deviceId": { "type": "string" }, "markcode": { "type": "string" }, "provider": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "POST Api Auth Oauth2 Auth Url", "tags": [ "Auth" ] } }, "/api/auth/oauth2/bind-url": { "post": { "description": "Auto-generated reference for `POST /api/auth/oauth2/bind-url`.", "operationId": "post__api__auth__oauth2__bind_dash_url", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device": { "type": "string" }, "deviceId": { "type": "string" }, "markCode": { "type": "string" }, "provider": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "device": { "type": "string" }, "deviceId": { "type": "string" }, "markCode": { "type": "string" }, "provider": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api Auth Oauth2 Bind Url", "tags": [ "Auth" ] } }, "/api/auth/oauth2/bindings": { "get": { "description": "Auto-generated reference for `GET /api/auth/oauth2/bindings`.", "operationId": "get__api__auth__oauth2__bindings", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Auth Oauth2 Bindings", "tags": [ "Auth" ] } }, "/api/auth/oauth2/bindings/{provider}": { "delete": { "description": "Auto-generated reference for `DELETE /api/auth/oauth2/bindings/{provider}`.", "operationId": "delete__api__auth__oauth2__bindings___by_provider", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "provider", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "DELETE Api Auth Oauth2 Bindings Provider", "tags": [ "Auth" ] } }, "/api/auth/oauth2/callback": { "get": { "description": "Consumes the OAuth2 provider callback parameters and finalizes sign-in.", "operationId": "get__api__auth__oauth2__callback", "parameters": [ { "in": "query", "name": "provider", "schema": { "type": "string" } }, { "in": "query", "name": "code", "schema": { "type": "string" } }, { "in": "query", "name": "state", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "OAuth2 Callback", "tags": [ "Auth" ] } }, "/api/auth/oauth2/mobile-login": { "post": { "description": "Auto-generated reference for `POST /api/auth/oauth2/mobile-login`.", "operationId": "post__api__auth__oauth2__mobile_dash_login", "requestBody": { "content": { "application/json": { "schema": { "properties": { "accessToken": { "type": "string" }, "appid": { "format": "int64", "type": "integer" }, "avatar": { "type": "string" }, "device": { "type": "string" }, "deviceId": { "type": "string" }, "email": { "type": "string" }, "markcode": { "type": "string" }, "nickname": { "type": "string" }, "provider": { "type": "string" }, "providerUserId": { "type": "string" }, "rawProfile": { "additionalProperties": {}, "type": "object" }, "refreshToken": { "type": "string" }, "unionId": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "accessToken": { "type": "string" }, "appid": { "format": "int64", "type": "integer" }, "avatar": { "type": "string" }, "device": { "type": "string" }, "deviceId": { "type": "string" }, "email": { "type": "string" }, "markcode": { "type": "string" }, "nickname": { "type": "string" }, "provider": { "type": "string" }, "providerUserId": { "type": "string" }, "rawProfile": { "additionalProperties": {}, "type": "object" }, "refreshToken": { "type": "string" }, "unionId": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "POST Api Auth Oauth2 Mobile Login", "tags": [ "Auth" ] } }, "/api/auth/oauth2/providers": { "get": { "description": "Auto-generated reference for `GET /api/auth/oauth2/providers`.", "operationId": "get__api__auth__oauth2__providers", "parameters": [ { "in": "query", "name": "appid", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Auth Oauth2 Providers", "tags": [ "Auth" ] } }, "/api/auth/passkey/auth-options": { "post": { "description": "Auto-generated reference for `POST /api/auth/passkey/auth-options`.", "operationId": "post__api__auth__passkey__auth_dash_options", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "device": { "type": "string" }, "deviceId": { "type": "string" }, "markcode": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "device": { "type": "string" }, "deviceId": { "type": "string" }, "markcode": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api Auth Passkey Auth Options", "tags": [ "Auth" ] } }, "/api/auth/passkey/login": { "post": { "description": "Auto-generated reference for `POST /api/auth/passkey/login`.", "operationId": "post__api__auth__passkey__login", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "challengeId": { "type": "string" }, "credential": {}, "device": { "type": "string" }, "deviceId": { "type": "string" }, "markcode": { "type": "string" }, "payload": {} }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "challengeId": { "type": "string" }, "credential": {}, "device": { "type": "string" }, "deviceId": { "type": "string" }, "markcode": { "type": "string" }, "payload": {} }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api Auth Passkey Login", "tags": [ "Auth" ] } }, "/api/auth/passkey/options": { "post": { "description": "Auto-generated reference for `POST /api/auth/passkey/options`.", "operationId": "post__api__auth__passkey__options", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "device": { "type": "string" }, "deviceId": { "type": "string" }, "markcode": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "device": { "type": "string" }, "deviceId": { "type": "string" }, "markcode": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api Auth Passkey Options", "tags": [ "Auth" ] } }, "/api/auth/passkey/verify": { "post": { "description": "Auto-generated reference for `POST /api/auth/passkey/verify`.", "operationId": "post__api__auth__passkey__verify", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "challengeId": { "type": "string" }, "credential": {}, "device": { "type": "string" }, "deviceId": { "type": "string" }, "markcode": { "type": "string" }, "payload": {} }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "challengeId": { "type": "string" }, "credential": {}, "device": { "type": "string" }, "deviceId": { "type": "string" }, "markcode": { "type": "string" }, "payload": {} }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api Auth Passkey Verify", "tags": [ "Auth" ] } }, "/api/auth/password/change": { "post": { "description": "Auto-generated reference for `POST /api/auth/password/change`.", "operationId": "post__api__auth__password__change", "requestBody": { "content": { "application/json": { "schema": { "properties": { "currentPassword": { "type": "string" }, "newPassword": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "currentPassword": { "type": "string" }, "newPassword": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api Auth Password Change", "tags": [ "Auth" ] } }, "/api/auth/password/verify": { "post": { "description": "Auto-generated reference for `POST /api/auth/password/verify`.", "operationId": "post__api__auth__password__verify", "requestBody": { "content": { "application/json": { "schema": { "properties": { "password": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "password": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api Auth Password Verify", "tags": [ "Auth" ] } }, "/api/auth/refresh": { "post": { "description": "Refreshes an access session using a refresh token payload.", "operationId": "post__api__auth__refresh", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device": { "type": "string" }, "deviceId": { "type": "string" }, "markcode": { "type": "string" }, "refreshToken": { "type": "string" }, "token": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "device": { "type": "string" }, "deviceId": { "type": "string" }, "markcode": { "type": "string" }, "refreshToken": { "type": "string" }, "token": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "Refresh Token", "tags": [ "Auth" ] } }, "/api/auth/register/password": { "post": { "description": "Creates a user account for the target application.", "operationId": "post__api__auth__register__password", "requestBody": { "content": { "application/json": { "schema": { "properties": { "account": { "type": "string" }, "appid": { "format": "int64", "type": "integer" }, "captchaAnswer": { "type": "string" }, "captchaId": { "type": "string" }, "device": { "type": "string" }, "deviceId": { "type": "string" }, "markcode": { "type": "string" }, "nickname": { "type": "string" }, "password": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "account": { "type": "string" }, "appid": { "format": "int64", "type": "integer" }, "captchaAnswer": { "type": "string" }, "captchaId": { "type": "string" }, "device": { "type": "string" }, "deviceId": { "type": "string" }, "markcode": { "type": "string" }, "nickname": { "type": "string" }, "password": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "Password Register", "tags": [ "Auth" ] } }, "/api/avatar/{hash}": { "get": { "description": "Auto-generated reference for `GET /api/avatar/{hash}`.", "operationId": "get__api__avatar___by_hash", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "hash", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Avatar Hash", "tags": [ "API" ] } }, "/api/avatars/{token}": { "get": { "description": "Auto-generated reference for `GET /api/avatars/{token}`.", "operationId": "get__api__avatars___by_token", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "token", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Avatars Token", "tags": [ "API" ] } }, "/api/captcha/generate": { "post": { "description": "Auto-generated reference for `POST /api/captcha/generate`.", "operationId": "post__api__captcha__generate", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "purpose": { "type": "string" }, "type": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "purpose": { "type": "string" }, "type": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api Captcha Generate", "tags": [ "API" ] } }, "/api/captcha/public-config": { "get": { "description": "Auto-generated reference for `GET /api/captcha/public-config`.", "operationId": "get__api__captcha__public_dash_config", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Captcha Public Config", "tags": [ "API" ] } }, "/api/captcha/sms/send": { "post": { "description": "Auto-generated reference for `POST /api/captcha/sms/send`.", "operationId": "post__api__captcha__sms__send", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "captchaAnswer": { "type": "string" }, "captchaId": { "type": "string" }, "phone": { "type": "string" }, "purpose": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "captchaAnswer": { "type": "string" }, "captchaId": { "type": "string" }, "phone": { "type": "string" }, "purpose": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api Captcha Sms Send", "tags": [ "API" ] } }, "/api/captcha/sms/verify": { "post": { "description": "Auto-generated reference for `POST /api/captcha/sms/verify`.", "operationId": "post__api__captcha__sms__verify", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "code": { "type": "string" }, "phone": { "type": "string" }, "purpose": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "code": { "type": "string" }, "phone": { "type": "string" }, "purpose": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api Captcha Sms Verify", "tags": [ "API" ] } }, "/api/captcha/verify": { "post": { "description": "Auto-generated reference for `POST /api/captcha/verify`.", "operationId": "post__api__captcha__verify", "requestBody": { "content": { "application/json": { "schema": { "properties": { "answer": { "type": "string" }, "captchaId": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "answer": { "type": "string" }, "captchaId": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api Captcha Verify", "tags": [ "API" ] } }, "/api/captcha/verify-click": { "post": { "description": "Auto-generated reference for `POST /api/captcha/verify-click`.", "operationId": "post__api__captcha__verify_dash_click", "requestBody": { "content": { "application/json": { "schema": { "properties": { "captchaId": { "type": "string" }, "clicks": { "items": { "properties": { "x": { "format": "double", "type": "number" }, "y": { "format": "double", "type": "number" } }, "type": "object" }, "type": "array" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "captchaId": { "type": "string" }, "clicks": { "items": { "properties": { "x": { "format": "double", "type": "number" }, "y": { "format": "double", "type": "number" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api Captcha Verify Click", "tags": [ "API" ] } }, "/api/email/send-code": { "post": { "description": "Auto-generated reference for `POST /api/email/send-code`.", "operationId": "post__api__email__send_dash_code", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config_name": { "type": "string" }, "email": { "type": "string" }, "expireMinutes": { "type": "integer" }, "purpose": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config_name": { "type": "string" }, "email": { "type": "string" }, "expireMinutes": { "type": "integer" }, "purpose": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "POST Api Email Send Code", "tags": [ "Email" ] } }, "/api/email/send-password-reset": { "post": { "description": "Auto-generated reference for `POST /api/email/send-password-reset`.", "operationId": "post__api__email__send_dash_password_dash_reset", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config_name": { "type": "string" }, "email": { "type": "string" }, "resetUrl": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "config_name": { "type": "string" }, "email": { "type": "string" }, "resetUrl": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "POST Api Email Send Password Reset", "tags": [ "Email" ] } }, "/api/email/verify-code": { "post": { "description": "Auto-generated reference for `POST /api/email/verify-code`.", "operationId": "post__api__email__verify_dash_code", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "code": { "type": "string" }, "email": { "type": "string" }, "purpose": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "code": { "type": "string" }, "email": { "type": "string" }, "purpose": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "POST Api Email Verify Code", "tags": [ "Email" ] } }, "/api/email/verify-reset-token": { "post": { "description": "Auto-generated reference for `POST /api/email/verify-reset-token`.", "operationId": "post__api__email__verify_dash_reset_dash_token", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "email": { "type": "string" }, "token": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "email": { "type": "string" }, "token": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "POST Api Email Verify Reset Token", "tags": [ "Email" ] } }, "/api/email/webhook/aliyun/{scope}": { "post": { "description": "Auto-generated reference for `POST /api/email/webhook/aliyun/{scope}`.", "operationId": "post__api__email__webhook__aliyun___by_scope", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "scope", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "POST Api Email Webhook Aliyun Scope", "tags": [ "Email" ] } }, "/api/email/webhook/aliyun/{scope}/{config}": { "post": { "description": "Auto-generated reference for `POST /api/email/webhook/aliyun/{scope}/{config}`.", "operationId": "post__api__email__webhook__aliyun___by_scope___by_config", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "scope", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "config", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "POST Api Email Webhook Aliyun Scope Config", "tags": [ "Email" ] } }, "/api/email/webhook/mailgun/{scope}": { "post": { "description": "Auto-generated reference for `POST /api/email/webhook/mailgun/{scope}`.", "operationId": "post__api__email__webhook__mailgun___by_scope", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "scope", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "POST Api Email Webhook Mailgun Scope", "tags": [ "Email" ] } }, "/api/email/webhook/mailgun/{scope}/{config}": { "post": { "description": "Auto-generated reference for `POST /api/email/webhook/mailgun/{scope}/{config}`.", "operationId": "post__api__email__webhook__mailgun___by_scope___by_config", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "scope", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "config", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "POST Api Email Webhook Mailgun Scope Config", "tags": [ "Email" ] } }, "/api/email/webhook/postmark/{scope}": { "post": { "description": "Auto-generated reference for `POST /api/email/webhook/postmark/{scope}`.", "operationId": "post__api__email__webhook__postmark___by_scope", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "scope", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "POST Api Email Webhook Postmark Scope", "tags": [ "Email" ] } }, "/api/email/webhook/postmark/{scope}/{config}": { "post": { "description": "Auto-generated reference for `POST /api/email/webhook/postmark/{scope}/{config}`.", "operationId": "post__api__email__webhook__postmark___by_scope___by_config", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "scope", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "config", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "POST Api Email Webhook Postmark Scope Config", "tags": [ "Email" ] } }, "/api/email/webhook/resend/{scope}": { "post": { "description": "Auto-generated reference for `POST /api/email/webhook/resend/{scope}`.", "operationId": "post__api__email__webhook__resend___by_scope", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "scope", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "POST Api Email Webhook Resend Scope", "tags": [ "Email" ] } }, "/api/email/webhook/resend/{scope}/{config}": { "post": { "description": "Auto-generated reference for `POST /api/email/webhook/resend/{scope}/{config}`.", "operationId": "post__api__email__webhook__resend___by_scope___by_config", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "scope", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "config", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "POST Api Email Webhook Resend Scope Config", "tags": [ "Email" ] } }, "/api/email/webhook/sendgrid/{scope}": { "post": { "description": "Auto-generated reference for `POST /api/email/webhook/sendgrid/{scope}`.", "operationId": "post__api__email__webhook__sendgrid___by_scope", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "scope", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "POST Api Email Webhook Sendgrid Scope", "tags": [ "Email" ] } }, "/api/email/webhook/sendgrid/{scope}/{config}": { "post": { "description": "Auto-generated reference for `POST /api/email/webhook/sendgrid/{scope}/{config}`.", "operationId": "post__api__email__webhook__sendgrid___by_scope___by_config", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "scope", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "config", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "POST Api Email Webhook Sendgrid Scope Config", "tags": [ "Email" ] } }, "/api/email/webhook/ses/{scope}": { "post": { "description": "Auto-generated reference for `POST /api/email/webhook/ses/{scope}`.", "operationId": "post__api__email__webhook__ses___by_scope", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "scope", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "POST Api Email Webhook Ses Scope", "tags": [ "Email" ] } }, "/api/email/webhook/ses/{scope}/{config}": { "post": { "description": "Auto-generated reference for `POST /api/email/webhook/ses/{scope}/{config}`.", "operationId": "post__api__email__webhook__ses___by_scope___by_config", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "scope", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "config", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "POST Api Email Webhook Ses Scope Config", "tags": [ "Email" ] } }, "/api/email/webhook/tencent/{scope}": { "post": { "description": "Auto-generated reference for `POST /api/email/webhook/tencent/{scope}`.", "operationId": "post__api__email__webhook__tencent___by_scope", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "scope", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "POST Api Email Webhook Tencent Scope", "tags": [ "Email" ] } }, "/api/email/webhook/tencent/{scope}/{config}": { "post": { "description": "Auto-generated reference for `POST /api/email/webhook/tencent/{scope}/{config}`.", "operationId": "post__api__email__webhook__tencent___by_scope___by_config", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "scope", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "config", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "POST Api Email Webhook Tencent Scope Config", "tags": [ "Email" ] } }, "/api/email/webhook/zeabur/{scope}": { "post": { "description": "Auto-generated reference for `POST /api/email/webhook/zeabur/{scope}`.", "operationId": "post__api__email__webhook__zeabur___by_scope", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "scope", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "POST Api Email Webhook Zeabur Scope", "tags": [ "Email" ] } }, "/api/email/webhook/zeabur/{scope}/{config}": { "post": { "description": "Auto-generated reference for `POST /api/email/webhook/zeabur/{scope}/{config}`.", "operationId": "post__api__email__webhook__zeabur___by_scope___by_config", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "scope", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "config", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "POST Api Email Webhook Zeabur Scope Config", "tags": [ "Email" ] } }, "/api/functions/signing-key": { "get": { "description": "Auto-generated reference for `GET /api/functions/signing-key`.", "operationId": "get__api__functions__signing_dash_key", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Functions Signing Key", "tags": [ "API" ] } }, "/api/leaderboard/me": { "get": { "description": "Auto-generated reference for `GET /api/leaderboard/me`.", "operationId": "get__api__leaderboard__me", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Leaderboard Me", "tags": [ "API" ] } }, "/api/leaderboard/points/{type}": { "get": { "description": "Auto-generated reference for `GET /api/leaderboard/points/{type}`.", "operationId": "get__api__leaderboard__points___by_type", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "type", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Leaderboard Points Type", "tags": [ "API" ] } }, "/api/leaderboard/signin/{type}": { "get": { "description": "Auto-generated reference for `GET /api/leaderboard/signin/{type}`.", "operationId": "get__api__leaderboard__signin___by_type", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "type", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Leaderboard Signin Type", "tags": [ "API" ] } }, "/api/leaderboard/summary": { "get": { "description": "Auto-generated reference for `GET /api/leaderboard/summary`.", "operationId": "get__api__leaderboard__summary", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Leaderboard Summary", "tags": [ "API" ] } }, "/api/legal/documents": { "get": { "description": "Auto-generated reference for `GET /api/legal/documents`.", "operationId": "get__api__legal__documents", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Legal Documents", "tags": [ "API" ] } }, "/api/legal/documents/{docType}": { "get": { "description": "Auto-generated reference for `GET /api/legal/documents/{docType}`.", "operationId": "get__api__legal__documents___by_docType", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "docType", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Legal Documents DocType", "tags": [ "API" ] } }, "/api/lottery/activities": { "get": { "description": "Auto-generated reference for `GET /api/lottery/activities`.", "operationId": "get__api__lottery__activities", "parameters": [ { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "keyword", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Lottery Activities", "tags": [ "API" ] } }, "/api/lottery/activities/{id}": { "get": { "description": "Auto-generated reference for `GET /api/lottery/activities/{id}`.", "operationId": "get__api__lottery__activities___by_id", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Lottery Activities Id", "tags": [ "API" ] } }, "/api/lottery/activities/{id}/prizes": { "get": { "description": "Auto-generated reference for `GET /api/lottery/activities/{id}/prizes`.", "operationId": "get__api__lottery__activities___by_id__prizes", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Lottery Activities Id Prizes", "tags": [ "API" ] } }, "/api/lottery/activities/{id}/verify": { "get": { "description": "Auto-generated reference for `GET /api/lottery/activities/{id}/verify`.", "operationId": "get__api__lottery__activities___by_id__verify", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Lottery Activities Id Verify", "tags": [ "API" ] } }, "/api/lottery/draw": { "post": { "description": "Auto-generated reference for `POST /api/lottery/draw`.", "operationId": "post__api__lottery__draw", "requestBody": { "content": { "application/json": { "schema": { "properties": { "activityId": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "activityId": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api Lottery Draw", "tags": [ "API" ] } }, "/api/lottery/draws": { "get": { "description": "Auto-generated reference for `GET /api/lottery/draws`.", "operationId": "get__api__lottery__draws", "parameters": [ { "in": "query", "name": "activityId", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Lottery Draws", "tags": [ "API" ] } }, "/api/lottery/join": { "post": { "description": "Auto-generated reference for `POST /api/lottery/join`.", "operationId": "post__api__lottery__join", "requestBody": { "content": { "application/json": { "schema": { "properties": { "activityId": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "activityId": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api Lottery Join", "tags": [ "API" ] } }, "/api/notifications": { "get": { "description": "Lists notifications for the current user with optional filters.", "operationId": "get__api__notifications", "parameters": [ { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "type", "schema": { "type": "string" } }, { "in": "query", "name": "level", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "List Notifications", "tags": [ "Notifications" ] } }, "/api/notifications/clear": { "post": { "description": "Clears notifications based on optional filters.", "operationId": "post__api__notifications__clear", "requestBody": { "content": { "application/json": { "schema": { "properties": { "level": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "level": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "Clear Notifications", "tags": [ "Notifications" ] } }, "/api/notifications/read": { "post": { "description": "Marks a single notification as read.", "operationId": "post__api__notifications__read", "requestBody": { "content": { "application/json": { "schema": { "properties": { "notificationId": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "notificationId": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "Mark Notification Read", "tags": [ "Notifications" ] } }, "/api/notifications/read-all": { "post": { "description": "Auto-generated reference for `POST /api/notifications/read-all`.", "operationId": "post__api__notifications__read_dash_all", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api Notifications Read All", "tags": [ "Notifications" ] } }, "/api/notifications/read-batch": { "post": { "description": "Marks multiple notifications as read.", "operationId": "post__api__notifications__read_dash_batch", "requestBody": { "content": { "application/json": { "schema": { "properties": { "ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "Batch Read Notifications", "tags": [ "Notifications" ] } }, "/api/notifications/unread-count": { "get": { "description": "Returns the unread notification count.", "operationId": "get__api__notifications__unread_dash_count", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "properties": { "unread": { "format": "int64", "type": "integer" } }, "required": [ "unread" ], "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "Unread Count", "tags": [ "Notifications" ] } }, "/api/notifications/{notificationId}": { "delete": { "description": "Auto-generated reference for `DELETE /api/notifications/{notificationId}`.", "operationId": "delete__api__notifications___by_notificationId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "notificationId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "DELETE Api Notifications NotificationId", "tags": [ "Notifications" ] } }, "/api/pay/bills/{billId}/download": { "get": { "description": "Auto-generated reference for `GET /api/pay/bills/{billId}/download`.", "operationId": "get__api__pay__bills___by_billId__download", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "billId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Pay Bills BillId Download", "tags": [ "Payment" ] } }, "/api/pay/epay/query/{orderNo}": { "get": { "description": "Auto-generated reference for `GET /api/pay/epay/query/{orderNo}`.", "operationId": "get__api__pay__epay__query___by_orderNo", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orderNo", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Pay Epay Query OrderNo", "tags": [ "Payment" ] } }, "/api/pay/orders": { "get": { "description": "Auto-generated reference for `GET /api/pay/orders`.", "operationId": "get__api__pay__orders", "parameters": [ { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Pay Orders", "tags": [ "Payment" ] } }, "/api/pay/orders/create": { "post": { "description": "Auto-generated reference for `POST /api/pay/orders/create`.", "operationId": "post__api__pay__orders__create", "requestBody": { "content": { "application/json": { "schema": { "properties": { "amount": { "type": "string" }, "body": { "type": "string" }, "config_name": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "notify_url": { "type": "string" }, "return_url": { "type": "string" }, "subject": { "type": "string" }, "type": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "amount": { "type": "string" }, "body": { "type": "string" }, "config_name": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "notify_url": { "type": "string" }, "return_url": { "type": "string" }, "subject": { "type": "string" }, "type": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api Pay Orders Create", "tags": [ "Payment" ] } }, "/api/pay/orders/{orderNo}": { "get": { "description": "Auto-generated reference for `GET /api/pay/orders/{orderNo}`.", "operationId": "get__api__pay__orders___by_orderNo", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orderNo", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Pay Orders OrderNo", "tags": [ "Payment" ] } }, "/api/pay/orders/{orderNo}/bill": { "get": { "description": "Auto-generated reference for `GET /api/pay/orders/{orderNo}/bill`.", "operationId": "get__api__pay__orders___by_orderNo__bill", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orderNo", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "expireMinutes", "schema": { "type": "integer" } }, { "in": "query", "name": "locale", "schema": { "type": "string" } }, { "in": "query", "name": "documentType", "schema": { "type": "string" } }, { "in": "query", "name": "timezone", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Pay Orders OrderNo Bill", "tags": [ "Payment" ] }, "post": { "description": "Auto-generated reference for `POST /api/pay/orders/{orderNo}/bill`.", "operationId": "post__api__pay__orders___by_orderNo__bill", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orderNo", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "documentType": { "type": "string" }, "expireMinutes": { "type": "integer" }, "locale": { "type": "string" }, "timezone": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "documentType": { "type": "string" }, "expireMinutes": { "type": "integer" }, "locale": { "type": "string" }, "timezone": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api Pay Orders OrderNo Bill", "tags": [ "Payment" ] } }, "/api/pay/orders/{orderNo}/receipt": { "get": { "description": "Auto-generated reference for `GET /api/pay/orders/{orderNo}/receipt`.", "operationId": "get__api__pay__orders___by_orderNo__receipt", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orderNo", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "expireMinutes", "schema": { "type": "integer" } }, { "in": "query", "name": "locale", "schema": { "type": "string" } }, { "in": "query", "name": "documentType", "schema": { "type": "string" } }, { "in": "query", "name": "timezone", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Pay Orders OrderNo Receipt", "tags": [ "Payment" ] } }, "/api/pay/orders/{orderNo}/receipt/email": { "post": { "description": "Auto-generated reference for `POST /api/pay/orders/{orderNo}/receipt/email`.", "operationId": "post__api__pay__orders___by_orderNo__receipt__email", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "orderNo", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "documentType": { "type": "string" }, "expireMinutes": { "type": "integer" }, "locale": { "type": "string" }, "timezone": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "documentType": { "type": "string" }, "expireMinutes": { "type": "integer" }, "locale": { "type": "string" }, "timezone": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api Pay Orders OrderNo Receipt Email", "tags": [ "Payment" ] } }, "/api/pay/receipt/options": { "get": { "description": "Auto-generated reference for `GET /api/pay/receipt/options`.", "operationId": "get__api__pay__receipt__options", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Pay Receipt Options", "tags": [ "Payment" ] } }, "/api/pay/receipts/{appid}/{billId}/download": { "get": { "description": "Auto-generated reference for `GET /api/pay/receipts/{appid}/{billId}/download`.", "operationId": "get__api__pay__receipts___by_appid___by_billId__download", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "billId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Pay Receipts Appid BillId Download", "tags": [ "Payment" ] } }, "/api/points/experience-transactions": { "get": { "description": "Auto-generated reference for `GET /api/points/experience-transactions`.", "operationId": "get__api__points__experience_dash_transactions", "parameters": [ { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Points Experience Transactions", "tags": [ "Points" ] } }, "/api/points/integral-transactions": { "get": { "description": "Auto-generated reference for `GET /api/points/integral-transactions`.", "operationId": "get__api__points__integral_dash_transactions", "parameters": [ { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Points Integral Transactions", "tags": [ "Points" ] } }, "/api/points/level": { "get": { "description": "Auto-generated reference for `GET /api/points/level`.", "operationId": "get__api__points__level", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Points Level", "tags": [ "Points" ] } }, "/api/points/levels": { "get": { "description": "Auto-generated reference for `GET /api/points/levels`.", "operationId": "get__api__points__levels", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Points Levels", "tags": [ "Points" ] } }, "/api/points/overview": { "get": { "description": "Auto-generated reference for `GET /api/points/overview`.", "operationId": "get__api__points__overview", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Points Overview", "tags": [ "Points" ] } }, "/api/points/rankings": { "get": { "description": "Auto-generated reference for `GET /api/points/rankings`.", "operationId": "get__api__points__rankings", "parameters": [ { "in": "query", "name": "type", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Points Rankings", "tags": [ "Points" ] } }, "/api/public/branding": { "get": { "description": "Auto-generated reference for `GET /api/public/branding`.", "operationId": "get__api__public__branding", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Public Branding", "tags": [ "API" ] } }, "/api/public/pay/callback/{method}": { "get": { "description": "Auto-generated reference for `GET /api/public/pay/callback/{method}`.", "operationId": "get__api__public__pay__callback___by_method", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "method", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "GET Api Public Pay Callback Method", "tags": [ "Public Payment" ] }, "post": { "description": "Auto-generated reference for `POST /api/public/pay/callback/{method}`.", "operationId": "post__api__public__pay__callback___by_method", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "method", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "POST Api Public Pay Callback Method", "tags": [ "Public Payment" ] } }, "/api/public/pay/callback/{method}/{appid}": { "get": { "description": "Auto-generated reference for `GET /api/public/pay/callback/{method}/{appid}`.", "operationId": "get__api__public__pay__callback___by_method___by_appid", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "method", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "appid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "GET Api Public Pay Callback Method Appid", "tags": [ "Public Payment" ] }, "post": { "description": "Auto-generated reference for `POST /api/public/pay/callback/{method}/{appid}`.", "operationId": "post__api__public__pay__callback___by_method___by_appid", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "method", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "appid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "POST Api Public Pay Callback Method Appid", "tags": [ "Public Payment" ] } }, "/api/public/pay/epay": { "get": { "description": "Auto-generated reference for `GET /api/public/pay/epay`.", "operationId": "get__api__public__pay__epay", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "GET Api Public Pay Epay", "tags": [ "Public Payment" ] }, "post": { "description": "Auto-generated reference for `POST /api/public/pay/epay`.", "operationId": "post__api__public__pay__epay", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "POST Api Public Pay Epay", "tags": [ "Public Payment" ] } }, "/api/public/pay/return": { "get": { "description": "Auto-generated reference for `GET /api/public/pay/return`.", "operationId": "get__api__public__pay__return", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "GET Api Public Pay Return", "tags": [ "Public Payment" ] } }, "/api/storage/object-link": { "post": { "description": "Creates a direct or proxied download link for a storage object.", "operationId": "post__api__storage__object_dash_link", "requestBody": { "content": { "application/json": { "schema": { "properties": { "config_name": { "type": "string" }, "download": { "type": "boolean" }, "expires_in": { "type": "integer" }, "file_name": { "type": "string" }, "object_key": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "config_name": { "type": "string" }, "download": { "type": "boolean" }, "expires_in": { "type": "integer" }, "file_name": { "type": "string" }, "object_key": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "Create Object Link", "tags": [ "Storage" ] } }, "/api/storage/proxy/{ticket}": { "get": { "description": "Streams a proxied storage object when private download mode is enabled.", "operationId": "get__api__storage__proxy___by_ticket", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "ticket", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "Binary object stream." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "Proxy Download", "tags": [ "Storage" ] } }, "/api/storage/upload": { "post": { "description": "Uploads a file to the configured storage backend using multipart form data.", "operationId": "post__api__storage__upload", "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "cache_control": { "type": "string" }, "config_name": { "type": "string" }, "content_type": { "type": "string" }, "file": { "format": "binary", "type": "string" }, "file_name": { "type": "string" }, "metadata": { "additionalProperties": true, "type": "object" }, "object_key": { "type": "string" } }, "required": [ "file" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "Upload Object", "tags": [ "Storage" ] } }, "/api/system/announcements/active": { "get": { "description": "Auto-generated reference for `GET /api/system/announcements/active`.", "operationId": "get__api__system__announcements__active", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api System Announcements Active", "tags": [ "API" ] } }, "/api/system/monitor": { "get": { "description": "Auto-generated reference for `GET /api/system/monitor`.", "operationId": "get__api__system__monitor", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api System Monitor", "tags": [ "API" ] } }, "/api/system/monitor/apps": { "get": { "description": "Auto-generated reference for `GET /api/system/monitor/apps`.", "operationId": "get__api__system__monitor__apps", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api System Monitor Apps", "tags": [ "API" ] } }, "/api/system/monitor/apps/{appkey}": { "get": { "description": "Auto-generated reference for `GET /api/system/monitor/apps/{appkey}`.", "operationId": "get__api__system__monitor__apps___by_appkey", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api System Monitor Apps Appkey", "tags": [ "API" ] } }, "/api/system/monitor/apps/{appkey}/components": { "get": { "description": "Auto-generated reference for `GET /api/system/monitor/apps/{appkey}/components`.", "operationId": "get__api__system__monitor__apps___by_appkey__components", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api System Monitor Apps Appkey Components", "tags": [ "API" ] } }, "/api/system/monitor/apps/{appkey}/history": { "get": { "description": "Auto-generated reference for `GET /api/system/monitor/apps/{appkey}/history`.", "operationId": "get__api__system__monitor__apps___by_appkey__history", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api System Monitor Apps Appkey History", "tags": [ "API" ] } }, "/api/system/monitor/components": { "get": { "description": "Auto-generated reference for `GET /api/system/monitor/components`.", "operationId": "get__api__system__monitor__components", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api System Monitor Components", "tags": [ "API" ] } }, "/api/system/monitor/history": { "get": { "description": "Auto-generated reference for `GET /api/system/monitor/history`.", "operationId": "get__api__system__monitor__history", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api System Monitor History", "tags": [ "API" ] } }, "/api/user-settings": { "get": { "description": "Returns settings grouped by category for the current user through the compatibility endpoint.", "operationId": "get__api__user_dash_settings", "parameters": [ { "in": "query", "name": "category", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "Get Legacy Settings", "tags": [ "User Settings" ] } }, "/api/user-settings/auto-sign/status": { "get": { "description": "Auto-generated reference for `GET /api/user-settings/auto-sign/status`.", "operationId": "get__api__user_dash_settings__auto_dash_sign__status", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api User Settings Auto Sign Status", "tags": [ "User Settings" ] } }, "/api/user-settings/auto-sign/test-notification": { "post": { "description": "Auto-generated reference for `POST /api/user-settings/auto-sign/test-notification`.", "operationId": "post__api__user_dash_settings__auto_dash_sign__test_dash_notification", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api User Settings Auto Sign Test Notification", "tags": [ "User Settings" ] } }, "/api/user-settings/categories": { "get": { "description": "Auto-generated reference for `GET /api/user-settings/categories`.", "operationId": "get__api__user_dash_settings__categories", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api User Settings Categories", "tags": [ "User Settings" ] } }, "/api/user-settings/reset": { "post": { "description": "Auto-generated reference for `POST /api/user-settings/reset`.", "operationId": "post__api__user_dash_settings__reset", "requestBody": { "content": { "application/json": { "schema": { "properties": { "category": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "category": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api User Settings Reset", "tags": [ "User Settings" ] } }, "/api/user-settings/update": { "post": { "description": "Auto-generated reference for `POST /api/user-settings/update`.", "operationId": "post__api__user_dash_settings__update", "requestBody": { "content": { "application/json": { "schema": { "properties": { "category": { "type": "string" }, "settings": { "additionalProperties": {}, "type": "object" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "category": { "type": "string" }, "settings": { "additionalProperties": {}, "type": "object" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api User Settings Update", "tags": [ "User Settings" ] } }, "/api/user/audits/login": { "get": { "description": "Lists login audit records for the current user.", "operationId": "get__api__user__audits__login", "parameters": [ { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "List User Login Audits", "tags": [ "User Audits" ] } }, "/api/user/audits/login/export": { "get": { "description": "Exports login audit records for the current user as CSV.", "operationId": "get__api__user__audits__login__export", "parameters": [ { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "Export User Login Audits", "tags": [ "User Audits" ] } }, "/api/user/audits/sessions": { "get": { "description": "Lists session audit records for the current user.", "operationId": "get__api__user__audits__sessions", "parameters": [ { "in": "query", "name": "eventType", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "List User Session Audits", "tags": [ "User Audits" ] } }, "/api/user/audits/sessions/export": { "get": { "description": "Exports session audit records for the current user as CSV.", "operationId": "get__api__user__audits__sessions__export", "parameters": [ { "in": "query", "name": "eventType", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "Export User Session Audits", "tags": [ "User Audits" ] } }, "/api/user/auto-sign/status": { "get": { "description": "Auto-generated reference for `GET /api/user/auto-sign/status`.", "operationId": "get__api__user__auto_dash_sign__status", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api User Auto Sign Status", "tags": [ "User" ] } }, "/api/user/auto-sign/test-notification": { "post": { "description": "Auto-generated reference for `POST /api/user/auto-sign/test-notification`.", "operationId": "post__api__user__auto_dash_sign__test_dash_notification", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api User Auto Sign Test Notification", "tags": [ "User" ] } }, "/api/user/banner": { "get": { "description": "Returns banner content for the specified application.", "operationId": "get__api__user__banner", "parameters": [ { "in": "query", "name": "appid", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "List User Banners", "tags": [ "User Public" ] } }, "/api/user/check-version": { "get": { "description": "Checks whether a newer version is available for the specified application and client version.", "operationId": "get__api__user__check_dash_version", "parameters": [ { "in": "query", "name": "appid", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "versionCode", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "platform", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "Check Application Version", "tags": [ "User Public" ] } }, "/api/user/create-site": { "post": { "description": "Auto-generated reference for `POST /api/user/create-site`.", "operationId": "post__api__user__create_dash_site", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "category": { "type": "string" }, "description": { "type": "string" }, "image": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "url": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "category": { "type": "string" }, "description": { "type": "string" }, "image": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "url": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api User Create Site", "tags": [ "User" ] } }, "/api/user/daily": { "post": { "description": "Auto-generated reference for `POST /api/user/daily`.", "operationId": "post__api__user__daily", "requestBody": { "content": { "application/json": { "schema": { "properties": { "location": { "type": "string" }, "source": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "location": { "type": "string" }, "source": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api User Daily", "tags": [ "User" ] } }, "/api/user/dailyRank": { "post": { "description": "Auto-generated reference for `POST /api/user/dailyRank`.", "operationId": "post__api__user__dailyRank", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "type": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "type": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api User DailyRank", "tags": [ "User" ] } }, "/api/user/delete-site": { "delete": { "description": "Auto-generated reference for `DELETE /api/user/delete-site`.", "operationId": "delete__api__user__delete_dash_site", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "DELETE Api User Delete Site", "tags": [ "User" ] } }, "/api/user/integralRank": { "post": { "description": "Auto-generated reference for `POST /api/user/integralRank`.", "operationId": "post__api__user__integralRank", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "type": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "type": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api User IntegralRank", "tags": [ "User" ] } }, "/api/user/level/config": { "get": { "description": "Auto-generated reference for `GET /api/user/level/config`.", "operationId": "get__api__user__level__config", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "GET Api User Level Config", "tags": [ "User" ] } }, "/api/user/level/info": { "post": { "description": "Auto-generated reference for `POST /api/user/level/info`.", "operationId": "post__api__user__level__info", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "type": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "type": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api User Level Info", "tags": [ "User" ] } }, "/api/user/level/ranking": { "post": { "description": "Auto-generated reference for `POST /api/user/level/ranking`.", "operationId": "post__api__user__level__ranking", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "type": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "type": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api User Level Ranking", "tags": [ "User" ] } }, "/api/user/my": { "post": { "description": "Returns the aggregated current-user dashboard payload.", "operationId": "post__api__user__my", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "My Dashboard", "tags": [ "User" ] } }, "/api/user/my-site": { "post": { "description": "Auto-generated reference for `POST /api/user/my-site`.", "operationId": "post__api__user__my_dash_site", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "category": { "type": "string" }, "keyword": { "type": "string" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "sortBy": { "type": "string" }, "sortOrder": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "category": { "type": "string" }, "keyword": { "type": "string" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "sortBy": { "type": "string" }, "sortOrder": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api User My Site", "tags": [ "User" ] } }, "/api/user/notice": { "get": { "description": "Returns notice content for the specified application.", "operationId": "get__api__user__notice", "parameters": [ { "in": "query", "name": "appid", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "List User Notices", "tags": [ "User Public" ] } }, "/api/user/passkey": { "get": { "description": "Auto-generated reference for `GET /api/user/passkey`.", "operationId": "get__api__user__passkey", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api User Passkey", "tags": [ "User" ] } }, "/api/user/passkey/register": { "post": { "description": "Auto-generated reference for `POST /api/user/passkey/register`.", "operationId": "post__api__user__passkey__register", "requestBody": { "content": { "application/json": { "schema": { "properties": { "challengeId": { "type": "string" }, "credential": {}, "credentialName": { "type": "string" }, "payload": {} }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "challengeId": { "type": "string" }, "credential": {}, "credentialName": { "type": "string" }, "payload": {} }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api User Passkey Register", "tags": [ "User" ] } }, "/api/user/passkey/register/options": { "post": { "description": "Auto-generated reference for `POST /api/user/passkey/register/options`.", "operationId": "post__api__user__passkey__register__options", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api User Passkey Register Options", "tags": [ "User" ] } }, "/api/user/passkey/{credentialId}": { "delete": { "description": "Auto-generated reference for `DELETE /api/user/passkey/{credentialId}`.", "operationId": "delete__api__user__passkey___by_credentialId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "credentialId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "DELETE Api User Passkey CredentialId", "tags": [ "User" ] } }, "/api/user/profile": { "get": { "description": "Returns the current user's profile data.", "operationId": "get__api__user__profile", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "Get Profile", "tags": [ "User" ] }, "put": { "description": "Updates the current user's profile fields.", "operationId": "put__api__user__profile", "requestBody": { "content": { "application/json": { "schema": { "properties": { "avatar": { "type": "string" }, "bio": { "type": "string" }, "birthday": { "type": "string" }, "contacts": { "items": { "properties": { "label": { "type": "string" }, "platform": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "type": "array" }, "email": { "type": "string" }, "nickname": { "type": "string" }, "phone": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "avatar": { "type": "string" }, "bio": { "type": "string" }, "birthday": { "type": "string" }, "contacts": { "items": { "properties": { "label": { "type": "string" }, "platform": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "type": "array" }, "email": { "type": "string" }, "nickname": { "type": "string" }, "phone": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "Update Profile", "tags": [ "User" ] } }, "/api/user/profile/avatar": { "delete": { "description": "Auto-generated reference for `DELETE /api/user/profile/avatar`.", "operationId": "delete__api__user__profile__avatar", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "DELETE Api User Profile Avatar", "tags": [ "User" ] }, "post": { "description": "Uploads the current user's avatar using multipart form data.", "operationId": "post__api__user__profile__avatar", "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "cache_control": { "type": "string" }, "config_name": { "type": "string" }, "content_type": { "type": "string" }, "file": { "format": "binary", "type": "string" }, "file_name": { "type": "string" }, "metadata": { "additionalProperties": true, "type": "object" }, "object_key": { "type": "string" } }, "required": [ "file" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "Upload User Avatar", "tags": [ "User" ] } }, "/api/user/profile/avatar/history": { "get": { "description": "Auto-generated reference for `GET /api/user/profile/avatar/history`.", "operationId": "get__api__user__profile__avatar__history", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api User Profile Avatar History", "tags": [ "User" ] } }, "/api/user/profile/avatar/restore": { "post": { "description": "Auto-generated reference for `POST /api/user/profile/avatar/restore`.", "operationId": "post__api__user__profile__avatar__restore", "requestBody": { "content": { "application/json": { "schema": { "properties": { "assetId": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "assetId": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api User Profile Avatar Restore", "tags": [ "User" ] } }, "/api/user/profile/changes/confirm": { "post": { "description": "Auto-generated reference for `POST /api/user/profile/changes/confirm`.", "operationId": "post__api__user__profile__changes__confirm", "requestBody": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "field": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "code": { "type": "string" }, "field": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api User Profile Changes Confirm", "tags": [ "User" ] } }, "/api/user/profile/upload-avatar": { "post": { "description": "Auto-generated reference for `POST /api/user/profile/upload-avatar`.", "operationId": "post__api__user__profile__upload_dash_avatar", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api User Profile Upload Avatar", "tags": [ "User" ] } }, "/api/user/resubmit-site": { "post": { "description": "Auto-generated reference for `POST /api/user/resubmit-site`.", "operationId": "post__api__user__resubmit_dash_site", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "id": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "id": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api User Resubmit Site", "tags": [ "User" ] } }, "/api/user/role/applications": { "get": { "description": "Lists the current user's role application records.", "operationId": "get__api__user__role__applications", "parameters": [ { "in": "query", "name": "appid", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } }, { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "requestedRole", "schema": { "type": "string" } }, { "in": "query", "name": "priority", "schema": { "type": "string" } }, { "in": "query", "name": "keyword", "schema": { "type": "string" } }, { "in": "query", "name": "sortBy", "schema": { "type": "string" } }, { "in": "query", "name": "sortOrder", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "List Role Applications", "tags": [ "Roles" ] } }, "/api/user/role/applications/{applicationId}": { "get": { "description": "Auto-generated reference for `GET /api/user/role/applications/{applicationId}`.", "operationId": "get__api__user__role__applications___by_applicationId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "applicationId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "appid", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api User Role Applications ApplicationId", "tags": [ "User" ] } }, "/api/user/role/applications/{applicationId}/cancel": { "put": { "description": "Auto-generated reference for `PUT /api/user/role/applications/{applicationId}/cancel`.", "operationId": "put__api__user__role__applications___by_applicationId__cancel", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "applicationId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "PUT Api User Role Applications ApplicationId Cancel", "tags": [ "User" ] } }, "/api/user/role/applications/{applicationId}/resubmit": { "post": { "description": "Auto-generated reference for `POST /api/user/role/applications/{applicationId}/resubmit`.", "operationId": "post__api__user__role__applications___by_applicationId__resubmit", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "applicationId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "reason": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "reason": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api User Role Applications ApplicationId Resubmit", "tags": [ "User" ] } }, "/api/user/role/apply": { "post": { "description": "Auto-generated reference for `POST /api/user/role/apply`.", "operationId": "post__api__user__role__apply", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "priority": { "type": "string" }, "reason": { "type": "string" }, "requestedRole": { "type": "string" }, "validDays": { "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "priority": { "type": "string" }, "reason": { "type": "string" }, "requestedRole": { "type": "string" }, "validDays": { "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api User Role Apply", "tags": [ "User" ] } }, "/api/user/role/available": { "get": { "description": "Auto-generated reference for `GET /api/user/role/available`.", "operationId": "get__api__user__role__available", "parameters": [ { "in": "query", "name": "appid", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api User Role Available", "tags": [ "User" ] } }, "/api/user/search-site": { "post": { "description": "Auto-generated reference for `POST /api/user/search-site`.", "operationId": "post__api__user__search_dash_site", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "category": { "type": "string" }, "keyword": { "type": "string" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "sortBy": { "type": "string" }, "sortOrder": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "category": { "type": "string" }, "keyword": { "type": "string" }, "limit": { "type": "integer" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "sortBy": { "type": "string" }, "sortOrder": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api User Search Site", "tags": [ "User" ] } }, "/api/user/security": { "get": { "description": "Auto-generated reference for `GET /api/user/security`.", "operationId": "get__api__user__security", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api User Security", "tags": [ "User" ] } }, "/api/user/sessions": { "get": { "description": "Auto-generated reference for `GET /api/user/sessions`.", "operationId": "get__api__user__sessions", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api User Sessions", "tags": [ "User" ] } }, "/api/user/sessions/revoke-all": { "post": { "description": "Auto-generated reference for `POST /api/user/sessions/revoke-all`.", "operationId": "post__api__user__sessions__revoke_dash_all", "requestBody": { "content": { "application/json": { "schema": { "properties": { "includeCurrent": { "type": "boolean" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "includeCurrent": { "type": "boolean" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api User Sessions Revoke All", "tags": [ "User" ] } }, "/api/user/sessions/{tokenHash}": { "delete": { "description": "Auto-generated reference for `DELETE /api/user/sessions/{tokenHash}`.", "operationId": "delete__api__user__sessions___by_tokenHash", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "tokenHash", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "DELETE Api User Sessions TokenHash", "tags": [ "User" ] } }, "/api/user/settings": { "get": { "description": "Returns settings grouped by category for the current user.", "operationId": "get__api__user__settings", "parameters": [ { "in": "query", "name": "category", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "Get Settings", "tags": [ "User" ] }, "put": { "description": "Updates a settings category for the current user.", "operationId": "put__api__user__settings", "requestBody": { "content": { "application/json": { "schema": { "properties": { "category": { "type": "string" }, "settings": { "additionalProperties": {}, "type": "object" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "category": { "type": "string" }, "settings": { "additionalProperties": {}, "type": "object" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "Update Settings", "tags": [ "User" ] } }, "/api/user/settings/reset": { "post": { "description": "Auto-generated reference for `POST /api/user/settings/reset`.", "operationId": "post__api__user__settings__reset", "requestBody": { "content": { "application/json": { "schema": { "properties": { "category": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "category": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api User Settings Reset", "tags": [ "User" ] } }, "/api/user/signin": { "post": { "description": "Executes the current user's sign-in request.", "operationId": "post__api__user__signin", "requestBody": { "content": { "application/json": { "schema": { "properties": { "location": { "type": "string" }, "source": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "location": { "type": "string" }, "source": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "Sign-in", "tags": [ "Sign-in" ] } }, "/api/user/signin/history": { "get": { "description": "Lists sign-in history for the current user.", "operationId": "get__api__user__signin__history", "parameters": [ { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "Sign-in History", "tags": [ "Sign-in" ] } }, "/api/user/signin/history/export": { "get": { "description": "Exports the current user's sign-in history as CSV.", "operationId": "get__api__user__signin__history__export", "parameters": [ { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "Export Sign-in History", "tags": [ "Sign-in" ] } }, "/api/user/signin/status": { "get": { "description": "Returns the current sign-in state and reward availability.", "operationId": "get__api__user__signin__status", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "Sign-in Status", "tags": [ "Sign-in" ] } }, "/api/user/site-detail": { "get": { "description": "Returns a specific site detail record.", "operationId": "get__api__user__site_dash_detail", "parameters": [ { "in": "query", "name": "id", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "appid", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "Get Site Detail", "tags": [ "Sites" ] } }, "/api/user/site-list": { "get": { "description": "Returns the public site list for the current user and application scope.", "operationId": "get__api__user__site_dash_list", "parameters": [ { "in": "query", "name": "appid", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "pageSize", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } }, { "in": "query", "name": "keyword", "schema": { "type": "string" } }, { "in": "query", "name": "sortBy", "schema": { "type": "string" } }, { "in": "query", "name": "sortOrder", "schema": { "type": "string" } }, { "in": "query", "name": "category", "schema": { "type": "string" } }, { "in": "query", "name": "status", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "List Sites", "tags": [ "Sites" ] } }, "/api/user/tickets": { "get": { "description": "Auto-generated reference for `GET /api/user/tickets`.", "operationId": "get__api__user__tickets", "parameters": [ { "in": "query", "name": "appid", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "priority", "schema": { "type": "string" } }, { "in": "query", "name": "categoryId", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "groupId", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "assigneeId", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "unassigned", "schema": { "type": "boolean" } }, { "in": "query", "name": "requesterId", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "keyword", "schema": { "type": "string" } }, { "in": "query", "name": "tags", "schema": { "type": "string" } }, { "in": "query", "name": "slaState", "schema": { "type": "string" } }, { "in": "query", "name": "overdueOnly", "schema": { "type": "boolean" } }, { "in": "query", "name": "createdFrom", "schema": { "type": "string" } }, { "in": "query", "name": "createdTo", "schema": { "type": "string" } }, { "in": "query", "name": "rated", "schema": { "type": "boolean" } }, { "in": "query", "name": "sortBy", "schema": { "type": "string" } }, { "in": "query", "name": "sortDir", "schema": { "type": "string" } }, { "in": "query", "name": "includeClosed", "schema": { "type": "boolean" } }, { "in": "query", "name": "mine", "schema": { "type": "boolean" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api User Tickets", "tags": [ "User" ] }, "post": { "description": "Auto-generated reference for `POST /api/user/tickets`.", "operationId": "post__api__user__tickets", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "assigneeAdminId": { "format": "int64", "nullable": true, "type": "integer" }, "attachmentIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "categoryId": { "format": "int64", "nullable": true, "type": "integer" }, "content": { "type": "string" }, "contentType": { "type": "string" }, "groupId": { "format": "int64", "nullable": true, "type": "integer" }, "metadata": { "additionalProperties": {}, "type": "object" }, "priority": { "type": "string" }, "requesterAdminId": { "format": "int64", "nullable": true, "type": "integer" }, "requesterContact": { "type": "string" }, "requesterName": { "type": "string" }, "requesterType": { "type": "string" }, "requesterUserId": { "format": "int64", "nullable": true, "type": "integer" }, "source": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "assigneeAdminId": { "format": "int64", "nullable": true, "type": "integer" }, "attachmentIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "categoryId": { "format": "int64", "nullable": true, "type": "integer" }, "content": { "type": "string" }, "contentType": { "type": "string" }, "groupId": { "format": "int64", "nullable": true, "type": "integer" }, "metadata": { "additionalProperties": {}, "type": "object" }, "priority": { "type": "string" }, "requesterAdminId": { "format": "int64", "nullable": true, "type": "integer" }, "requesterContact": { "type": "string" }, "requesterName": { "type": "string" }, "requesterType": { "type": "string" }, "requesterUserId": { "format": "int64", "nullable": true, "type": "integer" }, "source": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api User Tickets", "tags": [ "User" ] } }, "/api/user/tickets/attachments": { "post": { "description": "Auto-generated reference for `POST /api/user/tickets/attachments`.", "operationId": "post__api__user__tickets__attachments", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api User Tickets Attachments", "tags": [ "User" ] } }, "/api/user/tickets/categories": { "get": { "description": "Auto-generated reference for `GET /api/user/tickets/categories`.", "operationId": "get__api__user__tickets__categories", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api User Tickets Categories", "tags": [ "User" ] } }, "/api/user/tickets/{ticketId}": { "get": { "description": "Auto-generated reference for `GET /api/user/tickets/{ticketId}`.", "operationId": "get__api__user__tickets___by_ticketId", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "ticketId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api User Tickets TicketId", "tags": [ "User" ] } }, "/api/user/tickets/{ticketId}/cancel": { "post": { "description": "Auto-generated reference for `POST /api/user/tickets/{ticketId}/cancel`.", "operationId": "post__api__user__tickets___by_ticketId__cancel", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "ticketId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "reason": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "reason": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api User Tickets TicketId Cancel", "tags": [ "User" ] } }, "/api/user/tickets/{ticketId}/rating": { "post": { "description": "Auto-generated reference for `POST /api/user/tickets/{ticketId}/rating`.", "operationId": "post__api__user__tickets___by_ticketId__rating", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "ticketId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "comment": { "type": "string" }, "rating": { "maximum": 32767, "minimum": -32768, "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "comment": { "type": "string" }, "rating": { "maximum": 32767, "minimum": -32768, "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api User Tickets TicketId Rating", "tags": [ "User" ] } }, "/api/user/tickets/{ticketId}/replies": { "post": { "description": "Auto-generated reference for `POST /api/user/tickets/{ticketId}/replies`.", "operationId": "post__api__user__tickets___by_ticketId__replies", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "ticketId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "attachmentIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "content": { "type": "string" }, "contentType": { "type": "string" }, "internal": { "type": "boolean" }, "metadata": { "additionalProperties": {}, "type": "object" }, "nextStatus": { "type": "string" }, "quickReplyId": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "attachmentIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "content": { "type": "string" }, "contentType": { "type": "string" }, "internal": { "type": "boolean" }, "metadata": { "additionalProperties": {}, "type": "object" }, "nextStatus": { "type": "string" }, "quickReplyId": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api User Tickets TicketId Replies", "tags": [ "User" ] } }, "/api/user/two-factor/disable": { "post": { "description": "Auto-generated reference for `POST /api/user/two-factor/disable`.", "operationId": "post__api__user__two_dash_factor__disable", "requestBody": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "recoveryCode": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "code": { "type": "string" }, "recoveryCode": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api User Two Factor Disable", "tags": [ "User" ] } }, "/api/user/two-factor/enable": { "post": { "description": "Auto-generated reference for `POST /api/user/two-factor/enable`.", "operationId": "post__api__user__two_dash_factor__enable", "requestBody": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "enrollmentId": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "code": { "type": "string" }, "enrollmentId": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api User Two Factor Enable", "tags": [ "User" ] } }, "/api/user/two-factor/enroll": { "post": { "description": "Auto-generated reference for `POST /api/user/two-factor/enroll`.", "operationId": "post__api__user__two_dash_factor__enroll", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api User Two Factor Enroll", "tags": [ "User" ] } }, "/api/user/two-factor/recovery-codes": { "get": { "description": "Auto-generated reference for `GET /api/user/two-factor/recovery-codes`.", "operationId": "get__api__user__two_dash_factor__recovery_dash_codes", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api User Two Factor Recovery Codes", "tags": [ "User" ] }, "post": { "description": "Auto-generated reference for `POST /api/user/two-factor/recovery-codes`.", "operationId": "post__api__user__two_dash_factor__recovery_dash_codes", "requestBody": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "recoveryCode": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "code": { "type": "string" }, "recoveryCode": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api User Two Factor Recovery Codes", "tags": [ "User" ] } }, "/api/user/two-factor/recovery-codes/regenerate": { "post": { "description": "Auto-generated reference for `POST /api/user/two-factor/recovery-codes/regenerate`.", "operationId": "post__api__user__two_dash_factor__recovery_dash_codes__regenerate", "requestBody": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "recoveryCode": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "code": { "type": "string" }, "recoveryCode": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api User Two Factor Recovery Codes Regenerate", "tags": [ "User" ] } }, "/api/user/update-site": { "put": { "description": "Auto-generated reference for `PUT /api/user/update-site`.", "operationId": "put__api__user__update_dash_site", "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "category": { "type": "string" }, "description": { "type": "string" }, "id": { "format": "int64", "type": "integer" }, "image": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "url": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "category": { "type": "string" }, "description": { "type": "string" }, "id": { "format": "int64", "type": "integer" }, "image": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "url": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "PUT Api User Update Site", "tags": [ "User" ] } }, "/api/v1/apps/{appkey}/auth/2fa/verify": { "post": { "description": "完成登录返回的二次认证挑战。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。", "operationId": "appSecondFactor", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "challengeId": { "type": "string" }, "code": { "type": "string" }, "recoveryCode": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "challengeId": { "type": "string" }, "code": { "type": "string" }, "recoveryCode": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [], "summary": "完成登录返回的二次认证挑战", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/auth/email/code": { "post": { "description": "发送邮箱验证码。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。", "operationId": "appEmailCode", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "configName": { "type": "string" }, "email": { "type": "string" }, "expireMinutes": { "type": "integer" }, "purpose": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "configName": { "type": "string" }, "email": { "type": "string" }, "expireMinutes": { "type": "integer" }, "purpose": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [], "summary": "发送邮箱验证码", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/auth/email/verify": { "post": { "description": "校验邮箱验证码。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。", "operationId": "appEmailVerify", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "email": { "type": "string" }, "purpose": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "code": { "type": "string" }, "email": { "type": "string" }, "purpose": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [], "summary": "校验邮箱验证码", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/auth/login": { "post": { "description": "登录（method: password | sms | cardkey）。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。", "operationId": "appLogin", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "account": { "type": "string" }, "captchaAnswer": { "type": "string" }, "captchaId": { "type": "string" }, "cardKey": { "type": "string" }, "code": { "type": "string" }, "device": { "type": "string" }, "deviceId": { "type": "string" }, "method": { "type": "string" }, "password": { "type": "string" }, "phone": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "account": { "type": "string" }, "captchaAnswer": { "type": "string" }, "captchaId": { "type": "string" }, "cardKey": { "type": "string" }, "code": { "type": "string" }, "device": { "type": "string" }, "deviceId": { "type": "string" }, "method": { "type": "string" }, "password": { "type": "string" }, "phone": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [], "summary": "登录（method: password | sms | cardkey）", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/auth/logout": { "post": { "description": "注销当前会话。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。", "operationId": "appLogout", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "注销当前会话", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/auth/oauth/bind/url": { "post": { "description": "取第三方账号绑定授权地址。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。", "operationId": "appOauthBindURL", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "device": { "type": "string" }, "deviceId": { "type": "string" }, "markCode": { "type": "string" }, "provider": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "device": { "type": "string" }, "deviceId": { "type": "string" }, "markCode": { "type": "string" }, "provider": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "取第三方账号绑定授权地址", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/auth/oauth/bindings": { "get": { "description": "我已绑定的第三方账号。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appOauthBindings", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "我已绑定的第三方账号", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/auth/oauth/bindings/{provider}": { "delete": { "description": "解绑第三方账号。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appOauthUnbind", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "provider", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "解绑第三方账号", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/auth/oauth/callback": { "get": { "description": "第三方授权回跳落点；由浏览器发起，免包装。\n\n**免包装路径**：任何安全等级下都以明文可达，不需要签名或加密。", "operationId": "appOauthCallback", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "provider", "schema": { "type": "string" } }, { "in": "query", "name": "code", "schema": { "type": "string" } }, { "in": "query", "name": "state", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [], "summary": "第三方授权回跳落点；由浏览器发起，免包装", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/auth/oauth/exchange": { "post": { "description": "原生 SDK 用第三方 profile 换会话。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。", "operationId": "appOauthExchange", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "accessToken": { "type": "string" }, "appid": { "format": "int64", "type": "integer" }, "avatar": { "type": "string" }, "device": { "type": "string" }, "deviceId": { "type": "string" }, "email": { "type": "string" }, "markcode": { "type": "string" }, "nickname": { "type": "string" }, "provider": { "type": "string" }, "providerUserId": { "type": "string" }, "rawProfile": { "additionalProperties": {}, "type": "object" }, "refreshToken": { "type": "string" }, "unionId": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "accessToken": { "type": "string" }, "appid": { "format": "int64", "type": "integer" }, "avatar": { "type": "string" }, "device": { "type": "string" }, "deviceId": { "type": "string" }, "email": { "type": "string" }, "markcode": { "type": "string" }, "nickname": { "type": "string" }, "provider": { "type": "string" }, "providerUserId": { "type": "string" }, "rawProfile": { "additionalProperties": {}, "type": "object" }, "refreshToken": { "type": "string" }, "unionId": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [], "summary": "原生 SDK 用第三方 profile 换会话", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/auth/oauth/url": { "post": { "description": "取第三方登录授权地址。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。", "operationId": "appOauthURL", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "device": { "type": "string" }, "deviceId": { "type": "string" }, "provider": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "device": { "type": "string" }, "deviceId": { "type": "string" }, "provider": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [], "summary": "取第三方登录授权地址", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/auth/passkey/login": { "post": { "description": "Passkey 登录校验。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。", "operationId": "appPasskeyLogin", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "credential": { "additionalProperties": {}, "type": "object" }, "device": { "type": "string" }, "deviceId": { "type": "string" }, "markCode": { "type": "string" }, "sessionId": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "credential": { "additionalProperties": {}, "type": "object" }, "device": { "type": "string" }, "deviceId": { "type": "string" }, "markCode": { "type": "string" }, "sessionId": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [], "summary": "Passkey 登录校验", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/auth/passkey/options": { "post": { "description": "取 Passkey 登录参数。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。", "operationId": "appPasskeyOptions", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "account": { "type": "string" }, "device": { "type": "string" }, "deviceId": { "type": "string" }, "markCode": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "account": { "type": "string" }, "device": { "type": "string" }, "deviceId": { "type": "string" }, "markCode": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [], "summary": "取 Passkey 登录参数", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/auth/password/change": { "post": { "description": "修改密码。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。", "operationId": "appPasswordChange", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "currentPassword": { "type": "string" }, "newPassword": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "currentPassword": { "type": "string" }, "newPassword": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "修改密码", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/auth/password/forgot": { "post": { "description": "发送密码重置邮件。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。", "operationId": "appPasswordForgot", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "configName": { "type": "string" }, "email": { "type": "string" }, "resetUrl": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "configName": { "type": "string" }, "email": { "type": "string" }, "resetUrl": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [], "summary": "发送密码重置邮件", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/auth/password/reset/verify": { "post": { "description": "校验密码重置令牌。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。", "operationId": "appPasswordResetVerify", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "email": { "type": "string" }, "token": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "email": { "type": "string" }, "token": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [], "summary": "校验密码重置令牌", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/auth/password/verify": { "post": { "description": "校验当前密码。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。", "operationId": "appPasswordVerify", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "password": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "password": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "校验当前密码", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/auth/refresh": { "post": { "description": "刷新访问令牌。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。", "operationId": "appRefresh", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "device": { "type": "string" }, "deviceId": { "type": "string" }, "refreshToken": { "type": "string" }, "token": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "device": { "type": "string" }, "deviceId": { "type": "string" }, "refreshToken": { "type": "string" }, "token": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [], "summary": "刷新访问令牌", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/auth/register": { "post": { "description": "注册（method: password | sms）。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。", "operationId": "appRegister", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "account": { "type": "string" }, "captchaAnswer": { "type": "string" }, "captchaId": { "type": "string" }, "code": { "type": "string" }, "device": { "type": "string" }, "deviceId": { "type": "string" }, "method": { "type": "string" }, "nickname": { "type": "string" }, "password": { "type": "string" }, "phone": { "type": "string" }, "profile": {} }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "account": { "type": "string" }, "captchaAnswer": { "type": "string" }, "captchaId": { "type": "string" }, "code": { "type": "string" }, "device": { "type": "string" }, "deviceId": { "type": "string" }, "method": { "type": "string" }, "nickname": { "type": "string" }, "password": { "type": "string" }, "phone": { "type": "string" }, "profile": {} }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [], "summary": "注册（method: password | sms）", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/auth/sms/code": { "post": { "description": "申请短信验证码（purpose: login | register）。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。", "operationId": "appSmsCode", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "captchaAnswer": { "type": "string" }, "captchaId": { "type": "string" }, "phone": { "type": "string" }, "purpose": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "captchaAnswer": { "type": "string" }, "captchaId": { "type": "string" }, "phone": { "type": "string" }, "purpose": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [], "summary": "申请短信验证码（purpose: login | register）", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/banners": { "get": { "description": "轮播图。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appBanners", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [], "summary": "轮播图", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/banners/{bannerId}/click": { "post": { "description": "轮播图点击上报。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。", "operationId": "appBannerClick", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "bannerId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [], "summary": "轮播图点击上报", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/captcha": { "post": { "description": "按策略签发图形验证码。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。", "operationId": "appCaptcha", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "purpose": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "purpose": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [], "summary": "按策略签发图形验证码", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/card-keys/mine": { "get": { "description": "我名下的授权卡：授权到期时间与已绑定设备数。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appCardKeyMine", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "我名下的授权卡：授权到期时间与已绑定设备数", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/card-keys/redeem": { "post": { "description": "兑换卡密（会员 / 积分 / 经验 / 余额 / 抽奖次数 / 设备位）。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。", "operationId": "appCardKeyRedeem", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "兑换卡密（会员 / 积分 / 经验 / 余额 / 抽奖次数 / 设备位）", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/config": { "get": { "description": "读取应用能力与当前安全等级规格；任何等级下都免包装可读。\n\n**免包装路径**：任何安全等级下都以明文可达，不需要签名或加密。", "operationId": "appConfig", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [], "summary": "读取应用能力与当前安全等级规格；任何等级下都免包装可读", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/leaderboard/me": { "get": { "description": "我在各榜单的排名。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appLeaderboardMe", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "我在各榜单的排名", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/leaderboard/points/{type}": { "get": { "description": "积分榜（type: integral | experience | level）。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appLeaderboardPoints", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "type", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "积分榜（type: integral | experience | level）", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/leaderboard/signin/{type}": { "get": { "description": "签到榜（type: today | consecutive | monthly）。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appLeaderboardSignIn", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "type", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "签到榜（type: today | consecutive | monthly）", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/leaderboard/summary": { "get": { "description": "排行榜综合概览。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appLeaderboardSummary", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "排行榜综合概览", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/me": { "get": { "description": "当前登录用户资料。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appMe", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "当前登录用户资料", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/me/2fa/recovery-codes": { "get": { "description": "恢复码摘要。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appRecoveryCodes", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "恢复码摘要", "tags": [ "App Gateway" ] }, "post": { "description": "生成恢复码。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。", "operationId": "appRecoveryCodesCreate", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "recoveryCode": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "code": { "type": "string" }, "recoveryCode": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "生成恢复码", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/me/2fa/recovery-codes/regenerate": { "post": { "description": "重置恢复码。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。", "operationId": "appRecoveryCodesRegenerate", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "recoveryCode": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "code": { "type": "string" }, "recoveryCode": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "重置恢复码", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/me/2fa/totp/disable": { "post": { "description": "关闭 TOTP。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。", "operationId": "appTotpDisable", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "recoveryCode": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "code": { "type": "string" }, "recoveryCode": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "关闭 TOTP", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/me/2fa/totp/enable": { "post": { "description": "启用 TOTP。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。", "operationId": "appTotpEnable", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "enrollmentId": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "code": { "type": "string" }, "enrollmentId": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "启用 TOTP", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/me/2fa/totp/enroll": { "post": { "description": "发起 TOTP 绑定。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。", "operationId": "appTotpEnroll", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "发起 TOTP 绑定", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/me/audits/login": { "get": { "description": "我的登录记录。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appLoginAudits", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "我的登录记录", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/me/audits/sessions": { "get": { "description": "我的会话记录。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appSessionAudits", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "eventType", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "我的会话记录", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/me/avatar": { "delete": { "description": "移除头像，回到默认头像。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appAvatarRemove", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "移除头像，回到默认头像", "tags": [ "App Gateway" ] }, "post": { "description": "上传头像（multipart/form-data，可带 crop_* 裁剪框）。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\n`multipart/form-data` 上传，上限 32 MiB。sealed 档下整个 multipart 体被加密，原始 Content-Type 由 `X-Aegis-Plain-Content-Type` 头声明。", "operationId": "appAvatarUpload", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "cache_control": { "type": "string" }, "config_name": { "type": "string" }, "content_type": { "type": "string" }, "file": { "format": "binary", "type": "string" }, "file_name": { "type": "string" }, "metadata": { "additionalProperties": true, "type": "object" }, "object_key": { "type": "string" } }, "required": [ "file" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "上传头像（multipart/form-data，可带 crop_* 裁剪框）", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/me/avatar/history": { "get": { "description": "头像历史。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appAvatarHistory", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "头像历史", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/me/avatar/restore": { "post": { "description": "恢复历史头像。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。", "operationId": "appAvatarRestore", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "assetId": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "assetId": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "恢复历史头像", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/me/passkeys": { "get": { "description": "我的 Passkey 列表。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appPasskeyList", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "我的 Passkey 列表", "tags": [ "App Gateway" ] }, "post": { "description": "完成 Passkey 注册。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。", "operationId": "appPasskeyRegister", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "challengeId": { "type": "string" }, "credential": {}, "credentialName": { "type": "string" }, "payload": {} }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "challengeId": { "type": "string" }, "credential": {}, "credentialName": { "type": "string" }, "payload": {} }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "完成 Passkey 注册", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/me/passkeys/options": { "post": { "description": "取 Passkey 注册参数。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。", "operationId": "appPasskeyRegisterOptions", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "取 Passkey 注册参数", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/me/passkeys/{credentialId}": { "delete": { "description": "删除 Passkey。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appPasskeyDelete", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "credentialId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "删除 Passkey", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/me/profile": { "get": { "description": "个人资料详情。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appProfile", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "个人资料详情", "tags": [ "App Gateway" ] }, "put": { "description": "更新个人资料。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。", "operationId": "appProfileUpdate", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "avatar": { "type": "string" }, "bio": { "type": "string" }, "birthday": { "type": "string" }, "contacts": { "items": { "properties": { "label": { "type": "string" }, "platform": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "type": "array" }, "email": { "type": "string" }, "nickname": { "type": "string" }, "phone": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "avatar": { "type": "string" }, "bio": { "type": "string" }, "birthday": { "type": "string" }, "contacts": { "items": { "properties": { "label": { "type": "string" }, "platform": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "type": "array" }, "email": { "type": "string" }, "nickname": { "type": "string" }, "phone": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "更新个人资料", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/me/profile/changes/confirm": { "post": { "description": "确认敏感资料变更。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。", "operationId": "appProfileConfirm", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "field": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "code": { "type": "string" }, "field": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "确认敏感资料变更", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/me/security": { "get": { "description": "账户安全概览。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appSecurity", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "账户安全概览", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/me/sessions": { "get": { "description": "当前在线会话列表。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appSessions", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "当前在线会话列表", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/me/sessions/revoke-all": { "post": { "description": "踢出全部会话。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。", "operationId": "appSessionRevokeAll", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "includeCurrent": { "type": "boolean" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "includeCurrent": { "type": "boolean" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "踢出全部会话", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/me/sessions/{tokenHash}": { "delete": { "description": "踢出单个会话。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appSessionRevoke", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "tokenHash", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "踢出单个会话", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/me/settings": { "get": { "description": "读取用户设置。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appSettings", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "category", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "读取用户设置", "tags": [ "App Gateway" ] }, "put": { "description": "更新用户设置。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。", "operationId": "appSettingsUpdate", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "category": { "type": "string" }, "settings": { "additionalProperties": {}, "type": "object" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "category": { "type": "string" }, "settings": { "additionalProperties": {}, "type": "object" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "更新用户设置", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/notices": { "get": { "description": "公告。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appNotices", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [], "summary": "公告", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/notifications": { "get": { "description": "站内信列表。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appNotifications", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "type", "schema": { "type": "string" } }, { "in": "query", "name": "level", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "站内信列表", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/notifications/clear": { "post": { "description": "清空站内信。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。", "operationId": "appNotificationClear", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "level": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "level": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "清空站内信", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/notifications/read": { "post": { "description": "标记已读。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。", "operationId": "appNotificationRead", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "notificationId": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "notificationId": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "标记已读", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/notifications/read-all": { "post": { "description": "全部标记已读。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。", "operationId": "appNotificationReadAll", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "全部标记已读", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/notifications/read-batch": { "post": { "description": "批量标记已读。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。", "operationId": "appNotificationReadBatch", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "批量标记已读", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/notifications/unread-count": { "get": { "description": "未读数。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appNotificationsUnread", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "未读数", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/notifications/{notificationId}": { "delete": { "description": "删除一条站内信。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appNotificationDelete", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "notificationId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "删除一条站内信", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/pay/orders": { "get": { "description": "我的订单。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appPayOrders", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "我的订单", "tags": [ "App Gateway" ] }, "post": { "description": "创建支付订单。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。", "operationId": "appPayOrderCreate", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "amount": { "type": "string" }, "body": { "type": "string" }, "config_name": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "notify_url": { "type": "string" }, "return_url": { "type": "string" }, "subject": { "type": "string" }, "type": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "amount": { "type": "string" }, "body": { "type": "string" }, "config_name": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "notify_url": { "type": "string" }, "return_url": { "type": "string" }, "subject": { "type": "string" }, "type": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "创建支付订单", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/pay/orders/{orderNo}": { "get": { "description": "订单详情。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appPayOrderDetail", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "orderNo", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "订单详情", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/points/experience-transactions": { "get": { "description": "经验流水。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appExperienceTransactions", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "经验流水", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/points/integral-transactions": { "get": { "description": "积分流水。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appIntegralTransactions", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "积分流水", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/points/level": { "get": { "description": "我的等级。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appPointsLevel", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "我的等级", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/points/levels": { "get": { "description": "等级配置。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appPointsLevels", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "等级配置", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/points/overview": { "get": { "description": "积分与经验概览。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appPointsOverview", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "积分与经验概览", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/signin": { "post": { "description": "签到。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。", "operationId": "appSignin", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "location": { "type": "string" }, "source": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "location": { "type": "string" }, "source": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "签到", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/signin/history": { "get": { "description": "签到历史。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appSigninHistory", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "签到历史", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/signin/status": { "get": { "description": "签到状态。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appSigninStatus", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "签到状态", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/storage/object-link": { "post": { "description": "换取对象访问链接。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。", "operationId": "appStorageObjectLink", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "config_name": { "type": "string" }, "download": { "type": "boolean" }, "expires_in": { "type": "integer" }, "file_name": { "type": "string" }, "object_key": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "config_name": { "type": "string" }, "download": { "type": "boolean" }, "expires_in": { "type": "integer" }, "file_name": { "type": "string" }, "object_key": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "换取对象访问链接", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/storage/upload": { "post": { "description": "上传文件（multipart/form-data）。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\n`multipart/form-data` 上传，上限 32 MiB。sealed 档下整个 multipart 体被加密，原始 Content-Type 由 `X-Aegis-Plain-Content-Type` 头声明。", "operationId": "appStorageUpload", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "cache_control": { "type": "string" }, "config_name": { "type": "string" }, "content_type": { "type": "string" }, "file": { "format": "binary", "type": "string" }, "file_name": { "type": "string" }, "metadata": { "additionalProperties": true, "type": "object" }, "object_key": { "type": "string" } }, "required": [ "file" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "上传文件（multipart/form-data）", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/tickets": { "get": { "description": "我的工单。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appTickets", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "appid", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "priority", "schema": { "type": "string" } }, { "in": "query", "name": "categoryId", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "groupId", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "assigneeId", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "unassigned", "schema": { "type": "boolean" } }, { "in": "query", "name": "requesterId", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "keyword", "schema": { "type": "string" } }, { "in": "query", "name": "tags", "schema": { "type": "string" } }, { "in": "query", "name": "slaState", "schema": { "type": "string" } }, { "in": "query", "name": "overdueOnly", "schema": { "type": "boolean" } }, { "in": "query", "name": "createdFrom", "schema": { "type": "string" } }, { "in": "query", "name": "createdTo", "schema": { "type": "string" } }, { "in": "query", "name": "rated", "schema": { "type": "boolean" } }, { "in": "query", "name": "sortBy", "schema": { "type": "string" } }, { "in": "query", "name": "sortDir", "schema": { "type": "string" } }, { "in": "query", "name": "includeClosed", "schema": { "type": "boolean" } }, { "in": "query", "name": "mine", "schema": { "type": "boolean" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "我的工单", "tags": [ "App Gateway" ] }, "post": { "description": "提交工单。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。", "operationId": "appTicketCreate", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "assigneeAdminId": { "format": "int64", "nullable": true, "type": "integer" }, "attachmentIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "categoryId": { "format": "int64", "nullable": true, "type": "integer" }, "content": { "type": "string" }, "contentType": { "type": "string" }, "groupId": { "format": "int64", "nullable": true, "type": "integer" }, "metadata": { "additionalProperties": {}, "type": "object" }, "priority": { "type": "string" }, "requesterAdminId": { "format": "int64", "nullable": true, "type": "integer" }, "requesterContact": { "type": "string" }, "requesterName": { "type": "string" }, "requesterType": { "type": "string" }, "requesterUserId": { "format": "int64", "nullable": true, "type": "integer" }, "source": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "appid": { "format": "int64", "type": "integer" }, "assigneeAdminId": { "format": "int64", "nullable": true, "type": "integer" }, "attachmentIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "categoryId": { "format": "int64", "nullable": true, "type": "integer" }, "content": { "type": "string" }, "contentType": { "type": "string" }, "groupId": { "format": "int64", "nullable": true, "type": "integer" }, "metadata": { "additionalProperties": {}, "type": "object" }, "priority": { "type": "string" }, "requesterAdminId": { "format": "int64", "nullable": true, "type": "integer" }, "requesterContact": { "type": "string" }, "requesterName": { "type": "string" }, "requesterType": { "type": "string" }, "requesterUserId": { "format": "int64", "nullable": true, "type": "integer" }, "source": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "提交工单", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/tickets/attachments": { "post": { "description": "上传工单附件（multipart/form-data）。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\n`multipart/form-data` 上传，上限 32 MiB。sealed 档下整个 multipart 体被加密，原始 Content-Type 由 `X-Aegis-Plain-Content-Type` 头声明。", "operationId": "appTicketAttachment", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "cache_control": { "type": "string" }, "config_name": { "type": "string" }, "content_type": { "type": "string" }, "file": { "format": "binary", "type": "string" }, "file_name": { "type": "string" }, "metadata": { "additionalProperties": true, "type": "object" }, "object_key": { "type": "string" } }, "required": [ "file" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "上传工单附件（multipart/form-data）", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/tickets/categories": { "get": { "description": "工单分类。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appTicketCategories", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "工单分类", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/tickets/{ticketId}": { "get": { "description": "工单详情。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appTicketDetail", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "ticketId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "工单详情", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/tickets/{ticketId}/cancel": { "post": { "description": "撤单。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。", "operationId": "appTicketCancel", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "ticketId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "reason": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "reason": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "撤单", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/tickets/{ticketId}/rating": { "post": { "description": "评价。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。", "operationId": "appTicketRating", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "ticketId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "comment": { "type": "string" }, "rating": { "maximum": 32767, "minimum": -32768, "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "comment": { "type": "string" }, "rating": { "maximum": 32767, "minimum": -32768, "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "评价", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/tickets/{ticketId}/replies": { "post": { "description": "追问。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。", "operationId": "appTicketReply", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter extracted from the route.", "in": "path", "name": "ticketId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "attachmentIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "content": { "type": "string" }, "contentType": { "type": "string" }, "internal": { "type": "boolean" }, "metadata": { "additionalProperties": {}, "type": "object" }, "nextStatus": { "type": "string" }, "quickReplyId": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "attachmentIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "content": { "type": "string" }, "contentType": { "type": "string" }, "internal": { "type": "boolean" }, "metadata": { "additionalProperties": {}, "type": "object" }, "nextStatus": { "type": "string" }, "quickReplyId": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "追问", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/version/check": { "get": { "description": "版本检查与更新。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appVersionCheck", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "appid", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "versionCode", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "platform", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [], "summary": "版本检查与更新", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/vip/plans": { "get": { "description": "会员套餐。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appVipPlans", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "会员套餐", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/vip/purchase": { "post": { "description": "购买会员。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。", "operationId": "appVipPurchase", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "idempotencyKey": { "type": "string" }, "planId": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "idempotencyKey": { "type": "string" }, "planId": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "购买会员", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/vip/status": { "get": { "description": "我的会员状态。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appVipStatus", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "我的会员状态", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/vip/transactions": { "get": { "description": "会员流水。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appVipTransactions", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "会员流水", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/vip/trial": { "post": { "description": "领取试用会员（一人一次，资格见 /vip/status 的 trialOffer）。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。", "operationId": "appVipTrial", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "领取试用会员（一人一次，资格见 /vip/status 的 trialOffer）", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/wallet": { "get": { "description": "我的余额。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appWallet", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "我的余额", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/wallet/consume": { "post": { "description": "余额消费。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。", "operationId": "appWalletConsume", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "amount": { "type": "string" }, "idempotencyKey": { "type": "string" }, "remark": { "type": "string" }, "title": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "amount": { "type": "string" }, "idempotencyKey": { "type": "string" }, "remark": { "type": "string" }, "title": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "余额消费", "tags": [ "App Gateway" ] } }, "/api/v1/apps/{appkey}/wallet/transactions": { "get": { "description": "余额流水。\n\n按应用的 `security.level` 包装：standard 直发 JSON；signed 追加 HMAC 签名头；sealed 在此之上把载荷整体加密。包装由 transport 适配器统一处理，请求体与响应体三档完全一致。\n\n需要用户 Bearer 令牌，且令牌必须属于路径上的这个应用（否则 40372）。\n\nsealed 档下本接口没有请求体，密文放在 `_payload` 查询参数里，明文是真正的 query string。", "operationId": "appWalletTransactions", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "appkey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "type", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "余额流水", "tags": [ "App Gateway" ] } }, "/api/vip/plans": { "get": { "description": "Auto-generated reference for `GET /api/vip/plans`.", "operationId": "get__api__vip__plans", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Vip Plans", "tags": [ "API" ] } }, "/api/vip/purchase": { "post": { "description": "Auto-generated reference for `POST /api/vip/purchase`.", "operationId": "post__api__vip__purchase", "requestBody": { "content": { "application/json": { "schema": { "properties": { "idempotencyKey": { "type": "string" }, "planId": { "format": "int64", "type": "integer" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "idempotencyKey": { "type": "string" }, "planId": { "format": "int64", "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api Vip Purchase", "tags": [ "API" ] } }, "/api/vip/status": { "get": { "description": "Auto-generated reference for `GET /api/vip/status`.", "operationId": "get__api__vip__status", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Vip Status", "tags": [ "API" ] } }, "/api/vip/transactions": { "get": { "description": "Auto-generated reference for `GET /api/vip/transactions`.", "operationId": "get__api__vip__transactions", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Vip Transactions", "tags": [ "API" ] } }, "/api/vip/trial": { "post": { "description": "Auto-generated reference for `POST /api/vip/trial`.", "operationId": "post__api__vip__trial", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api Vip Trial", "tags": [ "API" ] } }, "/api/wallet": { "get": { "description": "Auto-generated reference for `GET /api/wallet`.", "operationId": "get__api__wallet", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Wallet", "tags": [ "API" ] } }, "/api/wallet/consume": { "post": { "description": "Auto-generated reference for `POST /api/wallet/consume`.", "operationId": "post__api__wallet__consume", "requestBody": { "content": { "application/json": { "schema": { "properties": { "amount": { "type": "string" }, "idempotencyKey": { "type": "string" }, "remark": { "type": "string" }, "title": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "amount": { "type": "string" }, "idempotencyKey": { "type": "string" }, "remark": { "type": "string" }, "title": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api Wallet Consume", "tags": [ "API" ] } }, "/api/wallet/transactions": { "get": { "description": "Auto-generated reference for `GET /api/wallet/transactions`.", "operationId": "get__api__wallet__transactions", "parameters": [ { "in": "query", "name": "type", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Wallet Transactions", "tags": [ "API" ] } }, "/api/wallet/transactions/{transactionNo}": { "get": { "description": "Auto-generated reference for `GET /api/wallet/transactions/{transactionNo}`.", "operationId": "get__api__wallet__transactions___by_transactionNo", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "transactionNo", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "expireMinutes", "schema": { "type": "integer" } }, { "in": "query", "name": "locale", "schema": { "type": "string" } }, { "in": "query", "name": "documentType", "schema": { "type": "string" } }, { "in": "query", "name": "timezone", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Wallet Transactions TransactionNo", "tags": [ "API" ] } }, "/api/wallet/transactions/{transactionNo}/bill": { "get": { "description": "Auto-generated reference for `GET /api/wallet/transactions/{transactionNo}/bill`.", "operationId": "get__api__wallet__transactions___by_transactionNo__bill", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "transactionNo", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "expireMinutes", "schema": { "type": "integer" } }, { "in": "query", "name": "locale", "schema": { "type": "string" } }, { "in": "query", "name": "documentType", "schema": { "type": "string" } }, { "in": "query", "name": "timezone", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Wallet Transactions TransactionNo Bill", "tags": [ "API" ] }, "post": { "description": "Auto-generated reference for `POST /api/wallet/transactions/{transactionNo}/bill`.", "operationId": "post__api__wallet__transactions___by_transactionNo__bill", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "transactionNo", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "documentType": { "type": "string" }, "expireMinutes": { "type": "integer" }, "locale": { "type": "string" }, "timezone": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "documentType": { "type": "string" }, "expireMinutes": { "type": "integer" }, "locale": { "type": "string" }, "timezone": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api Wallet Transactions TransactionNo Bill", "tags": [ "API" ] } }, "/api/wallet/transactions/{transactionNo}/receipt": { "get": { "description": "Auto-generated reference for `GET /api/wallet/transactions/{transactionNo}/receipt`.", "operationId": "get__api__wallet__transactions___by_transactionNo__receipt", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "transactionNo", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "expireMinutes", "schema": { "type": "integer" } }, { "in": "query", "name": "locale", "schema": { "type": "string" } }, { "in": "query", "name": "documentType", "schema": { "type": "string" } }, { "in": "query", "name": "timezone", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Api Wallet Transactions TransactionNo Receipt", "tags": [ "API" ] } }, "/api/wallet/transactions/{transactionNo}/receipt/email": { "post": { "description": "Auto-generated reference for `POST /api/wallet/transactions/{transactionNo}/receipt/email`.", "operationId": "post__api__wallet__transactions___by_transactionNo__receipt__email", "parameters": [ { "description": "Path parameter extracted from the route.", "in": "path", "name": "transactionNo", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "documentType": { "type": "string" }, "expireMinutes": { "type": "integer" }, "locale": { "type": "string" }, "timezone": { "type": "string" } }, "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "properties": { "documentType": { "type": "string" }, "expireMinutes": { "type": "integer" }, "locale": { "type": "string" }, "timezone": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "POST Api Wallet Transactions TransactionNo Receipt Email", "tags": [ "API" ] } }, "/api/ws": { "get": { "description": "Upgrades the connection to the global realtime WebSocket gateway. Authentication supports an Authorization bearer token or the `token` query parameter.", "operationId": "get__api__ws", "parameters": [ { "in": "query", "name": "token", "schema": { "type": "string" } } ], "responses": { "101": { "description": "WebSocket upgrade completed." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Realtime service unavailable." } }, "security": [ { "bearerAuth": [] }, { "wsQueryToken": [] } ], "summary": "WebSocket Upgrade", "tags": [ "Realtime" ] } }, "/cons-env": { "get": { "description": "Auto-generated reference for `GET /cons-env`.", "operationId": "get__cons_dash_env", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Cons Env", "tags": [ "API" ] } }, "/healthz": { "get": { "description": "Returns the liveness state of the API runtime.", "operationId": "get__healthz", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "properties": { "status": { "example": "healthy", "type": "string" } }, "required": [ "status" ], "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "Health Check", "tags": [ "System" ] } }, "/readyz": { "get": { "description": "Returns the readiness state of the API runtime.", "operationId": "get__readyz", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "properties": { "status": { "example": "ready", "type": "string" } }, "required": [ "status" ], "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "summary": "Readiness Check", "tags": [ "System" ] } }, "/status": { "get": { "description": "Auto-generated reference for `GET /status`.", "operationId": "get__status", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "data": { "additionalProperties": true, "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Unauthorized." }, "403": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Forbidden." }, "404": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Resource not found." }, "429": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Too many requests." }, "503": { "content": { "application/json": { "schema": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Service unavailable." } }, "security": [ { "bearerAuth": [] } ], "summary": "GET Status", "tags": [ "API" ] } } }, "servers": [ { "url": "/" } ], "tags": [ { "name": "API" }, { "name": "Admin" }, { "name": "Admin Auth" }, { "name": "Admin Settings" }, { "name": "Admin System" }, { "name": "Admin Users" }, { "name": "App" }, { "name": "App Compat" }, { "name": "App Gateway" }, { "name": "Auth" }, { "name": "Email" }, { "name": "Notifications" }, { "name": "Payment" }, { "name": "Points" }, { "name": "Public Payment" }, { "name": "Realtime" }, { "name": "Roles" }, { "name": "Sign-in" }, { "name": "Sites" }, { "name": "Storage" }, { "name": "System" }, { "name": "User" }, { "name": "User Audits" }, { "name": "User Public" }, { "name": "User Settings" }, { "name": "Workflow" } ] }