From 09f0f5b8a95203e4a26efe7a23d395f840935d19 Mon Sep 17 00:00:00 2001 From: ChenRussell <792608290@qq.com> Date: Thu, 21 May 2026 19:26:20 +0800 Subject: [PATCH] fix(swagger): Fix some Swagger API endpoints returning 404 errors and regenerate the Swagger documentation --- docs/docs.go | 2566 ++++++++++++++++---------------- docs/swagger.json | 2566 ++++++++++++++++---------------- docs/swagger.yaml | 1682 ++++++++++----------- internal/handler/datasource.go | 28 +- internal/handler/wiki_page.go | 30 +- 5 files changed, 3436 insertions(+), 3436 deletions(-) diff --git a/docs/docs.go b/docs/docs.go index 71f656e7..4abaf5f8 100644 --- a/docs/docs.go +++ b/docs/docs.go @@ -576,1289 +576,6 @@ const docTemplate = `{ } } }, - "/api/v1/datasource": { - "get": { - "description": "List all data sources for a specific knowledge base", - "produces": [ - "application/json" - ], - "tags": [ - "DataSource" - ], - "summary": "List data sources for a knowledge base", - "parameters": [ - { - "type": "string", - "description": "Knowledge base ID", - "name": "kb_id", - "in": "query", - "required": true - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.DataSource" - } - } - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - }, - "post": { - "description": "Create a new data source configuration for a knowledge base", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "DataSource" - ], - "summary": "Create a new data source", - "parameters": [ - { - "description": "Data source configuration", - "name": "request", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.DataSource" - } - } - ], - "responses": { - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.DataSource" - } - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - } - }, - "/api/v1/datasource/logs/{log_id}": { - "get": { - "description": "Retrieve a specific sync log entry", - "produces": [ - "application/json" - ], - "tags": [ - "DataSource" - ], - "summary": "Get specific sync log", - "parameters": [ - { - "type": "string", - "description": "Sync log ID", - "name": "log_id", - "in": "path", - "required": true - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.SyncLog" - } - }, - "404": { - "description": "Not Found", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - } - }, - "/api/v1/datasource/types": { - "get": { - "description": "Get list of available data source connectors", - "produces": [ - "application/json" - ], - "tags": [ - "DataSource" - ], - "summary": "Get available connectors", - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_datasource.ConnectorMetadata" - } - } - } - } - } - }, - "/api/v1/datasource/validate-credentials": { - "post": { - "description": "Validate connectivity to an external data source using type + credentials", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "DataSource" - ], - "summary": "Test connection with raw credentials (no persistence)", - "parameters": [ - { - "description": "type and credentials", - "name": "request", - "in": "body", - "required": true, - "schema": { - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - } - }, - "/api/v1/datasource/{id}": { - "get": { - "description": "Retrieve a data source configuration by ID", - "produces": [ - "application/json" - ], - "tags": [ - "DataSource" - ], - "summary": "Get a data source by ID", - "parameters": [ - { - "type": "string", - "description": "Data source ID", - "name": "id", - "in": "path", - "required": true - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.DataSource" - } - }, - "404": { - "description": "Not Found", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - }, - "put": { - "description": "Update an existing data source configuration", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "DataSource" - ], - "summary": "Update a data source", - "parameters": [ - { - "type": "string", - "description": "Data source ID", - "name": "id", - "in": "path", - "required": true - }, - { - "description": "Updated configuration", - "name": "request", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.DataSource" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.DataSource" - } - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - }, - "delete": { - "description": "Delete a data source (soft delete)", - "tags": [ - "DataSource" - ], - "summary": "Delete a data source", - "parameters": [ - { - "type": "string", - "description": "Data source ID", - "name": "id", - "in": "path", - "required": true - } - ], - "responses": { - "204": { - "description": "No Content" - }, - "404": { - "description": "Not Found", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - } - }, - "/api/v1/datasource/{id}/logs": { - "get": { - "description": "Retrieve sync history for a data source", - "produces": [ - "application/json" - ], - "tags": [ - "DataSource" - ], - "summary": "Get sync logs", - "parameters": [ - { - "type": "string", - "description": "Data source ID", - "name": "id", - "in": "path", - "required": true - }, - { - "type": "integer", - "description": "Limit (default: 10)", - "name": "limit", - "in": "query" - }, - { - "type": "integer", - "description": "Offset (default: 0)", - "name": "offset", - "in": "query" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.SyncLog" - } - } - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - } - }, - "/api/v1/datasource/{id}/pause": { - "post": { - "description": "Pause a data source's scheduled syncs", - "tags": [ - "DataSource" - ], - "summary": "Pause data source", - "parameters": [ - { - "type": "string", - "description": "Data source ID", - "name": "id", - "in": "path", - "required": true - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - } - }, - "/api/v1/datasource/{id}/resources": { - "get": { - "description": "List resources available for sync in the external system", - "produces": [ - "application/json" - ], - "tags": [ - "DataSource" - ], - "summary": "List available resources in data source", - "parameters": [ - { - "type": "string", - "description": "Data source ID", - "name": "id", - "in": "path", - "required": true - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.Resource" - } - } - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - } - }, - "/api/v1/datasource/{id}/resume": { - "post": { - "description": "Resume a paused data source", - "tags": [ - "DataSource" - ], - "summary": "Resume data source", - "parameters": [ - { - "type": "string", - "description": "Data source ID", - "name": "id", - "in": "path", - "required": true - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - } - }, - "/api/v1/datasource/{id}/sync": { - "post": { - "description": "Trigger an immediate sync for a data source", - "tags": [ - "DataSource" - ], - "summary": "Trigger immediate sync", - "parameters": [ - { - "type": "string", - "description": "Data source ID", - "name": "id", - "in": "path", - "required": true - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.SyncLog" - } - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - } - }, - "/api/v1/datasource/{id}/validate": { - "post": { - "description": "Validate the connection to an external data source", - "tags": [ - "DataSource" - ], - "summary": "Test data source connection", - "parameters": [ - { - "type": "string", - "description": "Data source ID", - "name": "id", - "in": "path", - "required": true - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - } - }, - "/api/v1/knowledgebase/{kb_id}/wiki/auto-fix": { - "post": { - "security": [ - { - "Bearer": [] - } - ], - "description": "Automatically fix fixable wiki issues (broken links, etc.)", - "produces": [ - "application/json" - ], - "tags": [ - "Wiki" - ], - "summary": "Auto-fix wiki issues", - "parameters": [ - { - "type": "string", - "description": "Knowledge base ID", - "name": "kb_id", - "in": "path", - "required": true - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object", - "additionalProperties": true - } - } - } - } - }, - "/api/v1/knowledgebase/{kb_id}/wiki/graph": { - "get": { - "security": [ - { - "Bearer": [] - } - ], - "description": "Returns a slice of the wiki link graph for visualization. Supports\n` + "`" + `mode=overview` + "`" + ` (top-N most-connected pages, default) and\n` + "`" + `mode=ego` + "`" + ` (BFS neighborhood of a center slug) to keep response\nsize tractable for knowledge bases with tens of thousands of pages.", - "produces": [ - "application/json" - ], - "tags": [ - "Wiki" - ], - "summary": "Get wiki link graph", - "parameters": [ - { - "type": "string", - "description": "Knowledge base ID", - "name": "kb_id", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "overview (default) | ego", - "name": "mode", - "in": "query" - }, - { - "type": "string", - "description": "Center slug for ego mode", - "name": "center", - "in": "query" - }, - { - "type": "integer", - "description": "Ego BFS depth (1-3, default 1)", - "name": "depth", - "in": "query" - }, - { - "type": "string", - "description": "Comma-separated page_type allow-list", - "name": "types", - "in": "query" - }, - { - "type": "integer", - "description": "Max nodes to return (default 500, max 2000)", - "name": "limit", - "in": "query" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiGraphData" - } - } - } - } - }, - "/api/v1/knowledgebase/{kb_id}/wiki/index": { - "get": { - "security": [ - { - "Bearer": [] - } - ], - "description": "Returns the wiki index as intro text plus per-type paginated\ndirectory groups. The heavy directory markdown that used to\nlive in wiki_pages.content was replaced with this structured\nresponse so a KB with tens of thousands of pages no longer\nmaterializes megabytes of TEXT on every index open.", - "produces": [ - "application/json" - ], - "tags": [ - "Wiki" - ], - "summary": "Get wiki index view", - "parameters": [ - { - "type": "string", - "description": "Knowledge base ID", - "name": "kb_id", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "Comma-separated page types (default: all content types)", - "name": "types", - "in": "query" - }, - { - "type": "integer", - "description": "Per-group window size, 1-200 (default 50)", - "name": "limit", - "in": "query" - }, - { - "type": "string", - "description": "Opaque offset cursor from previous response", - "name": "cursor", - "in": "query" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiIndexResponse" - } - } - } - } - }, - "/api/v1/knowledgebase/{kb_id}/wiki/issues": { - "get": { - "security": [ - { - "Bearer": [] - } - ], - "description": "List issues flagged on wiki pages with optional filtering", - "produces": [ - "application/json" - ], - "tags": [ - "Wiki" - ], - "summary": "List wiki page issues", - "parameters": [ - { - "type": "string", - "description": "Knowledge base ID", - "name": "kb_id", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "Filter by page slug", - "name": "slug", - "in": "query" - }, - { - "type": "string", - "description": "Filter by status (pending, ignored, resolved)", - "name": "status", - "in": "query" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPageIssue" - } - } - } - } - } - }, - "/api/v1/knowledgebase/{kb_id}/wiki/issues/{issue_id}/status": { - "put": { - "security": [ - { - "Bearer": [] - } - ], - "description": "Update the status of a flagged wiki page issue", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "Wiki" - ], - "summary": "Update wiki page issue status", - "parameters": [ - { - "type": "string", - "description": "Knowledge base ID", - "name": "kb_id", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "Issue ID", - "name": "issue_id", - "in": "path", - "required": true - }, - { - "description": "New status {'status': 'ignored'}", - "name": "status", - "in": "body", - "required": true, - "schema": { - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError" - } - } - } - } - }, - "/api/v1/knowledgebase/{kb_id}/wiki/lint": { - "get": { - "security": [ - { - "Bearer": [] - } - ], - "description": "Perform a comprehensive health check on the wiki", - "produces": [ - "application/json" - ], - "tags": [ - "Wiki" - ], - "summary": "Run wiki lint", - "parameters": [ - { - "type": "string", - "description": "Knowledge base ID", - "name": "kb_id", - "in": "path", - "required": true - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_application_service.WikiLintReport" - } - } - } - } - }, - "/api/v1/knowledgebase/{kb_id}/wiki/log": { - "get": { - "security": [ - { - "Bearer": [] - } - ], - "description": "Returns a paginated feed of wiki operation events (ingest, retract, ...)\nnewest-first. Pagination is cursor-based: pass ` + "`" + `next_cursor` + "`" + ` from the\nprevious response back as ` + "`" + `cursor` + "`" + ` to fetch the next page.", - "produces": [ - "application/json" - ], - "tags": [ - "Wiki" - ], - "summary": "Get wiki operation log", - "parameters": [ - { - "type": "string", - "description": "Knowledge base ID", - "name": "kb_id", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "Opaque cursor from the previous page (empty = newest)", - "name": "cursor", - "in": "query" - }, - { - "type": "integer", - "description": "Page size, 1-200 (default 50)", - "name": "limit", - "in": "query" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiLogEntryListResponse" - } - } - } - } - }, - "/api/v1/knowledgebase/{kb_id}/wiki/pages": { - "get": { - "security": [ - { - "Bearer": [] - } - ], - "description": "List wiki pages with optional filtering and pagination", - "produces": [ - "application/json" - ], - "tags": [ - "Wiki" - ], - "summary": "List wiki pages", - "parameters": [ - { - "type": "string", - "description": "Knowledge base ID", - "name": "kb_id", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "Filter by page type", - "name": "page_type", - "in": "query" - }, - { - "type": "string", - "description": "Filter by status", - "name": "status", - "in": "query" - }, - { - "type": "string", - "description": "Full-text search", - "name": "query", - "in": "query" - }, - { - "type": "integer", - "description": "Page number", - "name": "page", - "in": "query" - }, - { - "type": "integer", - "description": "Page size", - "name": "page_size", - "in": "query" - }, - { - "type": "string", - "description": "Sort field", - "name": "sort_by", - "in": "query" - }, - { - "type": "string", - "description": "Sort order (asc/desc)", - "name": "sort_order", - "in": "query" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPageListResponse" - } - }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError" - } - } - } - }, - "post": { - "security": [ - { - "Bearer": [] - } - ], - "description": "Create a new wiki page in the knowledge base", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "Wiki" - ], - "summary": "Create a wiki page", - "parameters": [ - { - "type": "string", - "description": "Knowledge base ID", - "name": "kb_id", - "in": "path", - "required": true - }, - { - "description": "Wiki page data", - "name": "page", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPage" - } - } - ], - "responses": { - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPage" - } - }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError" - } - } - } - } - }, - "/api/v1/knowledgebase/{kb_id}/wiki/pages/{slug}": { - "get": { - "security": [ - { - "Bearer": [] - } - ], - "description": "Retrieve a wiki page by its slug", - "produces": [ - "application/json" - ], - "tags": [ - "Wiki" - ], - "summary": "Get a wiki page by slug", - "parameters": [ - { - "type": "string", - "description": "Knowledge base ID", - "name": "kb_id", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "Page slug", - "name": "slug", - "in": "path", - "required": true - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPage" - } - }, - "404": { - "description": "Not Found", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError" - } - } - } - }, - "put": { - "security": [ - { - "Bearer": [] - } - ], - "description": "Update an existing wiki page by slug", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "Wiki" - ], - "summary": "Update a wiki page", - "parameters": [ - { - "type": "string", - "description": "Knowledge base ID", - "name": "kb_id", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "Page slug", - "name": "slug", - "in": "path", - "required": true - }, - { - "description": "Updated wiki page data", - "name": "page", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPage" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPage" - } - }, - "404": { - "description": "Not Found", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError" - } - } - } - }, - "delete": { - "security": [ - { - "Bearer": [] - } - ], - "description": "Soft-delete a wiki page by slug", - "tags": [ - "Wiki" - ], - "summary": "Delete a wiki page", - "parameters": [ - { - "type": "string", - "description": "Knowledge base ID", - "name": "kb_id", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "Page slug", - "name": "slug", - "in": "path", - "required": true - } - ], - "responses": { - "204": { - "description": "No Content" - }, - "404": { - "description": "Not Found", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError" - } - } - } - } - }, - "/api/v1/knowledgebase/{kb_id}/wiki/rebuild-links": { - "post": { - "security": [ - { - "Bearer": [] - } - ], - "description": "Re-parse all pages and rebuild bidirectional link references", - "tags": [ - "Wiki" - ], - "summary": "Rebuild wiki links", - "parameters": [ - { - "type": "string", - "description": "Knowledge base ID", - "name": "kb_id", - "in": "path", - "required": true - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - } - }, - "/api/v1/knowledgebase/{kb_id}/wiki/search": { - "get": { - "security": [ - { - "Bearer": [] - } - ], - "description": "Full-text search over wiki pages", - "produces": [ - "application/json" - ], - "tags": [ - "Wiki" - ], - "summary": "Search wiki pages", - "parameters": [ - { - "type": "string", - "description": "Knowledge base ID", - "name": "kb_id", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "Search query", - "name": "q", - "in": "query", - "required": true - }, - { - "type": "integer", - "description": "Max results (default 10)", - "name": "limit", - "in": "query" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPage" - } - } - } - } - } - }, - "/api/v1/knowledgebase/{kb_id}/wiki/stats": { - "get": { - "security": [ - { - "Bearer": [] - } - ], - "description": "Returns aggregate statistics about the wiki", - "produces": [ - "application/json" - ], - "tags": [ - "Wiki" - ], - "summary": "Get wiki statistics", - "parameters": [ - { - "type": "string", - "description": "Knowledge base ID", - "name": "kb_id", - "in": "path", - "required": true - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiStats" - } - } - } - } - }, "/auth/auto-setup": { "post": { "description": "Lite 版专用:首次启动时自动创建默认用户和租户并返回令牌,后续启动直接签发令牌,免除手动注册/登录流程", @@ -2837,6 +1554,554 @@ const docTemplate = `{ } } }, + "/datasource": { + "get": { + "description": "List all data sources for a specific knowledge base", + "produces": [ + "application/json" + ], + "tags": [ + "DataSource" + ], + "summary": "List data sources for a knowledge base", + "parameters": [ + { + "type": "string", + "description": "Knowledge base ID", + "name": "kb_id", + "in": "query", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.DataSource" + } + } + }, + "400": { + "description": "Bad Request", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "post": { + "description": "Create a new data source configuration for a knowledge base", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "DataSource" + ], + "summary": "Create a new data source", + "parameters": [ + { + "description": "Data source configuration", + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.DataSource" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.DataSource" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + } + }, + "/datasource/logs/{log_id}": { + "get": { + "description": "Retrieve a specific sync log entry", + "produces": [ + "application/json" + ], + "tags": [ + "DataSource" + ], + "summary": "Get specific sync log", + "parameters": [ + { + "type": "string", + "description": "Sync log ID", + "name": "log_id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.SyncLog" + } + }, + "404": { + "description": "Not Found", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + } + }, + "/datasource/types": { + "get": { + "description": "Get list of available data source connectors", + "produces": [ + "application/json" + ], + "tags": [ + "DataSource" + ], + "summary": "Get available connectors", + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_datasource.ConnectorMetadata" + } + } + } + } + } + }, + "/datasource/validate-credentials": { + "post": { + "description": "Validate connectivity to an external data source using type + credentials", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "DataSource" + ], + "summary": "Test connection with raw credentials (no persistence)", + "parameters": [ + { + "description": "type and credentials", + "name": "request", + "in": "body", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "400": { + "description": "Bad Request", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + } + }, + "/datasource/{id}": { + "get": { + "description": "Retrieve a data source configuration by ID", + "produces": [ + "application/json" + ], + "tags": [ + "DataSource" + ], + "summary": "Get a data source by ID", + "parameters": [ + { + "type": "string", + "description": "Data source ID", + "name": "id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.DataSource" + } + }, + "404": { + "description": "Not Found", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "put": { + "description": "Update an existing data source configuration", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "DataSource" + ], + "summary": "Update a data source", + "parameters": [ + { + "type": "string", + "description": "Data source ID", + "name": "id", + "in": "path", + "required": true + }, + { + "description": "Updated configuration", + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.DataSource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.DataSource" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "delete": { + "description": "Delete a data source (soft delete)", + "tags": [ + "DataSource" + ], + "summary": "Delete a data source", + "parameters": [ + { + "type": "string", + "description": "Data source ID", + "name": "id", + "in": "path", + "required": true + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "404": { + "description": "Not Found", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + } + }, + "/datasource/{id}/logs": { + "get": { + "description": "Retrieve sync history for a data source", + "produces": [ + "application/json" + ], + "tags": [ + "DataSource" + ], + "summary": "Get sync logs", + "parameters": [ + { + "type": "string", + "description": "Data source ID", + "name": "id", + "in": "path", + "required": true + }, + { + "type": "integer", + "description": "Limit (default: 10)", + "name": "limit", + "in": "query" + }, + { + "type": "integer", + "description": "Offset (default: 0)", + "name": "offset", + "in": "query" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.SyncLog" + } + } + }, + "400": { + "description": "Bad Request", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + } + }, + "/datasource/{id}/pause": { + "post": { + "description": "Pause a data source's scheduled syncs", + "tags": [ + "DataSource" + ], + "summary": "Pause data source", + "parameters": [ + { + "type": "string", + "description": "Data source ID", + "name": "id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "400": { + "description": "Bad Request", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + } + }, + "/datasource/{id}/resources": { + "get": { + "description": "List resources available for sync in the external system", + "produces": [ + "application/json" + ], + "tags": [ + "DataSource" + ], + "summary": "List available resources in data source", + "parameters": [ + { + "type": "string", + "description": "Data source ID", + "name": "id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.Resource" + } + } + }, + "400": { + "description": "Bad Request", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + } + }, + "/datasource/{id}/resume": { + "post": { + "description": "Resume a paused data source", + "tags": [ + "DataSource" + ], + "summary": "Resume data source", + "parameters": [ + { + "type": "string", + "description": "Data source ID", + "name": "id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "400": { + "description": "Bad Request", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + } + }, + "/datasource/{id}/sync": { + "post": { + "description": "Trigger an immediate sync for a data source", + "tags": [ + "DataSource" + ], + "summary": "Trigger immediate sync", + "parameters": [ + { + "type": "string", + "description": "Data source ID", + "name": "id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.SyncLog" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + } + }, + "/datasource/{id}/validate": { + "post": { + "description": "Validate the connection to an external data source", + "tags": [ + "DataSource" + ], + "summary": "Test data source connection", + "parameters": [ + { + "type": "string", + "description": "Data source ID", + "name": "id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "400": { + "description": "Bad Request", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + } + }, "/evaluation/": { "get": { "security": [ @@ -6846,6 +6111,741 @@ const docTemplate = `{ } } }, + "/knowledgebase/{kb_id}/wiki/auto-fix": { + "post": { + "security": [ + { + "Bearer": [] + } + ], + "description": "Automatically fix fixable wiki issues (broken links, etc.)", + "produces": [ + "application/json" + ], + "tags": [ + "Wiki" + ], + "summary": "Auto-fix wiki issues", + "parameters": [ + { + "type": "string", + "description": "Knowledge base ID", + "name": "kb_id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "additionalProperties": true + } + } + } + } + }, + "/knowledgebase/{kb_id}/wiki/graph": { + "get": { + "security": [ + { + "Bearer": [] + } + ], + "description": "Returns a slice of the wiki link graph for visualization. Supports\n` + "`" + `mode=overview` + "`" + ` (top-N most-connected pages, default) and\n` + "`" + `mode=ego` + "`" + ` (BFS neighborhood of a center slug) to keep response\nsize tractable for knowledge bases with tens of thousands of pages.", + "produces": [ + "application/json" + ], + "tags": [ + "Wiki" + ], + "summary": "Get wiki link graph", + "parameters": [ + { + "type": "string", + "description": "Knowledge base ID", + "name": "kb_id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "overview (default) | ego", + "name": "mode", + "in": "query" + }, + { + "type": "string", + "description": "Center slug for ego mode", + "name": "center", + "in": "query" + }, + { + "type": "integer", + "description": "Ego BFS depth (1-3, default 1)", + "name": "depth", + "in": "query" + }, + { + "type": "string", + "description": "Comma-separated page_type allow-list", + "name": "types", + "in": "query" + }, + { + "type": "integer", + "description": "Max nodes to return (default 500, max 2000)", + "name": "limit", + "in": "query" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiGraphData" + } + } + } + } + }, + "/knowledgebase/{kb_id}/wiki/index": { + "get": { + "security": [ + { + "Bearer": [] + } + ], + "description": "Returns the wiki index as intro text plus per-type paginated\ndirectory groups. The heavy directory markdown that used to\nlive in wiki_pages.content was replaced with this structured\nresponse so a KB with tens of thousands of pages no longer\nmaterializes megabytes of TEXT on every index open.", + "produces": [ + "application/json" + ], + "tags": [ + "Wiki" + ], + "summary": "Get wiki index view", + "parameters": [ + { + "type": "string", + "description": "Knowledge base ID", + "name": "kb_id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "Comma-separated page types (default: all content types)", + "name": "types", + "in": "query" + }, + { + "type": "integer", + "description": "Per-group window size, 1-200 (default 50)", + "name": "limit", + "in": "query" + }, + { + "type": "string", + "description": "Opaque offset cursor from previous response", + "name": "cursor", + "in": "query" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiIndexResponse" + } + } + } + } + }, + "/knowledgebase/{kb_id}/wiki/issues": { + "get": { + "security": [ + { + "Bearer": [] + } + ], + "description": "List issues flagged on wiki pages with optional filtering", + "produces": [ + "application/json" + ], + "tags": [ + "Wiki" + ], + "summary": "List wiki page issues", + "parameters": [ + { + "type": "string", + "description": "Knowledge base ID", + "name": "kb_id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "Filter by page slug", + "name": "slug", + "in": "query" + }, + { + "type": "string", + "description": "Filter by status (pending, ignored, resolved)", + "name": "status", + "in": "query" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPageIssue" + } + } + } + } + } + }, + "/knowledgebase/{kb_id}/wiki/issues/{issue_id}/status": { + "put": { + "security": [ + { + "Bearer": [] + } + ], + "description": "Update the status of a flagged wiki page issue", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "Wiki" + ], + "summary": "Update wiki page issue status", + "parameters": [ + { + "type": "string", + "description": "Knowledge base ID", + "name": "kb_id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "Issue ID", + "name": "issue_id", + "in": "path", + "required": true + }, + { + "description": "New status {'status': 'ignored'}", + "name": "status", + "in": "body", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError" + } + } + } + } + }, + "/knowledgebase/{kb_id}/wiki/lint": { + "get": { + "security": [ + { + "Bearer": [] + } + ], + "description": "Perform a comprehensive health check on the wiki", + "produces": [ + "application/json" + ], + "tags": [ + "Wiki" + ], + "summary": "Run wiki lint", + "parameters": [ + { + "type": "string", + "description": "Knowledge base ID", + "name": "kb_id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_application_service.WikiLintReport" + } + } + } + } + }, + "/knowledgebase/{kb_id}/wiki/log": { + "get": { + "security": [ + { + "Bearer": [] + } + ], + "description": "Returns a paginated feed of wiki operation events (ingest, retract, ...)\nnewest-first. Pagination is cursor-based: pass ` + "`" + `next_cursor` + "`" + ` from the\nprevious response back as ` + "`" + `cursor` + "`" + ` to fetch the next page.", + "produces": [ + "application/json" + ], + "tags": [ + "Wiki" + ], + "summary": "Get wiki operation log", + "parameters": [ + { + "type": "string", + "description": "Knowledge base ID", + "name": "kb_id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "Opaque cursor from the previous page (empty = newest)", + "name": "cursor", + "in": "query" + }, + { + "type": "integer", + "description": "Page size, 1-200 (default 50)", + "name": "limit", + "in": "query" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiLogEntryListResponse" + } + } + } + } + }, + "/knowledgebase/{kb_id}/wiki/pages": { + "get": { + "security": [ + { + "Bearer": [] + } + ], + "description": "List wiki pages with optional filtering and pagination", + "produces": [ + "application/json" + ], + "tags": [ + "Wiki" + ], + "summary": "List wiki pages", + "parameters": [ + { + "type": "string", + "description": "Knowledge base ID", + "name": "kb_id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "Filter by page type", + "name": "page_type", + "in": "query" + }, + { + "type": "string", + "description": "Filter by status", + "name": "status", + "in": "query" + }, + { + "type": "string", + "description": "Full-text search", + "name": "query", + "in": "query" + }, + { + "type": "integer", + "description": "Page number", + "name": "page", + "in": "query" + }, + { + "type": "integer", + "description": "Page size", + "name": "page_size", + "in": "query" + }, + { + "type": "string", + "description": "Sort field", + "name": "sort_by", + "in": "query" + }, + { + "type": "string", + "description": "Sort order (asc/desc)", + "name": "sort_order", + "in": "query" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPageListResponse" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError" + } + } + } + }, + "post": { + "security": [ + { + "Bearer": [] + } + ], + "description": "Create a new wiki page in the knowledge base", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "Wiki" + ], + "summary": "Create a wiki page", + "parameters": [ + { + "type": "string", + "description": "Knowledge base ID", + "name": "kb_id", + "in": "path", + "required": true + }, + { + "description": "Wiki page data", + "name": "page", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPage" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPage" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError" + } + } + } + } + }, + "/knowledgebase/{kb_id}/wiki/pages/{slug}": { + "get": { + "security": [ + { + "Bearer": [] + } + ], + "description": "Retrieve a wiki page by its slug", + "produces": [ + "application/json" + ], + "tags": [ + "Wiki" + ], + "summary": "Get a wiki page by slug", + "parameters": [ + { + "type": "string", + "description": "Knowledge base ID", + "name": "kb_id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "Page slug", + "name": "slug", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPage" + } + }, + "404": { + "description": "Not Found", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError" + } + } + } + }, + "put": { + "security": [ + { + "Bearer": [] + } + ], + "description": "Update an existing wiki page by slug", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "Wiki" + ], + "summary": "Update a wiki page", + "parameters": [ + { + "type": "string", + "description": "Knowledge base ID", + "name": "kb_id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "Page slug", + "name": "slug", + "in": "path", + "required": true + }, + { + "description": "Updated wiki page data", + "name": "page", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPage" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPage" + } + }, + "404": { + "description": "Not Found", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError" + } + } + } + }, + "delete": { + "security": [ + { + "Bearer": [] + } + ], + "description": "Soft-delete a wiki page by slug", + "tags": [ + "Wiki" + ], + "summary": "Delete a wiki page", + "parameters": [ + { + "type": "string", + "description": "Knowledge base ID", + "name": "kb_id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "Page slug", + "name": "slug", + "in": "path", + "required": true + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "404": { + "description": "Not Found", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError" + } + } + } + } + }, + "/knowledgebase/{kb_id}/wiki/rebuild-links": { + "post": { + "security": [ + { + "Bearer": [] + } + ], + "description": "Re-parse all pages and rebuild bidirectional link references", + "tags": [ + "Wiki" + ], + "summary": "Rebuild wiki links", + "parameters": [ + { + "type": "string", + "description": "Knowledge base ID", + "name": "kb_id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + } + }, + "/knowledgebase/{kb_id}/wiki/search": { + "get": { + "security": [ + { + "Bearer": [] + } + ], + "description": "Full-text search over wiki pages", + "produces": [ + "application/json" + ], + "tags": [ + "Wiki" + ], + "summary": "Search wiki pages", + "parameters": [ + { + "type": "string", + "description": "Knowledge base ID", + "name": "kb_id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "Search query", + "name": "q", + "in": "query", + "required": true + }, + { + "type": "integer", + "description": "Max results (default 10)", + "name": "limit", + "in": "query" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPage" + } + } + } + } + } + }, + "/knowledgebase/{kb_id}/wiki/stats": { + "get": { + "security": [ + { + "Bearer": [] + } + ], + "description": "Returns aggregate statistics about the wiki", + "produces": [ + "application/json" + ], + "tags": [ + "Wiki" + ], + "summary": "Get wiki statistics", + "parameters": [ + { + "type": "string", + "description": "Knowledge base ID", + "name": "kb_id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiStats" + } + } + } + } + }, "/mcp-services": { "get": { "security": [ diff --git a/docs/swagger.json b/docs/swagger.json index cc48de52..d1ee5297 100644 --- a/docs/swagger.json +++ b/docs/swagger.json @@ -569,1289 +569,6 @@ } } }, - "/api/v1/datasource": { - "get": { - "description": "List all data sources for a specific knowledge base", - "produces": [ - "application/json" - ], - "tags": [ - "DataSource" - ], - "summary": "List data sources for a knowledge base", - "parameters": [ - { - "type": "string", - "description": "Knowledge base ID", - "name": "kb_id", - "in": "query", - "required": true - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.DataSource" - } - } - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - }, - "post": { - "description": "Create a new data source configuration for a knowledge base", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "DataSource" - ], - "summary": "Create a new data source", - "parameters": [ - { - "description": "Data source configuration", - "name": "request", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.DataSource" - } - } - ], - "responses": { - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.DataSource" - } - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - } - }, - "/api/v1/datasource/logs/{log_id}": { - "get": { - "description": "Retrieve a specific sync log entry", - "produces": [ - "application/json" - ], - "tags": [ - "DataSource" - ], - "summary": "Get specific sync log", - "parameters": [ - { - "type": "string", - "description": "Sync log ID", - "name": "log_id", - "in": "path", - "required": true - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.SyncLog" - } - }, - "404": { - "description": "Not Found", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - } - }, - "/api/v1/datasource/types": { - "get": { - "description": "Get list of available data source connectors", - "produces": [ - "application/json" - ], - "tags": [ - "DataSource" - ], - "summary": "Get available connectors", - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_datasource.ConnectorMetadata" - } - } - } - } - } - }, - "/api/v1/datasource/validate-credentials": { - "post": { - "description": "Validate connectivity to an external data source using type + credentials", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "DataSource" - ], - "summary": "Test connection with raw credentials (no persistence)", - "parameters": [ - { - "description": "type and credentials", - "name": "request", - "in": "body", - "required": true, - "schema": { - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - } - }, - "/api/v1/datasource/{id}": { - "get": { - "description": "Retrieve a data source configuration by ID", - "produces": [ - "application/json" - ], - "tags": [ - "DataSource" - ], - "summary": "Get a data source by ID", - "parameters": [ - { - "type": "string", - "description": "Data source ID", - "name": "id", - "in": "path", - "required": true - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.DataSource" - } - }, - "404": { - "description": "Not Found", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - }, - "put": { - "description": "Update an existing data source configuration", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "DataSource" - ], - "summary": "Update a data source", - "parameters": [ - { - "type": "string", - "description": "Data source ID", - "name": "id", - "in": "path", - "required": true - }, - { - "description": "Updated configuration", - "name": "request", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.DataSource" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.DataSource" - } - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - }, - "delete": { - "description": "Delete a data source (soft delete)", - "tags": [ - "DataSource" - ], - "summary": "Delete a data source", - "parameters": [ - { - "type": "string", - "description": "Data source ID", - "name": "id", - "in": "path", - "required": true - } - ], - "responses": { - "204": { - "description": "No Content" - }, - "404": { - "description": "Not Found", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - } - }, - "/api/v1/datasource/{id}/logs": { - "get": { - "description": "Retrieve sync history for a data source", - "produces": [ - "application/json" - ], - "tags": [ - "DataSource" - ], - "summary": "Get sync logs", - "parameters": [ - { - "type": "string", - "description": "Data source ID", - "name": "id", - "in": "path", - "required": true - }, - { - "type": "integer", - "description": "Limit (default: 10)", - "name": "limit", - "in": "query" - }, - { - "type": "integer", - "description": "Offset (default: 0)", - "name": "offset", - "in": "query" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.SyncLog" - } - } - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - } - }, - "/api/v1/datasource/{id}/pause": { - "post": { - "description": "Pause a data source's scheduled syncs", - "tags": [ - "DataSource" - ], - "summary": "Pause data source", - "parameters": [ - { - "type": "string", - "description": "Data source ID", - "name": "id", - "in": "path", - "required": true - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - } - }, - "/api/v1/datasource/{id}/resources": { - "get": { - "description": "List resources available for sync in the external system", - "produces": [ - "application/json" - ], - "tags": [ - "DataSource" - ], - "summary": "List available resources in data source", - "parameters": [ - { - "type": "string", - "description": "Data source ID", - "name": "id", - "in": "path", - "required": true - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.Resource" - } - } - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - } - }, - "/api/v1/datasource/{id}/resume": { - "post": { - "description": "Resume a paused data source", - "tags": [ - "DataSource" - ], - "summary": "Resume data source", - "parameters": [ - { - "type": "string", - "description": "Data source ID", - "name": "id", - "in": "path", - "required": true - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - } - }, - "/api/v1/datasource/{id}/sync": { - "post": { - "description": "Trigger an immediate sync for a data source", - "tags": [ - "DataSource" - ], - "summary": "Trigger immediate sync", - "parameters": [ - { - "type": "string", - "description": "Data source ID", - "name": "id", - "in": "path", - "required": true - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.SyncLog" - } - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - } - }, - "/api/v1/datasource/{id}/validate": { - "post": { - "description": "Validate the connection to an external data source", - "tags": [ - "DataSource" - ], - "summary": "Test data source connection", - "parameters": [ - { - "type": "string", - "description": "Data source ID", - "name": "id", - "in": "path", - "required": true - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "400": { - "description": "Bad Request", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - } - }, - "/api/v1/knowledgebase/{kb_id}/wiki/auto-fix": { - "post": { - "security": [ - { - "Bearer": [] - } - ], - "description": "Automatically fix fixable wiki issues (broken links, etc.)", - "produces": [ - "application/json" - ], - "tags": [ - "Wiki" - ], - "summary": "Auto-fix wiki issues", - "parameters": [ - { - "type": "string", - "description": "Knowledge base ID", - "name": "kb_id", - "in": "path", - "required": true - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object", - "additionalProperties": true - } - } - } - } - }, - "/api/v1/knowledgebase/{kb_id}/wiki/graph": { - "get": { - "security": [ - { - "Bearer": [] - } - ], - "description": "Returns a slice of the wiki link graph for visualization. Supports\n`mode=overview` (top-N most-connected pages, default) and\n`mode=ego` (BFS neighborhood of a center slug) to keep response\nsize tractable for knowledge bases with tens of thousands of pages.", - "produces": [ - "application/json" - ], - "tags": [ - "Wiki" - ], - "summary": "Get wiki link graph", - "parameters": [ - { - "type": "string", - "description": "Knowledge base ID", - "name": "kb_id", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "overview (default) | ego", - "name": "mode", - "in": "query" - }, - { - "type": "string", - "description": "Center slug for ego mode", - "name": "center", - "in": "query" - }, - { - "type": "integer", - "description": "Ego BFS depth (1-3, default 1)", - "name": "depth", - "in": "query" - }, - { - "type": "string", - "description": "Comma-separated page_type allow-list", - "name": "types", - "in": "query" - }, - { - "type": "integer", - "description": "Max nodes to return (default 500, max 2000)", - "name": "limit", - "in": "query" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiGraphData" - } - } - } - } - }, - "/api/v1/knowledgebase/{kb_id}/wiki/index": { - "get": { - "security": [ - { - "Bearer": [] - } - ], - "description": "Returns the wiki index as intro text plus per-type paginated\ndirectory groups. The heavy directory markdown that used to\nlive in wiki_pages.content was replaced with this structured\nresponse so a KB with tens of thousands of pages no longer\nmaterializes megabytes of TEXT on every index open.", - "produces": [ - "application/json" - ], - "tags": [ - "Wiki" - ], - "summary": "Get wiki index view", - "parameters": [ - { - "type": "string", - "description": "Knowledge base ID", - "name": "kb_id", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "Comma-separated page types (default: all content types)", - "name": "types", - "in": "query" - }, - { - "type": "integer", - "description": "Per-group window size, 1-200 (default 50)", - "name": "limit", - "in": "query" - }, - { - "type": "string", - "description": "Opaque offset cursor from previous response", - "name": "cursor", - "in": "query" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiIndexResponse" - } - } - } - } - }, - "/api/v1/knowledgebase/{kb_id}/wiki/issues": { - "get": { - "security": [ - { - "Bearer": [] - } - ], - "description": "List issues flagged on wiki pages with optional filtering", - "produces": [ - "application/json" - ], - "tags": [ - "Wiki" - ], - "summary": "List wiki page issues", - "parameters": [ - { - "type": "string", - "description": "Knowledge base ID", - "name": "kb_id", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "Filter by page slug", - "name": "slug", - "in": "query" - }, - { - "type": "string", - "description": "Filter by status (pending, ignored, resolved)", - "name": "status", - "in": "query" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPageIssue" - } - } - } - } - } - }, - "/api/v1/knowledgebase/{kb_id}/wiki/issues/{issue_id}/status": { - "put": { - "security": [ - { - "Bearer": [] - } - ], - "description": "Update the status of a flagged wiki page issue", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "Wiki" - ], - "summary": "Update wiki page issue status", - "parameters": [ - { - "type": "string", - "description": "Knowledge base ID", - "name": "kb_id", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "Issue ID", - "name": "issue_id", - "in": "path", - "required": true - }, - { - "description": "New status {'status': 'ignored'}", - "name": "status", - "in": "body", - "required": true, - "schema": { - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError" - } - } - } - } - }, - "/api/v1/knowledgebase/{kb_id}/wiki/lint": { - "get": { - "security": [ - { - "Bearer": [] - } - ], - "description": "Perform a comprehensive health check on the wiki", - "produces": [ - "application/json" - ], - "tags": [ - "Wiki" - ], - "summary": "Run wiki lint", - "parameters": [ - { - "type": "string", - "description": "Knowledge base ID", - "name": "kb_id", - "in": "path", - "required": true - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_application_service.WikiLintReport" - } - } - } - } - }, - "/api/v1/knowledgebase/{kb_id}/wiki/log": { - "get": { - "security": [ - { - "Bearer": [] - } - ], - "description": "Returns a paginated feed of wiki operation events (ingest, retract, ...)\nnewest-first. Pagination is cursor-based: pass `next_cursor` from the\nprevious response back as `cursor` to fetch the next page.", - "produces": [ - "application/json" - ], - "tags": [ - "Wiki" - ], - "summary": "Get wiki operation log", - "parameters": [ - { - "type": "string", - "description": "Knowledge base ID", - "name": "kb_id", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "Opaque cursor from the previous page (empty = newest)", - "name": "cursor", - "in": "query" - }, - { - "type": "integer", - "description": "Page size, 1-200 (default 50)", - "name": "limit", - "in": "query" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiLogEntryListResponse" - } - } - } - } - }, - "/api/v1/knowledgebase/{kb_id}/wiki/pages": { - "get": { - "security": [ - { - "Bearer": [] - } - ], - "description": "List wiki pages with optional filtering and pagination", - "produces": [ - "application/json" - ], - "tags": [ - "Wiki" - ], - "summary": "List wiki pages", - "parameters": [ - { - "type": "string", - "description": "Knowledge base ID", - "name": "kb_id", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "Filter by page type", - "name": "page_type", - "in": "query" - }, - { - "type": "string", - "description": "Filter by status", - "name": "status", - "in": "query" - }, - { - "type": "string", - "description": "Full-text search", - "name": "query", - "in": "query" - }, - { - "type": "integer", - "description": "Page number", - "name": "page", - "in": "query" - }, - { - "type": "integer", - "description": "Page size", - "name": "page_size", - "in": "query" - }, - { - "type": "string", - "description": "Sort field", - "name": "sort_by", - "in": "query" - }, - { - "type": "string", - "description": "Sort order (asc/desc)", - "name": "sort_order", - "in": "query" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPageListResponse" - } - }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError" - } - } - } - }, - "post": { - "security": [ - { - "Bearer": [] - } - ], - "description": "Create a new wiki page in the knowledge base", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "Wiki" - ], - "summary": "Create a wiki page", - "parameters": [ - { - "type": "string", - "description": "Knowledge base ID", - "name": "kb_id", - "in": "path", - "required": true - }, - { - "description": "Wiki page data", - "name": "page", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPage" - } - } - ], - "responses": { - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPage" - } - }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError" - } - } - } - } - }, - "/api/v1/knowledgebase/{kb_id}/wiki/pages/{slug}": { - "get": { - "security": [ - { - "Bearer": [] - } - ], - "description": "Retrieve a wiki page by its slug", - "produces": [ - "application/json" - ], - "tags": [ - "Wiki" - ], - "summary": "Get a wiki page by slug", - "parameters": [ - { - "type": "string", - "description": "Knowledge base ID", - "name": "kb_id", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "Page slug", - "name": "slug", - "in": "path", - "required": true - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPage" - } - }, - "404": { - "description": "Not Found", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError" - } - } - } - }, - "put": { - "security": [ - { - "Bearer": [] - } - ], - "description": "Update an existing wiki page by slug", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "Wiki" - ], - "summary": "Update a wiki page", - "parameters": [ - { - "type": "string", - "description": "Knowledge base ID", - "name": "kb_id", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "Page slug", - "name": "slug", - "in": "path", - "required": true - }, - { - "description": "Updated wiki page data", - "name": "page", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPage" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPage" - } - }, - "404": { - "description": "Not Found", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError" - } - } - } - }, - "delete": { - "security": [ - { - "Bearer": [] - } - ], - "description": "Soft-delete a wiki page by slug", - "tags": [ - "Wiki" - ], - "summary": "Delete a wiki page", - "parameters": [ - { - "type": "string", - "description": "Knowledge base ID", - "name": "kb_id", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "Page slug", - "name": "slug", - "in": "path", - "required": true - } - ], - "responses": { - "204": { - "description": "No Content" - }, - "404": { - "description": "Not Found", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError" - } - } - } - } - }, - "/api/v1/knowledgebase/{kb_id}/wiki/rebuild-links": { - "post": { - "security": [ - { - "Bearer": [] - } - ], - "description": "Re-parse all pages and rebuild bidirectional link references", - "tags": [ - "Wiki" - ], - "summary": "Rebuild wiki links", - "parameters": [ - { - "type": "string", - "description": "Knowledge base ID", - "name": "kb_id", - "in": "path", - "required": true - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - } - }, - "/api/v1/knowledgebase/{kb_id}/wiki/search": { - "get": { - "security": [ - { - "Bearer": [] - } - ], - "description": "Full-text search over wiki pages", - "produces": [ - "application/json" - ], - "tags": [ - "Wiki" - ], - "summary": "Search wiki pages", - "parameters": [ - { - "type": "string", - "description": "Knowledge base ID", - "name": "kb_id", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "Search query", - "name": "q", - "in": "query", - "required": true - }, - { - "type": "integer", - "description": "Max results (default 10)", - "name": "limit", - "in": "query" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPage" - } - } - } - } - } - }, - "/api/v1/knowledgebase/{kb_id}/wiki/stats": { - "get": { - "security": [ - { - "Bearer": [] - } - ], - "description": "Returns aggregate statistics about the wiki", - "produces": [ - "application/json" - ], - "tags": [ - "Wiki" - ], - "summary": "Get wiki statistics", - "parameters": [ - { - "type": "string", - "description": "Knowledge base ID", - "name": "kb_id", - "in": "path", - "required": true - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiStats" - } - } - } - } - }, "/auth/auto-setup": { "post": { "description": "Lite 版专用:首次启动时自动创建默认用户和租户并返回令牌,后续启动直接签发令牌,免除手动注册/登录流程", @@ -2830,6 +1547,554 @@ } } }, + "/datasource": { + "get": { + "description": "List all data sources for a specific knowledge base", + "produces": [ + "application/json" + ], + "tags": [ + "DataSource" + ], + "summary": "List data sources for a knowledge base", + "parameters": [ + { + "type": "string", + "description": "Knowledge base ID", + "name": "kb_id", + "in": "query", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.DataSource" + } + } + }, + "400": { + "description": "Bad Request", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "post": { + "description": "Create a new data source configuration for a knowledge base", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "DataSource" + ], + "summary": "Create a new data source", + "parameters": [ + { + "description": "Data source configuration", + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.DataSource" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.DataSource" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + } + }, + "/datasource/logs/{log_id}": { + "get": { + "description": "Retrieve a specific sync log entry", + "produces": [ + "application/json" + ], + "tags": [ + "DataSource" + ], + "summary": "Get specific sync log", + "parameters": [ + { + "type": "string", + "description": "Sync log ID", + "name": "log_id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.SyncLog" + } + }, + "404": { + "description": "Not Found", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + } + }, + "/datasource/types": { + "get": { + "description": "Get list of available data source connectors", + "produces": [ + "application/json" + ], + "tags": [ + "DataSource" + ], + "summary": "Get available connectors", + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_datasource.ConnectorMetadata" + } + } + } + } + } + }, + "/datasource/validate-credentials": { + "post": { + "description": "Validate connectivity to an external data source using type + credentials", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "DataSource" + ], + "summary": "Test connection with raw credentials (no persistence)", + "parameters": [ + { + "description": "type and credentials", + "name": "request", + "in": "body", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "400": { + "description": "Bad Request", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + } + }, + "/datasource/{id}": { + "get": { + "description": "Retrieve a data source configuration by ID", + "produces": [ + "application/json" + ], + "tags": [ + "DataSource" + ], + "summary": "Get a data source by ID", + "parameters": [ + { + "type": "string", + "description": "Data source ID", + "name": "id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.DataSource" + } + }, + "404": { + "description": "Not Found", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "put": { + "description": "Update an existing data source configuration", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "DataSource" + ], + "summary": "Update a data source", + "parameters": [ + { + "type": "string", + "description": "Data source ID", + "name": "id", + "in": "path", + "required": true + }, + { + "description": "Updated configuration", + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.DataSource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.DataSource" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "delete": { + "description": "Delete a data source (soft delete)", + "tags": [ + "DataSource" + ], + "summary": "Delete a data source", + "parameters": [ + { + "type": "string", + "description": "Data source ID", + "name": "id", + "in": "path", + "required": true + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "404": { + "description": "Not Found", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + } + }, + "/datasource/{id}/logs": { + "get": { + "description": "Retrieve sync history for a data source", + "produces": [ + "application/json" + ], + "tags": [ + "DataSource" + ], + "summary": "Get sync logs", + "parameters": [ + { + "type": "string", + "description": "Data source ID", + "name": "id", + "in": "path", + "required": true + }, + { + "type": "integer", + "description": "Limit (default: 10)", + "name": "limit", + "in": "query" + }, + { + "type": "integer", + "description": "Offset (default: 0)", + "name": "offset", + "in": "query" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.SyncLog" + } + } + }, + "400": { + "description": "Bad Request", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + } + }, + "/datasource/{id}/pause": { + "post": { + "description": "Pause a data source's scheduled syncs", + "tags": [ + "DataSource" + ], + "summary": "Pause data source", + "parameters": [ + { + "type": "string", + "description": "Data source ID", + "name": "id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "400": { + "description": "Bad Request", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + } + }, + "/datasource/{id}/resources": { + "get": { + "description": "List resources available for sync in the external system", + "produces": [ + "application/json" + ], + "tags": [ + "DataSource" + ], + "summary": "List available resources in data source", + "parameters": [ + { + "type": "string", + "description": "Data source ID", + "name": "id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.Resource" + } + } + }, + "400": { + "description": "Bad Request", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + } + }, + "/datasource/{id}/resume": { + "post": { + "description": "Resume a paused data source", + "tags": [ + "DataSource" + ], + "summary": "Resume data source", + "parameters": [ + { + "type": "string", + "description": "Data source ID", + "name": "id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "400": { + "description": "Bad Request", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + } + }, + "/datasource/{id}/sync": { + "post": { + "description": "Trigger an immediate sync for a data source", + "tags": [ + "DataSource" + ], + "summary": "Trigger immediate sync", + "parameters": [ + { + "type": "string", + "description": "Data source ID", + "name": "id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.SyncLog" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + } + }, + "/datasource/{id}/validate": { + "post": { + "description": "Validate the connection to an external data source", + "tags": [ + "DataSource" + ], + "summary": "Test data source connection", + "parameters": [ + { + "type": "string", + "description": "Data source ID", + "name": "id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "400": { + "description": "Bad Request", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + } + }, "/evaluation/": { "get": { "security": [ @@ -6839,6 +6104,741 @@ } } }, + "/knowledgebase/{kb_id}/wiki/auto-fix": { + "post": { + "security": [ + { + "Bearer": [] + } + ], + "description": "Automatically fix fixable wiki issues (broken links, etc.)", + "produces": [ + "application/json" + ], + "tags": [ + "Wiki" + ], + "summary": "Auto-fix wiki issues", + "parameters": [ + { + "type": "string", + "description": "Knowledge base ID", + "name": "kb_id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "additionalProperties": true + } + } + } + } + }, + "/knowledgebase/{kb_id}/wiki/graph": { + "get": { + "security": [ + { + "Bearer": [] + } + ], + "description": "Returns a slice of the wiki link graph for visualization. Supports\n`mode=overview` (top-N most-connected pages, default) and\n`mode=ego` (BFS neighborhood of a center slug) to keep response\nsize tractable for knowledge bases with tens of thousands of pages.", + "produces": [ + "application/json" + ], + "tags": [ + "Wiki" + ], + "summary": "Get wiki link graph", + "parameters": [ + { + "type": "string", + "description": "Knowledge base ID", + "name": "kb_id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "overview (default) | ego", + "name": "mode", + "in": "query" + }, + { + "type": "string", + "description": "Center slug for ego mode", + "name": "center", + "in": "query" + }, + { + "type": "integer", + "description": "Ego BFS depth (1-3, default 1)", + "name": "depth", + "in": "query" + }, + { + "type": "string", + "description": "Comma-separated page_type allow-list", + "name": "types", + "in": "query" + }, + { + "type": "integer", + "description": "Max nodes to return (default 500, max 2000)", + "name": "limit", + "in": "query" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiGraphData" + } + } + } + } + }, + "/knowledgebase/{kb_id}/wiki/index": { + "get": { + "security": [ + { + "Bearer": [] + } + ], + "description": "Returns the wiki index as intro text plus per-type paginated\ndirectory groups. The heavy directory markdown that used to\nlive in wiki_pages.content was replaced with this structured\nresponse so a KB with tens of thousands of pages no longer\nmaterializes megabytes of TEXT on every index open.", + "produces": [ + "application/json" + ], + "tags": [ + "Wiki" + ], + "summary": "Get wiki index view", + "parameters": [ + { + "type": "string", + "description": "Knowledge base ID", + "name": "kb_id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "Comma-separated page types (default: all content types)", + "name": "types", + "in": "query" + }, + { + "type": "integer", + "description": "Per-group window size, 1-200 (default 50)", + "name": "limit", + "in": "query" + }, + { + "type": "string", + "description": "Opaque offset cursor from previous response", + "name": "cursor", + "in": "query" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiIndexResponse" + } + } + } + } + }, + "/knowledgebase/{kb_id}/wiki/issues": { + "get": { + "security": [ + { + "Bearer": [] + } + ], + "description": "List issues flagged on wiki pages with optional filtering", + "produces": [ + "application/json" + ], + "tags": [ + "Wiki" + ], + "summary": "List wiki page issues", + "parameters": [ + { + "type": "string", + "description": "Knowledge base ID", + "name": "kb_id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "Filter by page slug", + "name": "slug", + "in": "query" + }, + { + "type": "string", + "description": "Filter by status (pending, ignored, resolved)", + "name": "status", + "in": "query" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPageIssue" + } + } + } + } + } + }, + "/knowledgebase/{kb_id}/wiki/issues/{issue_id}/status": { + "put": { + "security": [ + { + "Bearer": [] + } + ], + "description": "Update the status of a flagged wiki page issue", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "Wiki" + ], + "summary": "Update wiki page issue status", + "parameters": [ + { + "type": "string", + "description": "Knowledge base ID", + "name": "kb_id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "Issue ID", + "name": "issue_id", + "in": "path", + "required": true + }, + { + "description": "New status {'status': 'ignored'}", + "name": "status", + "in": "body", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError" + } + } + } + } + }, + "/knowledgebase/{kb_id}/wiki/lint": { + "get": { + "security": [ + { + "Bearer": [] + } + ], + "description": "Perform a comprehensive health check on the wiki", + "produces": [ + "application/json" + ], + "tags": [ + "Wiki" + ], + "summary": "Run wiki lint", + "parameters": [ + { + "type": "string", + "description": "Knowledge base ID", + "name": "kb_id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_application_service.WikiLintReport" + } + } + } + } + }, + "/knowledgebase/{kb_id}/wiki/log": { + "get": { + "security": [ + { + "Bearer": [] + } + ], + "description": "Returns a paginated feed of wiki operation events (ingest, retract, ...)\nnewest-first. Pagination is cursor-based: pass `next_cursor` from the\nprevious response back as `cursor` to fetch the next page.", + "produces": [ + "application/json" + ], + "tags": [ + "Wiki" + ], + "summary": "Get wiki operation log", + "parameters": [ + { + "type": "string", + "description": "Knowledge base ID", + "name": "kb_id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "Opaque cursor from the previous page (empty = newest)", + "name": "cursor", + "in": "query" + }, + { + "type": "integer", + "description": "Page size, 1-200 (default 50)", + "name": "limit", + "in": "query" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiLogEntryListResponse" + } + } + } + } + }, + "/knowledgebase/{kb_id}/wiki/pages": { + "get": { + "security": [ + { + "Bearer": [] + } + ], + "description": "List wiki pages with optional filtering and pagination", + "produces": [ + "application/json" + ], + "tags": [ + "Wiki" + ], + "summary": "List wiki pages", + "parameters": [ + { + "type": "string", + "description": "Knowledge base ID", + "name": "kb_id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "Filter by page type", + "name": "page_type", + "in": "query" + }, + { + "type": "string", + "description": "Filter by status", + "name": "status", + "in": "query" + }, + { + "type": "string", + "description": "Full-text search", + "name": "query", + "in": "query" + }, + { + "type": "integer", + "description": "Page number", + "name": "page", + "in": "query" + }, + { + "type": "integer", + "description": "Page size", + "name": "page_size", + "in": "query" + }, + { + "type": "string", + "description": "Sort field", + "name": "sort_by", + "in": "query" + }, + { + "type": "string", + "description": "Sort order (asc/desc)", + "name": "sort_order", + "in": "query" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPageListResponse" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError" + } + } + } + }, + "post": { + "security": [ + { + "Bearer": [] + } + ], + "description": "Create a new wiki page in the knowledge base", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "Wiki" + ], + "summary": "Create a wiki page", + "parameters": [ + { + "type": "string", + "description": "Knowledge base ID", + "name": "kb_id", + "in": "path", + "required": true + }, + { + "description": "Wiki page data", + "name": "page", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPage" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPage" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError" + } + } + } + } + }, + "/knowledgebase/{kb_id}/wiki/pages/{slug}": { + "get": { + "security": [ + { + "Bearer": [] + } + ], + "description": "Retrieve a wiki page by its slug", + "produces": [ + "application/json" + ], + "tags": [ + "Wiki" + ], + "summary": "Get a wiki page by slug", + "parameters": [ + { + "type": "string", + "description": "Knowledge base ID", + "name": "kb_id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "Page slug", + "name": "slug", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPage" + } + }, + "404": { + "description": "Not Found", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError" + } + } + } + }, + "put": { + "security": [ + { + "Bearer": [] + } + ], + "description": "Update an existing wiki page by slug", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "tags": [ + "Wiki" + ], + "summary": "Update a wiki page", + "parameters": [ + { + "type": "string", + "description": "Knowledge base ID", + "name": "kb_id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "Page slug", + "name": "slug", + "in": "path", + "required": true + }, + { + "description": "Updated wiki page data", + "name": "page", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPage" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPage" + } + }, + "404": { + "description": "Not Found", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError" + } + } + } + }, + "delete": { + "security": [ + { + "Bearer": [] + } + ], + "description": "Soft-delete a wiki page by slug", + "tags": [ + "Wiki" + ], + "summary": "Delete a wiki page", + "parameters": [ + { + "type": "string", + "description": "Knowledge base ID", + "name": "kb_id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "Page slug", + "name": "slug", + "in": "path", + "required": true + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "404": { + "description": "Not Found", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError" + } + } + } + } + }, + "/knowledgebase/{kb_id}/wiki/rebuild-links": { + "post": { + "security": [ + { + "Bearer": [] + } + ], + "description": "Re-parse all pages and rebuild bidirectional link references", + "tags": [ + "Wiki" + ], + "summary": "Rebuild wiki links", + "parameters": [ + { + "type": "string", + "description": "Knowledge base ID", + "name": "kb_id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + } + }, + "/knowledgebase/{kb_id}/wiki/search": { + "get": { + "security": [ + { + "Bearer": [] + } + ], + "description": "Full-text search over wiki pages", + "produces": [ + "application/json" + ], + "tags": [ + "Wiki" + ], + "summary": "Search wiki pages", + "parameters": [ + { + "type": "string", + "description": "Knowledge base ID", + "name": "kb_id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "Search query", + "name": "q", + "in": "query", + "required": true + }, + { + "type": "integer", + "description": "Max results (default 10)", + "name": "limit", + "in": "query" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPage" + } + } + } + } + } + }, + "/knowledgebase/{kb_id}/wiki/stats": { + "get": { + "security": [ + { + "Bearer": [] + } + ], + "description": "Returns aggregate statistics about the wiki", + "produces": [ + "application/json" + ], + "tags": [ + "Wiki" + ], + "summary": "Get wiki statistics", + "parameters": [ + { + "type": "string", + "description": "Knowledge base ID", + "name": "kb_id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/github_com_Tencent_WeKnora_internal_types.WikiStats" + } + } + } + } + }, "/mcp-services": { "get": { "security": [ diff --git a/docs/swagger.yaml b/docs/swagger.yaml index f2415fd3..a7c6cb08 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml @@ -4854,847 +4854,6 @@ paths: summary: 获取智能体类型预设列表 tags: - 智能体 - /api/v1/datasource: - get: - description: List all data sources for a specific knowledge base - parameters: - - description: Knowledge base ID - in: query - name: kb_id - required: true - type: string - produces: - - application/json - responses: - "200": - description: OK - schema: - items: - $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.DataSource' - type: array - "400": - description: Bad Request - schema: - additionalProperties: - type: string - type: object - summary: List data sources for a knowledge base - tags: - - DataSource - post: - consumes: - - application/json - description: Create a new data source configuration for a knowledge base - parameters: - - description: Data source configuration - in: body - name: request - required: true - schema: - $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.DataSource' - produces: - - application/json - responses: - "201": - description: Created - schema: - $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.DataSource' - "400": - description: Bad Request - schema: - additionalProperties: - type: string - type: object - summary: Create a new data source - tags: - - DataSource - /api/v1/datasource/{id}: - delete: - description: Delete a data source (soft delete) - parameters: - - description: Data source ID - in: path - name: id - required: true - type: string - responses: - "204": - description: No Content - "404": - description: Not Found - schema: - additionalProperties: - type: string - type: object - summary: Delete a data source - tags: - - DataSource - get: - description: Retrieve a data source configuration by ID - parameters: - - description: Data source ID - in: path - name: id - required: true - type: string - produces: - - application/json - responses: - "200": - description: OK - schema: - $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.DataSource' - "404": - description: Not Found - schema: - additionalProperties: - type: string - type: object - summary: Get a data source by ID - tags: - - DataSource - put: - consumes: - - application/json - description: Update an existing data source configuration - parameters: - - description: Data source ID - in: path - name: id - required: true - type: string - - description: Updated configuration - in: body - name: request - required: true - schema: - $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.DataSource' - produces: - - application/json - responses: - "200": - description: OK - schema: - $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.DataSource' - "400": - description: Bad Request - schema: - additionalProperties: - type: string - type: object - summary: Update a data source - tags: - - DataSource - /api/v1/datasource/{id}/logs: - get: - description: Retrieve sync history for a data source - parameters: - - description: Data source ID - in: path - name: id - required: true - type: string - - description: 'Limit (default: 10)' - in: query - name: limit - type: integer - - description: 'Offset (default: 0)' - in: query - name: offset - type: integer - produces: - - application/json - responses: - "200": - description: OK - schema: - items: - $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.SyncLog' - type: array - "400": - description: Bad Request - schema: - additionalProperties: - type: string - type: object - summary: Get sync logs - tags: - - DataSource - /api/v1/datasource/{id}/pause: - post: - description: Pause a data source's scheduled syncs - parameters: - - description: Data source ID - in: path - name: id - required: true - type: string - responses: - "200": - description: OK - schema: - additionalProperties: - type: string - type: object - "400": - description: Bad Request - schema: - additionalProperties: - type: string - type: object - summary: Pause data source - tags: - - DataSource - /api/v1/datasource/{id}/resources: - get: - description: List resources available for sync in the external system - parameters: - - description: Data source ID - in: path - name: id - required: true - type: string - produces: - - application/json - responses: - "200": - description: OK - schema: - items: - $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.Resource' - type: array - "400": - description: Bad Request - schema: - additionalProperties: - type: string - type: object - summary: List available resources in data source - tags: - - DataSource - /api/v1/datasource/{id}/resume: - post: - description: Resume a paused data source - parameters: - - description: Data source ID - in: path - name: id - required: true - type: string - responses: - "200": - description: OK - schema: - additionalProperties: - type: string - type: object - "400": - description: Bad Request - schema: - additionalProperties: - type: string - type: object - summary: Resume data source - tags: - - DataSource - /api/v1/datasource/{id}/sync: - post: - description: Trigger an immediate sync for a data source - parameters: - - description: Data source ID - in: path - name: id - required: true - type: string - responses: - "200": - description: OK - schema: - $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.SyncLog' - "400": - description: Bad Request - schema: - additionalProperties: - type: string - type: object - summary: Trigger immediate sync - tags: - - DataSource - /api/v1/datasource/{id}/validate: - post: - description: Validate the connection to an external data source - parameters: - - description: Data source ID - in: path - name: id - required: true - type: string - responses: - "200": - description: OK - schema: - additionalProperties: - type: string - type: object - "400": - description: Bad Request - schema: - additionalProperties: - type: string - type: object - summary: Test data source connection - tags: - - DataSource - /api/v1/datasource/logs/{log_id}: - get: - description: Retrieve a specific sync log entry - parameters: - - description: Sync log ID - in: path - name: log_id - required: true - type: string - produces: - - application/json - responses: - "200": - description: OK - schema: - $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.SyncLog' - "404": - description: Not Found - schema: - additionalProperties: - type: string - type: object - summary: Get specific sync log - tags: - - DataSource - /api/v1/datasource/types: - get: - description: Get list of available data source connectors - produces: - - application/json - responses: - "200": - description: OK - schema: - items: - $ref: '#/definitions/github_com_Tencent_WeKnora_internal_datasource.ConnectorMetadata' - type: array - summary: Get available connectors - tags: - - DataSource - /api/v1/datasource/validate-credentials: - post: - consumes: - - application/json - description: Validate connectivity to an external data source using type + credentials - parameters: - - description: type and credentials - in: body - name: request - required: true - schema: - type: object - produces: - - application/json - responses: - "200": - description: OK - schema: - additionalProperties: - type: string - type: object - "400": - description: Bad Request - schema: - additionalProperties: - type: string - type: object - summary: Test connection with raw credentials (no persistence) - tags: - - DataSource - /api/v1/knowledgebase/{kb_id}/wiki/auto-fix: - post: - description: Automatically fix fixable wiki issues (broken links, etc.) - parameters: - - description: Knowledge base ID - in: path - name: kb_id - required: true - type: string - produces: - - application/json - responses: - "200": - description: OK - schema: - additionalProperties: true - type: object - security: - - Bearer: [] - summary: Auto-fix wiki issues - tags: - - Wiki - /api/v1/knowledgebase/{kb_id}/wiki/graph: - get: - description: |- - Returns a slice of the wiki link graph for visualization. Supports - `mode=overview` (top-N most-connected pages, default) and - `mode=ego` (BFS neighborhood of a center slug) to keep response - size tractable for knowledge bases with tens of thousands of pages. - parameters: - - description: Knowledge base ID - in: path - name: kb_id - required: true - type: string - - description: overview (default) | ego - in: query - name: mode - type: string - - description: Center slug for ego mode - in: query - name: center - type: string - - description: Ego BFS depth (1-3, default 1) - in: query - name: depth - type: integer - - description: Comma-separated page_type allow-list - in: query - name: types - type: string - - description: Max nodes to return (default 500, max 2000) - in: query - name: limit - type: integer - produces: - - application/json - responses: - "200": - description: OK - schema: - $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.WikiGraphData' - security: - - Bearer: [] - summary: Get wiki link graph - tags: - - Wiki - /api/v1/knowledgebase/{kb_id}/wiki/index: - get: - description: |- - Returns the wiki index as intro text plus per-type paginated - directory groups. The heavy directory markdown that used to - live in wiki_pages.content was replaced with this structured - response so a KB with tens of thousands of pages no longer - materializes megabytes of TEXT on every index open. - parameters: - - description: Knowledge base ID - in: path - name: kb_id - required: true - type: string - - description: 'Comma-separated page types (default: all content types)' - in: query - name: types - type: string - - description: Per-group window size, 1-200 (default 50) - in: query - name: limit - type: integer - - description: Opaque offset cursor from previous response - in: query - name: cursor - type: string - produces: - - application/json - responses: - "200": - description: OK - schema: - $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.WikiIndexResponse' - security: - - Bearer: [] - summary: Get wiki index view - tags: - - Wiki - /api/v1/knowledgebase/{kb_id}/wiki/issues: - get: - description: List issues flagged on wiki pages with optional filtering - parameters: - - description: Knowledge base ID - in: path - name: kb_id - required: true - type: string - - description: Filter by page slug - in: query - name: slug - type: string - - description: Filter by status (pending, ignored, resolved) - in: query - name: status - type: string - produces: - - application/json - responses: - "200": - description: OK - schema: - items: - $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPageIssue' - type: array - security: - - Bearer: [] - summary: List wiki page issues - tags: - - Wiki - /api/v1/knowledgebase/{kb_id}/wiki/issues/{issue_id}/status: - put: - consumes: - - application/json - description: Update the status of a flagged wiki page issue - parameters: - - description: Knowledge base ID - in: path - name: kb_id - required: true - type: string - - description: Issue ID - in: path - name: issue_id - required: true - type: string - - description: 'New status {''status'': ''ignored''}' - in: body - name: status - required: true - schema: - type: object - produces: - - application/json - responses: - "200": - description: OK - schema: - additionalProperties: - type: string - type: object - "400": - description: Bad Request - schema: - $ref: '#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError' - security: - - Bearer: [] - summary: Update wiki page issue status - tags: - - Wiki - /api/v1/knowledgebase/{kb_id}/wiki/lint: - get: - description: Perform a comprehensive health check on the wiki - parameters: - - description: Knowledge base ID - in: path - name: kb_id - required: true - type: string - produces: - - application/json - responses: - "200": - description: OK - schema: - $ref: '#/definitions/github_com_Tencent_WeKnora_internal_application_service.WikiLintReport' - security: - - Bearer: [] - summary: Run wiki lint - tags: - - Wiki - /api/v1/knowledgebase/{kb_id}/wiki/log: - get: - description: |- - Returns a paginated feed of wiki operation events (ingest, retract, ...) - newest-first. Pagination is cursor-based: pass `next_cursor` from the - previous response back as `cursor` to fetch the next page. - parameters: - - description: Knowledge base ID - in: path - name: kb_id - required: true - type: string - - description: Opaque cursor from the previous page (empty = newest) - in: query - name: cursor - type: string - - description: Page size, 1-200 (default 50) - in: query - name: limit - type: integer - produces: - - application/json - responses: - "200": - description: OK - schema: - $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.WikiLogEntryListResponse' - security: - - Bearer: [] - summary: Get wiki operation log - tags: - - Wiki - /api/v1/knowledgebase/{kb_id}/wiki/pages: - get: - description: List wiki pages with optional filtering and pagination - parameters: - - description: Knowledge base ID - in: path - name: kb_id - required: true - type: string - - description: Filter by page type - in: query - name: page_type - type: string - - description: Filter by status - in: query - name: status - type: string - - description: Full-text search - in: query - name: query - type: string - - description: Page number - in: query - name: page - type: integer - - description: Page size - in: query - name: page_size - type: integer - - description: Sort field - in: query - name: sort_by - type: string - - description: Sort order (asc/desc) - in: query - name: sort_order - type: string - produces: - - application/json - responses: - "200": - description: OK - schema: - $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPageListResponse' - "400": - description: Bad Request - schema: - $ref: '#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError' - security: - - Bearer: [] - summary: List wiki pages - tags: - - Wiki - post: - consumes: - - application/json - description: Create a new wiki page in the knowledge base - parameters: - - description: Knowledge base ID - in: path - name: kb_id - required: true - type: string - - description: Wiki page data - in: body - name: page - required: true - schema: - $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPage' - produces: - - application/json - responses: - "201": - description: Created - schema: - $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPage' - "400": - description: Bad Request - schema: - $ref: '#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError' - security: - - Bearer: [] - summary: Create a wiki page - tags: - - Wiki - /api/v1/knowledgebase/{kb_id}/wiki/pages/{slug}: - delete: - description: Soft-delete a wiki page by slug - parameters: - - description: Knowledge base ID - in: path - name: kb_id - required: true - type: string - - description: Page slug - in: path - name: slug - required: true - type: string - responses: - "204": - description: No Content - "404": - description: Not Found - schema: - $ref: '#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError' - security: - - Bearer: [] - summary: Delete a wiki page - tags: - - Wiki - get: - description: Retrieve a wiki page by its slug - parameters: - - description: Knowledge base ID - in: path - name: kb_id - required: true - type: string - - description: Page slug - in: path - name: slug - required: true - type: string - produces: - - application/json - responses: - "200": - description: OK - schema: - $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPage' - "404": - description: Not Found - schema: - $ref: '#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError' - security: - - Bearer: [] - summary: Get a wiki page by slug - tags: - - Wiki - put: - consumes: - - application/json - description: Update an existing wiki page by slug - parameters: - - description: Knowledge base ID - in: path - name: kb_id - required: true - type: string - - description: Page slug - in: path - name: slug - required: true - type: string - - description: Updated wiki page data - in: body - name: page - required: true - schema: - $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPage' - produces: - - application/json - responses: - "200": - description: OK - schema: - $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPage' - "404": - description: Not Found - schema: - $ref: '#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError' - security: - - Bearer: [] - summary: Update a wiki page - tags: - - Wiki - /api/v1/knowledgebase/{kb_id}/wiki/rebuild-links: - post: - description: Re-parse all pages and rebuild bidirectional link references - parameters: - - description: Knowledge base ID - in: path - name: kb_id - required: true - type: string - responses: - "200": - description: OK - schema: - additionalProperties: - type: string - type: object - security: - - Bearer: [] - summary: Rebuild wiki links - tags: - - Wiki - /api/v1/knowledgebase/{kb_id}/wiki/search: - get: - description: Full-text search over wiki pages - parameters: - - description: Knowledge base ID - in: path - name: kb_id - required: true - type: string - - description: Search query - in: query - name: q - required: true - type: string - - description: Max results (default 10) - in: query - name: limit - type: integer - produces: - - application/json - responses: - "200": - description: OK - schema: - items: - $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPage' - type: array - security: - - Bearer: [] - summary: Search wiki pages - tags: - - Wiki - /api/v1/knowledgebase/{kb_id}/wiki/stats: - get: - description: Returns aggregate statistics about the wiki - parameters: - - description: Knowledge base ID - in: path - name: kb_id - required: true - type: string - produces: - - application/json - responses: - "200": - description: OK - schema: - $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.WikiStats' - security: - - Bearer: [] - summary: Get wiki statistics - tags: - - Wiki /auth/auto-setup: post: consumes: @@ -6321,6 +5480,367 @@ paths: summary: 删除生成的问题 tags: - 分块管理 + /datasource: + get: + description: List all data sources for a specific knowledge base + parameters: + - description: Knowledge base ID + in: query + name: kb_id + required: true + type: string + produces: + - application/json + responses: + "200": + description: OK + schema: + items: + $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.DataSource' + type: array + "400": + description: Bad Request + schema: + additionalProperties: + type: string + type: object + summary: List data sources for a knowledge base + tags: + - DataSource + post: + consumes: + - application/json + description: Create a new data source configuration for a knowledge base + parameters: + - description: Data source configuration + in: body + name: request + required: true + schema: + $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.DataSource' + produces: + - application/json + responses: + "201": + description: Created + schema: + $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.DataSource' + "400": + description: Bad Request + schema: + additionalProperties: + type: string + type: object + summary: Create a new data source + tags: + - DataSource + /datasource/{id}: + delete: + description: Delete a data source (soft delete) + parameters: + - description: Data source ID + in: path + name: id + required: true + type: string + responses: + "204": + description: No Content + "404": + description: Not Found + schema: + additionalProperties: + type: string + type: object + summary: Delete a data source + tags: + - DataSource + get: + description: Retrieve a data source configuration by ID + parameters: + - description: Data source ID + in: path + name: id + required: true + type: string + produces: + - application/json + responses: + "200": + description: OK + schema: + $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.DataSource' + "404": + description: Not Found + schema: + additionalProperties: + type: string + type: object + summary: Get a data source by ID + tags: + - DataSource + put: + consumes: + - application/json + description: Update an existing data source configuration + parameters: + - description: Data source ID + in: path + name: id + required: true + type: string + - description: Updated configuration + in: body + name: request + required: true + schema: + $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.DataSource' + produces: + - application/json + responses: + "200": + description: OK + schema: + $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.DataSource' + "400": + description: Bad Request + schema: + additionalProperties: + type: string + type: object + summary: Update a data source + tags: + - DataSource + /datasource/{id}/logs: + get: + description: Retrieve sync history for a data source + parameters: + - description: Data source ID + in: path + name: id + required: true + type: string + - description: 'Limit (default: 10)' + in: query + name: limit + type: integer + - description: 'Offset (default: 0)' + in: query + name: offset + type: integer + produces: + - application/json + responses: + "200": + description: OK + schema: + items: + $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.SyncLog' + type: array + "400": + description: Bad Request + schema: + additionalProperties: + type: string + type: object + summary: Get sync logs + tags: + - DataSource + /datasource/{id}/pause: + post: + description: Pause a data source's scheduled syncs + parameters: + - description: Data source ID + in: path + name: id + required: true + type: string + responses: + "200": + description: OK + schema: + additionalProperties: + type: string + type: object + "400": + description: Bad Request + schema: + additionalProperties: + type: string + type: object + summary: Pause data source + tags: + - DataSource + /datasource/{id}/resources: + get: + description: List resources available for sync in the external system + parameters: + - description: Data source ID + in: path + name: id + required: true + type: string + produces: + - application/json + responses: + "200": + description: OK + schema: + items: + $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.Resource' + type: array + "400": + description: Bad Request + schema: + additionalProperties: + type: string + type: object + summary: List available resources in data source + tags: + - DataSource + /datasource/{id}/resume: + post: + description: Resume a paused data source + parameters: + - description: Data source ID + in: path + name: id + required: true + type: string + responses: + "200": + description: OK + schema: + additionalProperties: + type: string + type: object + "400": + description: Bad Request + schema: + additionalProperties: + type: string + type: object + summary: Resume data source + tags: + - DataSource + /datasource/{id}/sync: + post: + description: Trigger an immediate sync for a data source + parameters: + - description: Data source ID + in: path + name: id + required: true + type: string + responses: + "200": + description: OK + schema: + $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.SyncLog' + "400": + description: Bad Request + schema: + additionalProperties: + type: string + type: object + summary: Trigger immediate sync + tags: + - DataSource + /datasource/{id}/validate: + post: + description: Validate the connection to an external data source + parameters: + - description: Data source ID + in: path + name: id + required: true + type: string + responses: + "200": + description: OK + schema: + additionalProperties: + type: string + type: object + "400": + description: Bad Request + schema: + additionalProperties: + type: string + type: object + summary: Test data source connection + tags: + - DataSource + /datasource/logs/{log_id}: + get: + description: Retrieve a specific sync log entry + parameters: + - description: Sync log ID + in: path + name: log_id + required: true + type: string + produces: + - application/json + responses: + "200": + description: OK + schema: + $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.SyncLog' + "404": + description: Not Found + schema: + additionalProperties: + type: string + type: object + summary: Get specific sync log + tags: + - DataSource + /datasource/types: + get: + description: Get list of available data source connectors + produces: + - application/json + responses: + "200": + description: OK + schema: + items: + $ref: '#/definitions/github_com_Tencent_WeKnora_internal_datasource.ConnectorMetadata' + type: array + summary: Get available connectors + tags: + - DataSource + /datasource/validate-credentials: + post: + consumes: + - application/json + description: Validate connectivity to an external data source using type + credentials + parameters: + - description: type and credentials + in: body + name: request + required: true + schema: + type: object + produces: + - application/json + responses: + "200": + description: OK + schema: + additionalProperties: + type: string + type: object + "400": + description: Bad Request + schema: + additionalProperties: + type: string + type: object + summary: Test connection with raw credentials (no persistence) + tags: + - DataSource /evaluation/: get: consumes: @@ -8846,6 +8366,486 @@ paths: summary: 批量更新知识标签 tags: - 知识管理 + /knowledgebase/{kb_id}/wiki/auto-fix: + post: + description: Automatically fix fixable wiki issues (broken links, etc.) + parameters: + - description: Knowledge base ID + in: path + name: kb_id + required: true + type: string + produces: + - application/json + responses: + "200": + description: OK + schema: + additionalProperties: true + type: object + security: + - Bearer: [] + summary: Auto-fix wiki issues + tags: + - Wiki + /knowledgebase/{kb_id}/wiki/graph: + get: + description: |- + Returns a slice of the wiki link graph for visualization. Supports + `mode=overview` (top-N most-connected pages, default) and + `mode=ego` (BFS neighborhood of a center slug) to keep response + size tractable for knowledge bases with tens of thousands of pages. + parameters: + - description: Knowledge base ID + in: path + name: kb_id + required: true + type: string + - description: overview (default) | ego + in: query + name: mode + type: string + - description: Center slug for ego mode + in: query + name: center + type: string + - description: Ego BFS depth (1-3, default 1) + in: query + name: depth + type: integer + - description: Comma-separated page_type allow-list + in: query + name: types + type: string + - description: Max nodes to return (default 500, max 2000) + in: query + name: limit + type: integer + produces: + - application/json + responses: + "200": + description: OK + schema: + $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.WikiGraphData' + security: + - Bearer: [] + summary: Get wiki link graph + tags: + - Wiki + /knowledgebase/{kb_id}/wiki/index: + get: + description: |- + Returns the wiki index as intro text plus per-type paginated + directory groups. The heavy directory markdown that used to + live in wiki_pages.content was replaced with this structured + response so a KB with tens of thousands of pages no longer + materializes megabytes of TEXT on every index open. + parameters: + - description: Knowledge base ID + in: path + name: kb_id + required: true + type: string + - description: 'Comma-separated page types (default: all content types)' + in: query + name: types + type: string + - description: Per-group window size, 1-200 (default 50) + in: query + name: limit + type: integer + - description: Opaque offset cursor from previous response + in: query + name: cursor + type: string + produces: + - application/json + responses: + "200": + description: OK + schema: + $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.WikiIndexResponse' + security: + - Bearer: [] + summary: Get wiki index view + tags: + - Wiki + /knowledgebase/{kb_id}/wiki/issues: + get: + description: List issues flagged on wiki pages with optional filtering + parameters: + - description: Knowledge base ID + in: path + name: kb_id + required: true + type: string + - description: Filter by page slug + in: query + name: slug + type: string + - description: Filter by status (pending, ignored, resolved) + in: query + name: status + type: string + produces: + - application/json + responses: + "200": + description: OK + schema: + items: + $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPageIssue' + type: array + security: + - Bearer: [] + summary: List wiki page issues + tags: + - Wiki + /knowledgebase/{kb_id}/wiki/issues/{issue_id}/status: + put: + consumes: + - application/json + description: Update the status of a flagged wiki page issue + parameters: + - description: Knowledge base ID + in: path + name: kb_id + required: true + type: string + - description: Issue ID + in: path + name: issue_id + required: true + type: string + - description: 'New status {''status'': ''ignored''}' + in: body + name: status + required: true + schema: + type: object + produces: + - application/json + responses: + "200": + description: OK + schema: + additionalProperties: + type: string + type: object + "400": + description: Bad Request + schema: + $ref: '#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError' + security: + - Bearer: [] + summary: Update wiki page issue status + tags: + - Wiki + /knowledgebase/{kb_id}/wiki/lint: + get: + description: Perform a comprehensive health check on the wiki + parameters: + - description: Knowledge base ID + in: path + name: kb_id + required: true + type: string + produces: + - application/json + responses: + "200": + description: OK + schema: + $ref: '#/definitions/github_com_Tencent_WeKnora_internal_application_service.WikiLintReport' + security: + - Bearer: [] + summary: Run wiki lint + tags: + - Wiki + /knowledgebase/{kb_id}/wiki/log: + get: + description: |- + Returns a paginated feed of wiki operation events (ingest, retract, ...) + newest-first. Pagination is cursor-based: pass `next_cursor` from the + previous response back as `cursor` to fetch the next page. + parameters: + - description: Knowledge base ID + in: path + name: kb_id + required: true + type: string + - description: Opaque cursor from the previous page (empty = newest) + in: query + name: cursor + type: string + - description: Page size, 1-200 (default 50) + in: query + name: limit + type: integer + produces: + - application/json + responses: + "200": + description: OK + schema: + $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.WikiLogEntryListResponse' + security: + - Bearer: [] + summary: Get wiki operation log + tags: + - Wiki + /knowledgebase/{kb_id}/wiki/pages: + get: + description: List wiki pages with optional filtering and pagination + parameters: + - description: Knowledge base ID + in: path + name: kb_id + required: true + type: string + - description: Filter by page type + in: query + name: page_type + type: string + - description: Filter by status + in: query + name: status + type: string + - description: Full-text search + in: query + name: query + type: string + - description: Page number + in: query + name: page + type: integer + - description: Page size + in: query + name: page_size + type: integer + - description: Sort field + in: query + name: sort_by + type: string + - description: Sort order (asc/desc) + in: query + name: sort_order + type: string + produces: + - application/json + responses: + "200": + description: OK + schema: + $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPageListResponse' + "400": + description: Bad Request + schema: + $ref: '#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError' + security: + - Bearer: [] + summary: List wiki pages + tags: + - Wiki + post: + consumes: + - application/json + description: Create a new wiki page in the knowledge base + parameters: + - description: Knowledge base ID + in: path + name: kb_id + required: true + type: string + - description: Wiki page data + in: body + name: page + required: true + schema: + $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPage' + produces: + - application/json + responses: + "201": + description: Created + schema: + $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPage' + "400": + description: Bad Request + schema: + $ref: '#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError' + security: + - Bearer: [] + summary: Create a wiki page + tags: + - Wiki + /knowledgebase/{kb_id}/wiki/pages/{slug}: + delete: + description: Soft-delete a wiki page by slug + parameters: + - description: Knowledge base ID + in: path + name: kb_id + required: true + type: string + - description: Page slug + in: path + name: slug + required: true + type: string + responses: + "204": + description: No Content + "404": + description: Not Found + schema: + $ref: '#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError' + security: + - Bearer: [] + summary: Delete a wiki page + tags: + - Wiki + get: + description: Retrieve a wiki page by its slug + parameters: + - description: Knowledge base ID + in: path + name: kb_id + required: true + type: string + - description: Page slug + in: path + name: slug + required: true + type: string + produces: + - application/json + responses: + "200": + description: OK + schema: + $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPage' + "404": + description: Not Found + schema: + $ref: '#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError' + security: + - Bearer: [] + summary: Get a wiki page by slug + tags: + - Wiki + put: + consumes: + - application/json + description: Update an existing wiki page by slug + parameters: + - description: Knowledge base ID + in: path + name: kb_id + required: true + type: string + - description: Page slug + in: path + name: slug + required: true + type: string + - description: Updated wiki page data + in: body + name: page + required: true + schema: + $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPage' + produces: + - application/json + responses: + "200": + description: OK + schema: + $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPage' + "404": + description: Not Found + schema: + $ref: '#/definitions/github_com_Tencent_WeKnora_internal_errors.AppError' + security: + - Bearer: [] + summary: Update a wiki page + tags: + - Wiki + /knowledgebase/{kb_id}/wiki/rebuild-links: + post: + description: Re-parse all pages and rebuild bidirectional link references + parameters: + - description: Knowledge base ID + in: path + name: kb_id + required: true + type: string + responses: + "200": + description: OK + schema: + additionalProperties: + type: string + type: object + security: + - Bearer: [] + summary: Rebuild wiki links + tags: + - Wiki + /knowledgebase/{kb_id}/wiki/search: + get: + description: Full-text search over wiki pages + parameters: + - description: Knowledge base ID + in: path + name: kb_id + required: true + type: string + - description: Search query + in: query + name: q + required: true + type: string + - description: Max results (default 10) + in: query + name: limit + type: integer + produces: + - application/json + responses: + "200": + description: OK + schema: + items: + $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.WikiPage' + type: array + security: + - Bearer: [] + summary: Search wiki pages + tags: + - Wiki + /knowledgebase/{kb_id}/wiki/stats: + get: + description: Returns aggregate statistics about the wiki + parameters: + - description: Knowledge base ID + in: path + name: kb_id + required: true + type: string + produces: + - application/json + responses: + "200": + description: OK + schema: + $ref: '#/definitions/github_com_Tencent_WeKnora_internal_types.WikiStats' + security: + - Bearer: [] + summary: Get wiki statistics + tags: + - Wiki /mcp-services: get: consumes: diff --git a/internal/handler/datasource.go b/internal/handler/datasource.go index 42915c03..e9d684bb 100644 --- a/internal/handler/datasource.go +++ b/internal/handler/datasource.go @@ -84,7 +84,7 @@ func (h *DataSourceHandler) getOwnedDataSource( // @Param request body types.DataSource true "Data source configuration" // @Success 201 {object} types.DataSource // @Failure 400 {object} map[string]string -// @Router /api/v1/datasource [post] +// @Router /datasource [post] func (h *DataSourceHandler) CreateDataSource(c *gin.Context) { ctx := c.Request.Context() @@ -126,7 +126,7 @@ func (h *DataSourceHandler) CreateDataSource(c *gin.Context) { // @Param id path string true "Data source ID" // @Success 200 {object} types.DataSource // @Failure 404 {object} map[string]string -// @Router /api/v1/datasource/{id} [get] +// @Router /datasource/{id} [get] func (h *DataSourceHandler) GetDataSource(c *gin.Context) { ctx := c.Request.Context() tenantID := h.getTenantID(c) @@ -154,7 +154,7 @@ func (h *DataSourceHandler) GetDataSource(c *gin.Context) { // @Param kb_id query string true "Knowledge base ID" // @Success 200 {object} []types.DataSource // @Failure 400 {object} map[string]string -// @Router /api/v1/datasource [get] +// @Router /datasource [get] func (h *DataSourceHandler) ListDataSources(c *gin.Context) { ctx := c.Request.Context() @@ -193,7 +193,7 @@ func (h *DataSourceHandler) ListDataSources(c *gin.Context) { // @Param request body types.DataSource true "Updated configuration" // @Success 200 {object} types.DataSource // @Failure 400 {object} map[string]string -// @Router /api/v1/datasource/{id} [put] +// @Router /datasource/{id} [put] func (h *DataSourceHandler) UpdateDataSource(c *gin.Context) { ctx := c.Request.Context() tenantID := h.getTenantID(c) @@ -235,7 +235,7 @@ func (h *DataSourceHandler) UpdateDataSource(c *gin.Context) { // @Param id path string true "Data source ID" // @Success 204 // @Failure 404 {object} map[string]string -// @Router /api/v1/datasource/{id} [delete] +// @Router /datasource/{id} [delete] func (h *DataSourceHandler) DeleteDataSource(c *gin.Context) { ctx := c.Request.Context() tenantID := h.getTenantID(c) @@ -266,7 +266,7 @@ func (h *DataSourceHandler) DeleteDataSource(c *gin.Context) { // @Param id path string true "Data source ID" // @Success 200 {object} map[string]string // @Failure 400 {object} map[string]string -// @Router /api/v1/datasource/{id}/validate [post] +// @Router /datasource/{id}/validate [post] func (h *DataSourceHandler) ValidateConnection(c *gin.Context) { ctx := c.Request.Context() tenantID := h.getTenantID(c) @@ -303,7 +303,7 @@ func (h *DataSourceHandler) ValidateConnection(c *gin.Context) { // @Param request body object true "type and credentials" // @Success 200 {object} map[string]string // @Failure 400 {object} map[string]string -// @Router /api/v1/datasource/validate-credentials [post] +// @Router /datasource/validate-credentials [post] func (h *DataSourceHandler) ValidateCredentials(c *gin.Context) { ctx := c.Request.Context() tenantID := h.getTenantID(c) @@ -336,7 +336,7 @@ func (h *DataSourceHandler) ValidateCredentials(c *gin.Context) { // @Param id path string true "Data source ID" // @Success 200 {object} []types.Resource // @Failure 400 {object} map[string]string -// @Router /api/v1/datasource/{id}/resources [get] +// @Router /datasource/{id}/resources [get] func (h *DataSourceHandler) ListAvailableResources(c *gin.Context) { ctx := c.Request.Context() tenantID := h.getTenantID(c) @@ -371,7 +371,7 @@ func (h *DataSourceHandler) ListAvailableResources(c *gin.Context) { // @Param id path string true "Data source ID" // @Success 200 {object} types.SyncLog // @Failure 400 {object} map[string]string -// @Router /api/v1/datasource/{id}/sync [post] +// @Router /datasource/{id}/sync [post] func (h *DataSourceHandler) ManualSync(c *gin.Context) { ctx := c.Request.Context() tenantID := h.getTenantID(c) @@ -403,7 +403,7 @@ func (h *DataSourceHandler) ManualSync(c *gin.Context) { // @Param id path string true "Data source ID" // @Success 200 {object} map[string]string // @Failure 400 {object} map[string]string -// @Router /api/v1/datasource/{id}/pause [post] +// @Router /datasource/{id}/pause [post] func (h *DataSourceHandler) PauseDataSource(c *gin.Context) { ctx := c.Request.Context() tenantID := h.getTenantID(c) @@ -434,7 +434,7 @@ func (h *DataSourceHandler) PauseDataSource(c *gin.Context) { // @Param id path string true "Data source ID" // @Success 200 {object} map[string]string // @Failure 400 {object} map[string]string -// @Router /api/v1/datasource/{id}/resume [post] +// @Router /datasource/{id}/resume [post] func (h *DataSourceHandler) ResumeDataSource(c *gin.Context) { ctx := c.Request.Context() tenantID := h.getTenantID(c) @@ -468,7 +468,7 @@ func (h *DataSourceHandler) ResumeDataSource(c *gin.Context) { // @Param offset query int false "Offset (default: 0)" // @Success 200 {object} []types.SyncLog // @Failure 400 {object} map[string]string -// @Router /api/v1/datasource/{id}/logs [get] +// @Router /datasource/{id}/logs [get] func (h *DataSourceHandler) GetSyncLogs(c *gin.Context) { ctx := c.Request.Context() tenantID := h.getTenantID(c) @@ -519,7 +519,7 @@ func (h *DataSourceHandler) GetSyncLogs(c *gin.Context) { // @Param log_id path string true "Sync log ID" // @Success 200 {object} types.SyncLog // @Failure 404 {object} map[string]string -// @Router /api/v1/datasource/logs/{log_id} [get] +// @Router /datasource/logs/{log_id} [get] func (h *DataSourceHandler) GetSyncLog(c *gin.Context) { ctx := c.Request.Context() tenantID := h.getTenantID(c) @@ -550,7 +550,7 @@ func (h *DataSourceHandler) GetSyncLog(c *gin.Context) { // @Tags DataSource // @Produce json // @Success 200 {object} []datasource.ConnectorMetadata -// @Router /api/v1/datasource/types [get] +// @Router /datasource/types [get] func (h *DataSourceHandler) GetAvailableConnectors(c *gin.Context) { connectors := datasource.ListAvailableConnectors() c.JSON(http.StatusOK, connectors) diff --git a/internal/handler/wiki_page.go b/internal/handler/wiki_page.go index 4a354c3b..3b626aef 100644 --- a/internal/handler/wiki_page.go +++ b/internal/handler/wiki_page.go @@ -87,7 +87,7 @@ func getSlugParam(c *gin.Context) string { // @Success 200 {object} types.WikiPageListResponse // @Failure 400 {object} errors.AppError // @Security Bearer -// @Router /api/v1/knowledgebase/{kb_id}/wiki/pages [get] +// @Router /knowledgebase/{kb_id}/wiki/pages [get] func (h *WikiPageHandler) ListPages(c *gin.Context) { kbID, _, err := h.validateWikiKB(c) if err != nil { @@ -129,7 +129,7 @@ func (h *WikiPageHandler) ListPages(c *gin.Context) { // @Success 201 {object} types.WikiPage // @Failure 400 {object} errors.AppError // @Security Bearer -// @Router /api/v1/knowledgebase/{kb_id}/wiki/pages [post] +// @Router /knowledgebase/{kb_id}/wiki/pages [post] func (h *WikiPageHandler) CreatePage(c *gin.Context) { kbID, tenantID, err := h.validateWikiKB(c) if err != nil { @@ -165,7 +165,7 @@ func (h *WikiPageHandler) CreatePage(c *gin.Context) { // @Success 200 {object} types.WikiPage // @Failure 404 {object} errors.AppError // @Security Bearer -// @Router /api/v1/knowledgebase/{kb_id}/wiki/pages/{slug} [get] +// @Router /knowledgebase/{kb_id}/wiki/pages/{slug} [get] func (h *WikiPageHandler) GetPage(c *gin.Context) { kbID, _, err := h.validateWikiKB(c) if err != nil { @@ -204,7 +204,7 @@ func (h *WikiPageHandler) GetPage(c *gin.Context) { // @Success 200 {object} types.WikiPage // @Failure 404 {object} errors.AppError // @Security Bearer -// @Router /api/v1/knowledgebase/{kb_id}/wiki/pages/{slug} [put] +// @Router /knowledgebase/{kb_id}/wiki/pages/{slug} [put] func (h *WikiPageHandler) UpdatePage(c *gin.Context) { kbID, tenantID, err := h.validateWikiKB(c) if err != nil { @@ -250,7 +250,7 @@ func (h *WikiPageHandler) UpdatePage(c *gin.Context) { // @Success 204 // @Failure 404 {object} errors.AppError // @Security Bearer -// @Router /api/v1/knowledgebase/{kb_id}/wiki/pages/{slug} [delete] +// @Router /knowledgebase/{kb_id}/wiki/pages/{slug} [delete] func (h *WikiPageHandler) DeletePage(c *gin.Context) { kbID, _, err := h.validateWikiKB(c) if err != nil { @@ -291,7 +291,7 @@ func (h *WikiPageHandler) DeletePage(c *gin.Context) { // @Param cursor query string false "Opaque offset cursor from previous response" // @Success 200 {object} types.WikiIndexResponse // @Security Bearer -// @Router /api/v1/knowledgebase/{kb_id}/wiki/index [get] +// @Router /knowledgebase/{kb_id}/wiki/index [get] func (h *WikiPageHandler) GetIndex(c *gin.Context) { kbID, _, err := h.validateWikiKB(c) if err != nil { @@ -337,7 +337,7 @@ func (h *WikiPageHandler) GetIndex(c *gin.Context) { // @Param limit query int false "Page size, 1-200 (default 50)" // @Success 200 {object} types.WikiLogEntryListResponse // @Security Bearer -// @Router /api/v1/knowledgebase/{kb_id}/wiki/log [get] +// @Router /knowledgebase/{kb_id}/wiki/log [get] func (h *WikiPageHandler) GetLog(c *gin.Context) { kbID, _, err := h.validateWikiKB(c) if err != nil { @@ -391,7 +391,7 @@ const ( // @Param limit query int false "Max nodes to return (default 500, max 2000)" // @Success 200 {object} types.WikiGraphData // @Security Bearer -// @Router /api/v1/knowledgebase/{kb_id}/wiki/graph [get] +// @Router /knowledgebase/{kb_id}/wiki/graph [get] func (h *WikiPageHandler) GetGraph(c *gin.Context) { kbID, _, err := h.validateWikiKB(c) if err != nil { @@ -476,7 +476,7 @@ func (h *WikiPageHandler) GetGraph(c *gin.Context) { // @Param kb_id path string true "Knowledge base ID" // @Success 200 {object} types.WikiStats // @Security Bearer -// @Router /api/v1/knowledgebase/{kb_id}/wiki/stats [get] +// @Router /knowledgebase/{kb_id}/wiki/stats [get] func (h *WikiPageHandler) GetStats(c *gin.Context) { kbID, _, err := h.validateWikiKB(c) if err != nil { @@ -503,7 +503,7 @@ func (h *WikiPageHandler) GetStats(c *gin.Context) { // @Param status query string false "Filter by status (pending, ignored, resolved)" // @Success 200 {array} types.WikiPageIssue // @Security Bearer -// @Router /api/v1/knowledgebase/{kb_id}/wiki/issues [get] +// @Router /knowledgebase/{kb_id}/wiki/issues [get] func (h *WikiPageHandler) ListIssues(c *gin.Context) { kbID, _, err := h.validateWikiKB(c) if err != nil { @@ -535,7 +535,7 @@ func (h *WikiPageHandler) ListIssues(c *gin.Context) { // @Success 200 {object} map[string]string // @Failure 400 {object} errors.AppError // @Security Bearer -// @Router /api/v1/knowledgebase/{kb_id}/wiki/issues/{issue_id}/status [put] +// @Router /knowledgebase/{kb_id}/wiki/issues/{issue_id}/status [put] func (h *WikiPageHandler) UpdateIssueStatus(c *gin.Context) { _, _, err := h.validateWikiKB(c) if err != nil { @@ -581,7 +581,7 @@ func (h *WikiPageHandler) UpdateIssueStatus(c *gin.Context) { // @Param limit query int false "Max results (default 10)" // @Success 200 {array} types.WikiPage // @Security Bearer -// @Router /api/v1/knowledgebase/{kb_id}/wiki/search [get] +// @Router /knowledgebase/{kb_id}/wiki/search [get] func (h *WikiPageHandler) SearchPages(c *gin.Context) { kbID, _, err := h.validateWikiKB(c) if err != nil { @@ -613,7 +613,7 @@ func (h *WikiPageHandler) SearchPages(c *gin.Context) { // @Param kb_id path string true "Knowledge base ID" // @Success 200 {object} map[string]string // @Security Bearer -// @Router /api/v1/knowledgebase/{kb_id}/wiki/rebuild-links [post] +// @Router /knowledgebase/{kb_id}/wiki/rebuild-links [post] func (h *WikiPageHandler) RebuildLinks(c *gin.Context) { kbID, _, err := h.validateWikiKB(c) if err != nil { @@ -637,7 +637,7 @@ func (h *WikiPageHandler) RebuildLinks(c *gin.Context) { // @Param kb_id path string true "Knowledge base ID" // @Success 200 {object} service.WikiLintReport // @Security Bearer -// @Router /api/v1/knowledgebase/{kb_id}/wiki/lint [get] +// @Router /knowledgebase/{kb_id}/wiki/lint [get] func (h *WikiPageHandler) Lint(c *gin.Context) { kbID, _, err := h.validateWikiKB(c) if err != nil { @@ -662,7 +662,7 @@ func (h *WikiPageHandler) Lint(c *gin.Context) { // @Param kb_id path string true "Knowledge base ID" // @Success 200 {object} map[string]interface{} // @Security Bearer -// @Router /api/v1/knowledgebase/{kb_id}/wiki/auto-fix [post] +// @Router /knowledgebase/{kb_id}/wiki/auto-fix [post] func (h *WikiPageHandler) AutoFix(c *gin.Context) { kbID, _, err := h.validateWikiKB(c) if err != nil {