Skip to content

LLM Wiki is a cross-platform desktop application that turns your documents into an organized, interlinked knowledge base — automatically. Instead of traditional RAG (retrieve-and-answer from scratch every time), the LLM incrementally builds and maintains a persistent wiki from your sources。

TypeScript

docs(settings): list reviews API endpoint

Dongmin, Yuebec0cf26752
diff --git a/src/components/settings/sections/api-server-section.test.ts b/src/components/settings/sections/api-server-section.test.ts
new file mode 100644
index 00000000..25b569c0
--- /dev/null
+++ b/src/components/settings/sections/api-server-section.test.ts
@@ -0,0 +1,13 @@
+import { describe, expect, it } from "vitest"
+
+import { API_ENDPOINTS } from "./api-server-section"
+
+describe("API server endpoint documentation", () => {
+ it("lists the project review endpoint", () => {
+ expect(API_ENDPOINTS).toContainEqual({
+ method: "GET",
+ path: "/api/v1/projects/{id}/reviews",
+ noteKey: "endpointReviewsNote",
+ })
+ })
+})
diff --git a/src/components/settings/sections/api-server-section.tsx b/src/components/settings/sections/api-server-section.tsx
index c762fc49..ae5f75f0 100644
--- a/src/components/settings/sections/api-server-section.tsx
+++ b/src/components/settings/sections/api-server-section.tsx
@@ -41,11 +41,12 @@ interface ApiHealth {
* a route there, update this list — it's the only place users discover
* the API contract until we ship a proper OpenAPI doc.
*/
-const ENDPOINTS: Array<{ method: "GET" | "POST"; path: string; noteKey: string }> = [
+export const API_ENDPOINTS: Array<{ method: "GET" | "POST"; path: string; noteKey: string }> = [
{ method: "GET", path: "/api/v1/health", noteKey: "endpointHealthNote" },
{ method: "GET", path: "/api/v1/projects", noteKey: "endpointProjectsNote" },
{ method: "GET", path: "/api/v1/projects/{id}/files", noteKey: "endpointFilesNote" },
{ method: "GET", path: "/api/v1/projects/{id}/files/content", noteKey: "endpointContentNote" },
+ { method: "GET", path: "/api/v1/projects/{id}/reviews", noteKey: "endpointReviewsNote" },
{ method: "POST", path: "/api/v1/projects/{id}/search", noteKey: "endpointSearchNote" },
{ method: "GET", path: "/api/v1/projects/{id}/graph", noteKey: "endpointGraphNote" },
{ method: "POST", path: "/api/v1/projects/{id}/sources/rescan", noteKey: "endpointRescanNote" },
@@ -480,7 +481,7 @@ export function ApiServerSection({ draft, setDraft }: Props) {
})}
</p>
<div className="space-y-1 text-xs">
- {ENDPOINTS.map((endpoint) => {
+ {API_ENDPOINTS.map((endpoint) => {
const note = t(`settings.sections.apiServer.${endpoint.noteKey}`, {
defaultValue: "",
})
diff --git a/src/i18n/en.json b/src/i18n/en.json
index 0be056c0..ab2a72a0 100644
--- a/src/i18n/en.json
+++ b/src/i18n/en.json
@@ -494,6 +494,7 @@
"endpointProjectsNote": "List known projects with their IDs and paths.",
"endpointFilesNote": "?root=wiki|sources|all; ?recursive=false; ?maxFiles=N (≤10000).",
"endpointContentNote": "?path=wiki/index.md — text files only, 2 MB max.",
+ "endpointReviewsNote": "?status=unresolved|resolved|all; ?type=missing-page; ?limit=N. Defaults to unresolved Review items.",
"endpointSearchNote": "JSON body: { query, topK?, includeContent?, queryEmbedding? }. Uses shared keyword + vector retrieval when embeddings are configured.",
"endpointGraphNote": "?q=…&nodeType=…&limit=N — wikilinks graph derived from wiki/*.md.",
"endpointRescanNote": "Triggers a backend rescan using your Source Watch config.",
diff --git a/src/i18n/zh.json b/src/i18n/zh.json
index 09f5b3b9..1e87273d 100644
--- a/src/i18n/zh.json
+++ b/src/i18n/zh.json
@@ -494,6 +494,7 @@
"endpointProjectsNote": "列出所有已知项目及其 ID 和路径。",
"endpointFilesNote": "?root=wiki|sources|all;?recursive=false;?maxFiles=N(≤10000)。",
"endpointContentNote": "?path=wiki/index.md —— 仅文本文件,最大 2 MB。",
+ "endpointReviewsNote": "?status=unresolved|resolved|all;?type=missing-page;?limit=N。默认返回未解决的 Review 项。",
"endpointSearchNote": "JSON body:{ query, topK?, includeContent?, queryEmbedding? }。配置嵌入后使用统一的关键词 + 向量检索。",
"endpointGraphNote": "?q=…&nodeType=…&limit=N —— 基于 wiki/*.md 的双链图谱。",
"endpointRescanNote": "使用你的资料文件夹监控配置触发后端重新扫描。",