mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-10-01 14:16:42 +08:00
ilyusha
0ff3c23948
* fix(api-docs): generate request bodies for all encodings The OpenAPI generator only recognized generic body parameters, so JSON, form, and multipart declarations disappeared into empty application/json objects. Generate the declared media type and schema, preserve optionality and conditional requirements, and encode repeated form arrays the way Gin expects. Correct the request metadata exposed by the complete schemas and keep the panel and docs specifications synchronized. * fix(api-docs): align alternative request schemas Keep non-empty constraints on the selected request-body alternative without rejecting empty values for the alternatives that panel requests also include. Allow null client IP lists because model serialization emits them while cleared rows await pruning. * fix(api-docs): send object urlencoded fields as JSON, document the inbound update body Four defects the request-body rework exposed or left behind: - An object-typed field in an x-www-form-urlencoded body got no encoding entry, so OpenAPI 3.0 serialized it form-style. Swagger "Try it out" and generated clients sent memberWeights=3&memberWeights=0.2 to /panel/api/sub-balancers, and parseSubBalancerForm json.Unmarshals the raw field, so every such call failed with "invalid memberWeights". Emit encoding.<name>.contentType = application/json instead. - bodyRequiredOneOf names were never checked against the declared body params: a typo emitted an anyOf branch requiring a property that does not exist — unsatisfiable — and make gen still passed. Throw now, and extend the requestSchema guard to reject bodyRequiredOneOf as well. - /panel/api/inbounds/update/:id advertised no request body although its own summary says the shape mirrors /add and updateInbound binds one. Both entries now share an inboundBody const so they cannot drift. - The mixed-locations error was the only buildOperation throw without the method and path, aborting make gen without naming the offender. Regenerated frontend/public/openapi.json and copied it to docs/public/openapi.json. No MDX regeneration: no summary changed. --------- Co-authored-by: Sanaei <ho3ein.sanaei@gmail.com>
62 lines
3.5 KiB
Plaintext
62 lines
3.5 KiB
Plaintext
---
|
|
title: Subscription Balancers
|
|
description: 'Client-side balancers for the JSON subscription: each enabled
|
|
balancer is emitted as one extra config document whose members are the proxy
|
|
outbounds of the selected inbounds (routing.balancers + burstObservatory).
|
|
Managed in Settings → Sub Balancers.'
|
|
full: true
|
|
_openapi:
|
|
preload:
|
|
- ./public/openapi.json
|
|
toc:
|
|
- depth: 2
|
|
title: List all subscription balancers in sort order (sort_order asc, id asc).
|
|
url: '#list-all-subscription-balancers-in-sort-order-sort_order-asc-id-asc'
|
|
- depth: 2
|
|
title: Create a subscription balancer. It appears in the JSON subscription of
|
|
every client that sits on at least one selected inbound.
|
|
url: '#create-a-subscription-balancer-it-appears-in-the-json-subscription-of-every-client-that-sits-on-at-least-one-selected-inbound'
|
|
- depth: 2
|
|
title: Update a balancer by id. Accepts the same form fields as create (full-row
|
|
update); omitting memberWeights clears stored weights, while omitting
|
|
enabled keeps its current value.
|
|
url: '#update-a-balancer-by-id-accepts-the-same-form-fields-as-create-full-row-update-omitting-memberweights-clears-stored-weights-while-omitting-enabled-keeps-its-current-value'
|
|
- depth: 2
|
|
title: Delete a balancer by id.
|
|
url: '#delete-a-balancer-by-id'
|
|
- depth: 2
|
|
title: Delete a balancer by id (POST alias of DELETE for clients that cannot
|
|
send DELETE).
|
|
url: '#delete-a-balancer-by-id-post-alias-of-delete-for-clients-that-cannot-send-delete'
|
|
structuredData:
|
|
headings:
|
|
- content: List all subscription balancers in sort order (sort_order asc, id asc).
|
|
id: list-all-subscription-balancers-in-sort-order-sort_order-asc-id-asc
|
|
- content: Create a subscription balancer. It appears in the JSON subscription of
|
|
every client that sits on at least one selected inbound.
|
|
id: create-a-subscription-balancer-it-appears-in-the-json-subscription-of-every-client-that-sits-on-at-least-one-selected-inbound
|
|
- content: Update a balancer by id. Accepts the same form fields as create
|
|
(full-row update); omitting memberWeights clears stored weights, while
|
|
omitting enabled keeps its current value.
|
|
id: update-a-balancer-by-id-accepts-the-same-form-fields-as-create-full-row-update-omitting-memberweights-clears-stored-weights-while-omitting-enabled-keeps-its-current-value
|
|
- content: Delete a balancer by id.
|
|
id: delete-a-balancer-by-id
|
|
- content: Delete a balancer by id (POST alias of DELETE for clients that cannot
|
|
send DELETE).
|
|
id: delete-a-balancer-by-id-post-alias-of-delete-for-clients-that-cannot-send-delete
|
|
contents: []
|
|
---
|
|
|
|
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
|
|
|
|
export default function Layout(props) {
|
|
const { APIPage, OpenAPIPage } = props.components ?? {};
|
|
// "APIPage" is the old name from v10, this allows both for backward compatibility
|
|
const Comp = OpenAPIPage ?? APIPage;
|
|
return (
|
|
<>
|
|
{props.children}
|
|
<Comp document="./public/openapi.json" webhooks={[]} operations={[{"path":"/panel/api/sub-balancers","method":"get"},{"path":"/panel/api/sub-balancers","method":"post"},{"path":"/panel/api/sub-balancers/{id}","method":"post"},{"path":"/panel/api/sub-balancers/{id}","method":"delete"},{"path":"/panel/api/sub-balancers/{id}/del","method":"post"}]} showTitle />
|
|
</>
|
|
);
|
|
} |