mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-08-20 14:13:03 +03:00
3c087f6fd9
fumadocs-core 16.14.5 switched its search engine from Orama to zbsearch 4,
so the panel docs follow it up to the same major.
zbsearch 4 still rejects locale codes as tokenizer languages ("en" throws,
only "english" is accepted), so the custom search dialog that forces an
English index stays necessary — verified by loading the built static index
for all four locales and searching it through fumadocs' own client.
Around that:
- use `staticClient`, as `oramaStaticClient` is now a deprecated alias
- drop @orama/orama, which nothing depends on or imports any more
- correct the two comments that still described Orama and pointed at its
docs and tokenizer package, one of them suggesting a language zbsearch
does not have
- restore the corepack integrity hash on `packageManager`, which CI reads
through pnpm/action-setup
- prune minimumReleaseAgeExclude entries for versions no longer installed
The API reference MDX changes are serialization-only: fumadocs-openapi
11.2.4 emits plain scalars where it used folded ones. Parsed frontmatter
and page bodies are unchanged.
91 lines
4.8 KiB
Plaintext
91 lines
4.8 KiB
Plaintext
---
|
||
title: Hosts
|
||
description: Per-inbound override endpoints. Each enabled host renders one extra
|
||
subscription link/proxy with its own address/port/TLS, superseding the legacy
|
||
externalProxy array. All endpoints under /panel/api/hosts.
|
||
full: true
|
||
_openapi:
|
||
preload:
|
||
- ./public/openapi.json
|
||
toc:
|
||
- depth: 2
|
||
title: List every host across all inbounds, grouped by inbound then ordered by
|
||
sort order.
|
||
url: '#list-every-host-across-all-inbounds-grouped-by-inbound-then-ordered-by-sort-order'
|
||
- depth: 2
|
||
title: Fetch a single host by ID.
|
||
url: '#fetch-a-single-host-by-id'
|
||
- depth: 2
|
||
title: Fetch one inbound's hosts, ordered by sort order then id.
|
||
url: '#fetch-one-inbounds-hosts-ordered-by-sort-order-then-id'
|
||
- depth: 2
|
||
title: Distinct, sorted set of tags used across all hosts.
|
||
url: '#distinct-sorted-set-of-tags-used-across-all-hosts'
|
||
- depth: 2
|
||
title: Create a host on an inbound. inboundId and remark are required; security
|
||
defaults to "same" (inherit the inbound).
|
||
url: '#create-a-host-on-an-inbound-inboundid-and-remark-are-required-security-defaults-to-same-inherit-the-inbound'
|
||
- depth: 2
|
||
title: Replace a host’s content. The inbound and sort order are immutable here
|
||
(use /reorder for ordering).
|
||
url: '#replace-a-hosts-content-the-inbound-and-sort-order-are-immutable-here-use-reorder-for-ordering'
|
||
- depth: 2
|
||
title: Delete a host.
|
||
url: '#delete-a-host'
|
||
- depth: 2
|
||
title: Enable or disable a single host (disabled hosts are skipped in
|
||
subscriptions).
|
||
url: '#enable-or-disable-a-single-host-disabled-hosts-are-skipped-in-subscriptions'
|
||
- depth: 2
|
||
title: Set host sort order by the position of each id in the array.
|
||
url: '#set-host-sort-order-by-the-position-of-each-id-in-the-array'
|
||
- depth: 2
|
||
title: Enable or disable many hosts in one call.
|
||
url: '#enable-or-disable-many-hosts-in-one-call'
|
||
- depth: 2
|
||
title: Delete many hosts in one call.
|
||
url: '#delete-many-hosts-in-one-call'
|
||
structuredData:
|
||
headings:
|
||
- content: List every host across all inbounds, grouped by inbound then ordered by
|
||
sort order.
|
||
id: list-every-host-across-all-inbounds-grouped-by-inbound-then-ordered-by-sort-order
|
||
- content: Fetch a single host by ID.
|
||
id: fetch-a-single-host-by-id
|
||
- content: Fetch one inbound's hosts, ordered by sort order then id.
|
||
id: fetch-one-inbounds-hosts-ordered-by-sort-order-then-id
|
||
- content: Distinct, sorted set of tags used across all hosts.
|
||
id: distinct-sorted-set-of-tags-used-across-all-hosts
|
||
- content: Create a host on an inbound. inboundId and remark are required;
|
||
security defaults to "same" (inherit the inbound).
|
||
id: create-a-host-on-an-inbound-inboundid-and-remark-are-required-security-defaults-to-same-inherit-the-inbound
|
||
- content: Replace a host’s content. The inbound and sort order are immutable here
|
||
(use /reorder for ordering).
|
||
id: replace-a-hosts-content-the-inbound-and-sort-order-are-immutable-here-use-reorder-for-ordering
|
||
- content: Delete a host.
|
||
id: delete-a-host
|
||
- content: Enable or disable a single host (disabled hosts are skipped in
|
||
subscriptions).
|
||
id: enable-or-disable-a-single-host-disabled-hosts-are-skipped-in-subscriptions
|
||
- content: Set host sort order by the position of each id in the array.
|
||
id: set-host-sort-order-by-the-position-of-each-id-in-the-array
|
||
- content: Enable or disable many hosts in one call.
|
||
id: enable-or-disable-many-hosts-in-one-call
|
||
- content: Delete many hosts in one call.
|
||
id: delete-many-hosts-in-one-call
|
||
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/hosts/list","method":"get"},{"path":"/panel/api/hosts/get/{id}","method":"get"},{"path":"/panel/api/hosts/byInbound/{inboundId}","method":"get"},{"path":"/panel/api/hosts/tags","method":"get"},{"path":"/panel/api/hosts/add","method":"post"},{"path":"/panel/api/hosts/update/{id}","method":"post"},{"path":"/panel/api/hosts/del/{id}","method":"post"},{"path":"/panel/api/hosts/setEnable/{id}","method":"post"},{"path":"/panel/api/hosts/reorder","method":"post"},{"path":"/panel/api/hosts/bulk/setEnable","method":"post"},{"path":"/panel/api/hosts/bulk/del","method":"post"}]} showTitle />
|
||
</>
|
||
);
|
||
} |