mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-10-02 20:22:10 +03:00
Sanaei
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.
41 lines
2.0 KiB
Plaintext
41 lines
2.0 KiB
Plaintext
---
|
|
title: WebSocket
|
|
description: Real-time status updates via WebSocket. Connect once at
|
|
<code>ws://<panel>/ws</code> to receive a stream of JSON messages without
|
|
polling. Requires an authenticated session cookie (Bearer token auth is not
|
|
supported). Each message has a <code>type</code> field that identifies the
|
|
payload shape.
|
|
full: true
|
|
_openapi:
|
|
preload:
|
|
- ./public/openapi.json
|
|
toc:
|
|
- depth: 2
|
|
title: Upgrade an HTTP connection to a WebSocket. Requires an authenticated
|
|
session cookie (Bearer token auth is not supported here). Returns 101
|
|
Switching Protocols on success. The server then pushes JSON messages
|
|
described below.
|
|
url: '#upgrade-an-http-connection-to-a-websocket-requires-an-authenticated-session-cookie-bearer-token-auth-is-not-supported-here-returns-101-switching-protocols-on-success-the-server-then-pushes-json-messages-described-below'
|
|
structuredData:
|
|
headings:
|
|
- content: Upgrade an HTTP connection to a WebSocket. Requires an authenticated
|
|
session cookie (Bearer token auth is not supported here). Returns 101
|
|
Switching Protocols on success. The server then pushes JSON messages
|
|
described below.
|
|
id: upgrade-an-http-connection-to-a-websocket-requires-an-authenticated-session-cookie-bearer-token-auth-is-not-supported-here-returns-101-switching-protocols-on-success-the-server-then-pushes-json-messages-described-below
|
|
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":"/ws","method":"get"}]} showTitle />
|
|
</>
|
|
);
|
|
} |