docs(api): document POST /panel/api/inbounds/:id/delAllClients
Some checks are pending
CI / go-test (push) Waiting to run
CI / govulncheck (push) Waiting to run
CI / frontend (push) Waiting to run
CodeQL Advanced / Analyze (go) (push) Waiting to run
CodeQL Advanced / Analyze (actions) (push) Waiting to run
CodeQL Advanced / Analyze (javascript-typescript) (push) Waiting to run
Release 3X-UI / build (386) (push) Waiting to run
Release 3X-UI / build (amd64) (push) Waiting to run
Release 3X-UI / build (arm64) (push) Waiting to run
Release 3X-UI / build (armv5) (push) Waiting to run
Release 3X-UI / build (armv6) (push) Waiting to run
Release 3X-UI / build (armv7) (push) Waiting to run
Release 3X-UI / build (s390x) (push) Waiting to run
Release 3X-UI / Build for Windows (push) Waiting to run

Adds the OpenAPI entry for the new "delete all clients of an inbound"
endpoint and regenerates openapi.json (116 paths, 117 operations).
This commit is contained in:
MHSanaei 2026-05-27 18:20:02 +02:00
parent be5425cbed
commit 76043fe306
No known key found for this signature in database
GPG key ID: 7E4060F2FBE5AB7A
2 changed files with 56 additions and 0 deletions

View file

@ -751,6 +751,53 @@
} }
} }
}, },
"/panel/api/inbounds/{id}/delAllClients": {
"post": {
"tags": [
"Inbounds"
],
"summary": "Remove every client attached to a single inbound while keeping the inbound itself. Collects emails from settings.clients[] and feeds them into the optimized bulk-delete path (runtime user removal + traffic-row cleanup + SyncInbound). Destructive and cannot be undone.",
"operationId": "post_panel_api_inbounds_id_delAllClients",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Inbound ID.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"msg": {
"type": "string"
},
"obj": {}
}
},
"example": {
"success": true,
"obj": {
"deleted": 12
}
}
}
}
}
}
}
},
"/panel/api/inbounds/resetAllTraffics": { "/panel/api/inbounds/resetAllTraffics": {
"post": { "post": {
"tags": [ "tags": [

View file

@ -174,6 +174,15 @@ export const sections: readonly Section[] = [
{ name: 'id', in: 'path', type: 'number', desc: 'Inbound ID.' }, { name: 'id', in: 'path', type: 'number', desc: 'Inbound ID.' },
], ],
}, },
{
method: 'POST',
path: '/panel/api/inbounds/:id/delAllClients',
summary: 'Remove every client attached to a single inbound while keeping the inbound itself. Collects emails from settings.clients[] and feeds them into the optimized bulk-delete path (runtime user removal + traffic-row cleanup + SyncInbound). Destructive and cannot be undone.',
params: [
{ name: 'id', in: 'path', type: 'number', desc: 'Inbound ID.' },
],
response: '{\n "success": true,\n "obj": {\n "deleted": 12\n }\n}',
},
{ {
method: 'POST', method: 'POST',
path: '/panel/api/inbounds/resetAllTraffics', path: '/panel/api/inbounds/resetAllTraffics',