xinyin025/3x-ui
1
0
Fork 0
mirror of https://github.com/MHSanaei/3x-ui.git synced 2026-09-16 23:27:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(api): align OpenAPI with runtime contracts (#6409)

Browse Source 
Document the cookie-authenticated WebSocket upgrade and its emitted envelopes without exporting pseudo-paths. Align REST response schemas, paged-client filters, and subscription HEAD operations with their runtime implementations, then regenerate frontend and docs artifacts.
This commit is contained in:
Gleb Gudkov
2026-09-04 16:23:41 +03:00
committed by GitHub
parent 3b5273b1d6
commit ed6bc1d898
20 changed files with 4609 additions and 535 deletions
Download Patch File Download Diff File Expand all files Collapse all files
frontend/src/generated/zod.ts
+91
View File
@@ -321,6 +321,17 @@ export const ClientInboundSchema = z.object({
});
export type ClientInbound = z.infer<typeof ClientInboundSchema>;
export const ClientPageResponseSchema = z.object({
filtered: z.number().int(),
groups: z.array(z.string()),
items: z.array(z.lazy(() => ClientSlimSchema)),
page: z.number().int(),
pageSize: z.number().int(),
summary: z.lazy(() => ClientsSummarySchema),
total: z.number().int(),
});
export type ClientPageResponse = z.infer<typeof ClientPageResponseSchema>;
export const ClientRecordSchema = z.object({
adTag: z.string(),
allowedIPs: z.string(),
@@ -362,6 +373,26 @@ export const ClientReverseSchema = z.object({
});
export type ClientReverse = z.infer<typeof ClientReverseSchema>;
export const ClientSlimSchema = z.object({
comment: z.string().optional(),
createdAt: z.number().int(),
email: z.string(),
enable: z.boolean(),
expiryTime: z.number().int(),
group: z.string().optional(),
inboundIds: z.array(z.number().int()),
limitHwid: z.number().int(),
limitIp: z.number().int(),
reset: z.number().int(),
resetDay: z.number().int(),
resetMax: z.number().int(),
subId: z.string(),
totalGB: z.number().int(),
traffic: z.lazy(() => ClientTrafficSchema).nullable().optional(),
updatedAt: z.number().int(),
});
export type ClientSlim = z.infer<typeof ClientSlimSchema>;
export const ClientTrafficSchema = z.object({
down: z.number().int(),
email: z.string(),
@@ -382,6 +413,20 @@ export const ClientTrafficSchema = z.object({
});
export type ClientTraffic = z.infer<typeof ClientTrafficSchema>;
export const ClientsSummarySchema = z.object({
active: z.number().int(),
deactive: z.array(z.string()),
deactiveCount: z.number().int(),
depleted: z.array(z.string()),
depletedCount: z.number().int(),
expiring: z.array(z.string()),
expiringCount: z.number().int(),
online: z.array(z.string()),
onlineCount: z.number().int(),
total: z.number().int(),
});
export type ClientsSummary = z.infer<typeof ClientsSummarySchema>;
export const FallbackParentInfoSchema = z.object({
masterId: z.number().int(),
path: z.string().optional(),
@@ -581,6 +626,38 @@ export const InboundOptionSchema = z.object({
});
export type InboundOption = z.infer<typeof InboundOptionSchema>;
export const InboundTrafficSummarySchema = z.object({
down: z.number().int(),
enable: z.boolean(),
id: z.number().int(),
total: z.number().int(),
up: z.number().int(),
});
export type InboundTrafficSummary = z.infer<typeof InboundTrafficSummarySchema>;
export const LogEntrySchema = z.object({
DateTime: z.string(),
Email: z.string(),
Event: z.number().int(),
FromAddress: z.string(),
Inbound: z.string(),
Outbound: z.string(),
ToAddress: z.string(),
});
export type LogEntry = z.infer<typeof LogEntrySchema>;
export const MLDSA65ResponseSchema = z.object({
seed: z.string(),
verify: z.string(),
});
export type MLDSA65Response = z.infer<typeof MLDSA65ResponseSchema>;
export const MLKEM768ResponseSchema = z.object({
client: z.string(),
seed: z.string(),
});
export type MLKEM768Response = z.infer<typeof MLKEM768ResponseSchema>;
export const MsgSchema = z.object({
msg: z.string(),
obj: z.unknown(),
@@ -588,6 +665,11 @@ export const MsgSchema = z.object({
});
export type Msg = z.infer<typeof MsgSchema>;
export const NewUUIDResponseSchema = z.object({
uuid: z.string(),
});
export type NewUUIDResponse = z.infer<typeof NewUUIDResponseSchema>;
export const NodeSchema = z.object({
activeCount: z.number().int(),
address: z.string(),
@@ -827,6 +909,15 @@ export const SubBalancerSchema = z.object({
});
export type SubBalancer = z.infer<typeof SubBalancerSchema>;
export const TrafficSchema = z.object({
Down: z.number().int(),
IsInbound: z.boolean(),
IsOutbound: z.boolean(),
Tag: z.string(),
Up: z.number().int(),
});
export type Traffic = z.infer<typeof TrafficSchema>;
export const UserSchema = z.object({
id: z.number().int(),
password: z.string(),