mirror of
https://github.com/langgenius/dify.git
synced 2026-09-03 06:53:26 +08:00
574461604d
# Conflicts: # api/commands/system.py # api/controllers/console/init_validate.py # api/controllers/console/workspace/account.py # api/controllers/console/wraps.py # api/controllers/openapi/auth/data.py # api/core/hosting_configuration.py # api/core/provider_manager.py # api/core/rag/retrieval/dataset_retrieval.py # api/services/workspace_service.py # api/tasks/workflow_cfs_scheduler/entities.py # api/tests/test_containers_integration_tests/controllers/console/auth/test_password_reset.py # api/tests/test_containers_integration_tests/services/test_feature_service.py # api/tests/unit_tests/controllers/console/auth/test_account_activation.py # api/tests/unit_tests/controllers/openapi/auth/test_data.py # api/tests/unit_tests/controllers/service_api/app/test_hitl_service_api.py # api/tests/unit_tests/extensions/otel/test_retrieval_tracing.py # api/tests/unit_tests/services/test_feature_service_knowledge_fs.py # dev/start-worker # packages/contracts/console.ts # packages/contracts/package.json # packages/iconify-collections/custom-public/icons.json # web/app/components/workflow/__tests__/index.spec.tsx # web/app/components/workflow/index.tsx # web/features/new-rag/document-chunk-tree.tsx # web/service/fetch.spec.ts
1489 lines
36 KiB
TypeScript
1489 lines
36 KiB
TypeScript
// This file is auto-generated by @hey-api/openapi-ts
|
|
|
|
import * as z from 'zod'
|
|
|
|
/**
|
|
* AccountPayload
|
|
*/
|
|
export const zAccountPayload = z.object({
|
|
email: z.string(),
|
|
id: z.string(),
|
|
name: z.string(),
|
|
})
|
|
|
|
/**
|
|
* AppDescribeInfo
|
|
*/
|
|
export const zAppDescribeInfo = z.object({
|
|
description: z.string().nullish(),
|
|
id: z.string(),
|
|
is_agent: z.boolean().optional().default(false),
|
|
mode: z.string(),
|
|
name: z.string(),
|
|
service_api_enabled: z.boolean(),
|
|
updated_at: z.string().nullish(),
|
|
})
|
|
|
|
/**
|
|
* AppDescribeQuery
|
|
*
|
|
* `?fields=` allow-list for GET /apps/<id>.
|
|
*
|
|
* Empty / omitted → all blocks. Unknown member → ValidationError → 422.
|
|
*/
|
|
export const zAppDescribeQuery = z.object({
|
|
fields: z.string().optional(),
|
|
})
|
|
|
|
/**
|
|
* AppDescribeResponse
|
|
*/
|
|
export const zAppDescribeResponse = z.object({
|
|
info: zAppDescribeInfo.nullish(),
|
|
input_schema: z.record(z.string(), z.unknown()).nullish(),
|
|
parameters: z.record(z.string(), z.unknown()).nullish(),
|
|
})
|
|
|
|
/**
|
|
* AppDslExportQuery
|
|
*
|
|
* Query parameters for GET /apps/<app_id>/dsl.
|
|
*/
|
|
export const zAppDslExportQuery = z.object({
|
|
include_secret: z.boolean().optional().default(false),
|
|
workflow_id: z.uuid().nullish(),
|
|
})
|
|
|
|
/**
|
|
* AppDslExportResponse
|
|
*
|
|
* Export DSL response.
|
|
*/
|
|
export const zAppDslExportResponse = z.object({
|
|
data: z.string(),
|
|
})
|
|
|
|
/**
|
|
* AppDslImportPayload
|
|
*
|
|
* Request body for POST /workspaces/<workspace_id>/apps/imports.
|
|
*/
|
|
export const zAppDslImportPayload = z.object({
|
|
app_id: z.string().nullish(),
|
|
description: z.string().nullish(),
|
|
icon: z.string().nullish(),
|
|
icon_background: z.string().nullish(),
|
|
icon_type: z.string().nullish(),
|
|
mode: z.enum(['yaml-content', 'yaml-url']),
|
|
name: z.string().nullish(),
|
|
yaml_content: z.string().nullish(),
|
|
yaml_url: z.string().nullish(),
|
|
})
|
|
|
|
/**
|
|
* AppInfo
|
|
*/
|
|
export const zAppInfo = z.object({
|
|
description: z.string().nullish(),
|
|
id: z.string(),
|
|
mode: z.string(),
|
|
name: z.string(),
|
|
})
|
|
|
|
/**
|
|
* AppMode
|
|
*/
|
|
export const zAppMode = z.enum([
|
|
'advanced-chat',
|
|
'agent',
|
|
'agent-chat',
|
|
'channel',
|
|
'chat',
|
|
'completion',
|
|
'rag-pipeline',
|
|
'workflow',
|
|
])
|
|
|
|
/**
|
|
* AppListRow
|
|
*/
|
|
export const zAppListRow = z.object({
|
|
description: z.string().nullish(),
|
|
id: z.string(),
|
|
mode: zAppMode,
|
|
name: z.string(),
|
|
updated_at: z.string().nullish(),
|
|
workspace_id: z.string().nullish(),
|
|
workspace_name: z.string().nullish(),
|
|
})
|
|
|
|
/**
|
|
* AppListResponse
|
|
*/
|
|
export const zAppListResponse = z.object({
|
|
data: z.array(zAppListRow),
|
|
has_more: z.boolean(),
|
|
limit: z.int(),
|
|
page: z.int(),
|
|
total: z.int(),
|
|
})
|
|
|
|
/**
|
|
* AppRunRequest
|
|
*/
|
|
export const zAppRunRequest = z.object({
|
|
auto_generate_name: z.boolean().optional().default(true),
|
|
conversation_id: z.string().nullish(),
|
|
files: z.array(z.record(z.string(), z.unknown())).nullish(),
|
|
inputs: z.record(z.string(), z.unknown()),
|
|
query: z.string().nullish(),
|
|
workflow_id: z.string().nullish(),
|
|
workspace_id: z.string().nullish(),
|
|
})
|
|
|
|
/**
|
|
* DeploymentEdition
|
|
*
|
|
* Enum representing the deployment edition of the platform.
|
|
*/
|
|
export const zDeploymentEdition = z.enum(['CLOUD', 'COMMUNITY', 'ENTERPRISE'])
|
|
|
|
/**
|
|
* DeviceCodeRequest
|
|
*/
|
|
export const zDeviceCodeRequest = z.object({
|
|
client_id: z.string(),
|
|
device_label: z.string(),
|
|
})
|
|
|
|
/**
|
|
* DeviceCodeResponse
|
|
*/
|
|
export const zDeviceCodeResponse = z.object({
|
|
device_code: z.string(),
|
|
expires_in: z.int(),
|
|
interval: z.int(),
|
|
user_code: z.string(),
|
|
verification_uri: z.string(),
|
|
})
|
|
|
|
/**
|
|
* DeviceLookupQuery
|
|
*/
|
|
export const zDeviceLookupQuery = z.object({
|
|
user_code: z.string(),
|
|
})
|
|
|
|
/**
|
|
* DeviceLookupResponse
|
|
*/
|
|
export const zDeviceLookupResponse = z.object({
|
|
client_id: z.string().nullish(),
|
|
expires_in_remaining: z.int().optional().default(0),
|
|
valid: z.boolean(),
|
|
})
|
|
|
|
/**
|
|
* DeviceMutateRequest
|
|
*/
|
|
export const zDeviceMutateRequest = z.object({
|
|
user_code: z.string(),
|
|
})
|
|
|
|
/**
|
|
* DeviceMutateResponse
|
|
*/
|
|
export const zDeviceMutateResponse = z.object({
|
|
status: z.string(),
|
|
})
|
|
|
|
/**
|
|
* DevicePollRequest
|
|
*/
|
|
export const zDevicePollRequest = z.object({
|
|
client_id: z.string(),
|
|
device_code: z.string(),
|
|
})
|
|
|
|
/**
|
|
* DslImportWarning
|
|
*
|
|
* Portable DSL reference that could not be restored in the target workspace.
|
|
*/
|
|
export const zDslImportWarning = z.object({
|
|
code: z.string(),
|
|
details: z.record(z.string(), z.unknown()).optional(),
|
|
message: z.string(),
|
|
path: z.string(),
|
|
})
|
|
|
|
/**
|
|
* ErrorDetail
|
|
*/
|
|
export const zErrorDetail = z.object({
|
|
loc: z
|
|
.array(z.union([z.string(), z.int()]))
|
|
.optional()
|
|
.default([]),
|
|
msg: z.string(),
|
|
type: z.string(),
|
|
})
|
|
|
|
/**
|
|
* ErrorBody
|
|
*
|
|
* Canonical non-2xx body. ``code`` is typed ``str`` (not the enum) so the
|
|
* generated client schema stays an open enum — old CLIs keep parsing when a
|
|
* future server adds a code. Formatter tests pin emitted values to the enum.
|
|
*/
|
|
export const zErrorBody = z.object({
|
|
code: z.string(),
|
|
details: z.array(zErrorDetail).nullish(),
|
|
hint: z.string().nullish(),
|
|
message: z.string(),
|
|
status: z.int(),
|
|
})
|
|
|
|
/**
|
|
* EventStreamResponse
|
|
*/
|
|
export const zEventStreamResponse = z.string()
|
|
|
|
/**
|
|
* FileResponse
|
|
*/
|
|
export const zFileResponse = z.object({
|
|
conversation_id: z.string().nullish(),
|
|
created_at: z.int().nullish(),
|
|
created_by: z.string().nullish(),
|
|
extension: z.string().nullish(),
|
|
file_key: z.string().nullish(),
|
|
id: z.string(),
|
|
mime_type: z.string().nullish(),
|
|
name: z.string(),
|
|
original_url: z.string().nullish(),
|
|
preview_url: z.string().nullish(),
|
|
reference: z.string().nullish(),
|
|
size: z.int(),
|
|
source_url: z.string().nullish(),
|
|
tenant_id: z.string().nullish(),
|
|
user_id: z.string().nullish(),
|
|
})
|
|
|
|
/**
|
|
* FormSubmitResponse
|
|
*
|
|
* Empty 200 body for POST /apps/<id>/human-input-forms/<token>:submit. `extra='forbid'`
|
|
* pins `additionalProperties: false` so the generated contract is an exact `{}` rather
|
|
* than an under-annotated open object.
|
|
*/
|
|
export const zFormSubmitResponse = z.record(z.string(), z.never())
|
|
|
|
/**
|
|
* Github
|
|
*/
|
|
export const zGithub = z.object({
|
|
github_plugin_unique_identifier: z.string(),
|
|
package: z.string(),
|
|
repo: z.string(),
|
|
version: z.string(),
|
|
})
|
|
|
|
/**
|
|
* HealthResponse
|
|
*
|
|
* Liveness payload for `GET /openapi/v1/_health` — no auth required.
|
|
*/
|
|
export const zHealthResponse = z.object({
|
|
ok: z.boolean(),
|
|
})
|
|
|
|
/**
|
|
* HumanInputFormDefinitionResponse
|
|
*/
|
|
export const zHumanInputFormDefinitionResponse = z.object({
|
|
expiration_time: z.int().nullish(),
|
|
form_content: z.string(),
|
|
inputs: z.array(z.record(z.string(), z.unknown())).optional(),
|
|
resolved_default_values: z.record(z.string(), z.string()),
|
|
user_actions: z.array(z.record(z.string(), z.unknown())).optional(),
|
|
})
|
|
|
|
/**
|
|
* ImportStatus
|
|
*/
|
|
export const zImportStatus = z.enum(['completed', 'completed-with-warnings', 'failed', 'pending'])
|
|
|
|
/**
|
|
* Import
|
|
*/
|
|
export const zImport = z.object({
|
|
app_id: z.string().nullish(),
|
|
app_mode: z.string().nullish(),
|
|
current_dsl_version: z.string().optional().default('0.7.0'),
|
|
error: z.string().optional().default(''),
|
|
id: z.string(),
|
|
imported_dsl_version: z.string().optional().default(''),
|
|
permission_keys: z.array(z.string()).optional(),
|
|
status: zImportStatus,
|
|
warnings: z.array(zDslImportWarning).optional(),
|
|
})
|
|
|
|
export const zJsonValue = z.unknown()
|
|
|
|
/**
|
|
* HumanInputFormSubmitPayload
|
|
*/
|
|
export const zHumanInputFormSubmitPayload = z.object({
|
|
action: z.string(),
|
|
inputs: z.record(z.string(), zJsonValue),
|
|
})
|
|
|
|
export const zKnowledgeFsConsistencyClass = z.enum([
|
|
'cache-consistent',
|
|
'eventual-preview',
|
|
'path-consistent',
|
|
'snapshot-consistent',
|
|
])
|
|
|
|
/**
|
|
* KnowledgeFSEntryComparePayload
|
|
*/
|
|
export const zKnowledgeFsEntryComparePayload = z.object({
|
|
consistency_class: zKnowledgeFsConsistencyClass.nullish(),
|
|
include_semantic_summary: z.boolean().optional().default(false),
|
|
mode: z.enum(['line', 'word']).nullish(),
|
|
new_path: z
|
|
.string()
|
|
.min(1)
|
|
.max(4096)
|
|
.regex(/^\/(?:sources|knowledge|evidence|workspaces)(?:\/[^\/\s]+)*$/),
|
|
old_path: z
|
|
.string()
|
|
.min(1)
|
|
.max(4096)
|
|
.regex(/^\/(?:sources|knowledge|evidence|workspaces)(?:\/[^\/\s]+)*$/),
|
|
})
|
|
|
|
/**
|
|
* KnowledgeFSEntryComparisonOperationResponse
|
|
*/
|
|
export const zKnowledgeFsEntryComparisonOperationResponse = z.object({
|
|
kind: z.enum(['delete', 'equal', 'insert']),
|
|
new_end: z.int().gte(1).nullish(),
|
|
new_start: z.int().gte(1).nullish(),
|
|
old_end: z.int().gte(1).nullish(),
|
|
old_start: z.int().gte(1).nullish(),
|
|
text: z.string(),
|
|
})
|
|
|
|
/**
|
|
* KnowledgeFSEntryComparisonStatsResponse
|
|
*/
|
|
export const zKnowledgeFsEntryComparisonStatsResponse = z.object({
|
|
delete: z.int().gte(0),
|
|
equal: z.int().gte(0),
|
|
insert: z.int().gte(0),
|
|
})
|
|
|
|
/**
|
|
* KnowledgeFSEntryContentMatchResponse
|
|
*/
|
|
export const zKnowledgeFsEntryContentMatchResponse = z.object({
|
|
end_offset: z.int().gte(0),
|
|
kind: z.enum(['node', 'segment']),
|
|
metadata: z.record(z.string(), zJsonValue),
|
|
node_id: z.string().nullish(),
|
|
path: z.string(),
|
|
segment_id: z.string().nullish(),
|
|
snippet: z.string(),
|
|
start_offset: z.int().gte(0),
|
|
})
|
|
|
|
/**
|
|
* KnowledgeFSEntryContentSearchQuery
|
|
*/
|
|
export const zKnowledgeFsEntryContentSearchQuery = z.object({
|
|
consistency_class: zKnowledgeFsConsistencyClass.nullish(),
|
|
page_size: z.int().gte(1).lte(100).optional().default(20),
|
|
page_token: z.string().min(1).max(8192).nullish(),
|
|
path: z
|
|
.string()
|
|
.min(1)
|
|
.max(4096)
|
|
.regex(/^\/(?:sources|knowledge|evidence|workspaces)(?:\/[^\/\s]+)*$/),
|
|
text: z.string().min(1).max(4000),
|
|
timeout_ms: z.int().gte(1).lte(10000).nullish(),
|
|
})
|
|
|
|
/**
|
|
* KnowledgeFSEntryContentSearchResponse
|
|
*/
|
|
export const zKnowledgeFsEntryContentSearchResponse = z.object({
|
|
data: z.array(zKnowledgeFsEntryContentMatchResponse),
|
|
has_more: z.boolean(),
|
|
next_page_token: z.string().nullish(),
|
|
path: z.string(),
|
|
truncated: z.boolean(),
|
|
})
|
|
|
|
/**
|
|
* KnowledgeFSEntryInspectQuery
|
|
*/
|
|
export const zKnowledgeFsEntryInspectQuery = z.object({
|
|
consistency_class: zKnowledgeFsConsistencyClass.nullish(),
|
|
path: z
|
|
.string()
|
|
.min(1)
|
|
.max(4096)
|
|
.regex(/^\/(?:sources|knowledge|evidence|workspaces)(?:\/[^\/\s]+)*$/),
|
|
})
|
|
|
|
/**
|
|
* KnowledgeFSEntryListQuery
|
|
*
|
|
* List direct children in stable KnowledgeFS traversal order.
|
|
*/
|
|
export const zKnowledgeFsEntryListQuery = z.object({
|
|
consistency_class: zKnowledgeFsConsistencyClass.nullish(),
|
|
page_size: z.int().gte(1).lte(100).optional().default(20),
|
|
page_token: z.string().min(1).max(8192).nullish(),
|
|
path: z
|
|
.string()
|
|
.min(1)
|
|
.max(4096)
|
|
.regex(/^\/(?:sources|knowledge|evidence|workspaces)(?:\/[^\/\s]+)*$/),
|
|
})
|
|
|
|
/**
|
|
* KnowledgeFSEntryMetadataResponse
|
|
*/
|
|
export const zKnowledgeFsEntryMetadataResponse = z.object({
|
|
consistency_class: z.string().nullish(),
|
|
content_type: z.string().nullish(),
|
|
metadata: z.record(z.string(), zJsonValue),
|
|
parser_status: z.string().nullish(),
|
|
path: z.string(),
|
|
preview: z.boolean().nullish(),
|
|
resource_type: z.string(),
|
|
sha256: z.string().nullish(),
|
|
size_bytes: z.int().gte(0).nullish(),
|
|
target_id: z.string(),
|
|
version: z.int().gte(1).nullish(),
|
|
})
|
|
|
|
/**
|
|
* KnowledgeFSEntryReadContentQuery
|
|
*/
|
|
export const zKnowledgeFsEntryReadContentQuery = z.object({
|
|
consistency_class: zKnowledgeFsConsistencyClass.nullish(),
|
|
page_size: z.int().gte(1).lte(100).optional().default(100),
|
|
page_token: z.string().min(1).max(8192).nullish(),
|
|
path: z
|
|
.string()
|
|
.min(1)
|
|
.max(4096)
|
|
.regex(/^\/(?:sources|knowledge|evidence|workspaces)(?:\/[^\/\s]+)*$/),
|
|
})
|
|
|
|
/**
|
|
* KnowledgeFSEntryReadContentResponse
|
|
*/
|
|
export const zKnowledgeFsEntryReadContentResponse = z.object({
|
|
content_type: z.string(),
|
|
has_more: z.boolean(),
|
|
next_page_token: z.string().nullish(),
|
|
path: z.string(),
|
|
text: z.string(),
|
|
truncated: z.boolean(),
|
|
})
|
|
|
|
/**
|
|
* KnowledgeFSEntryResponse
|
|
*/
|
|
export const zKnowledgeFsEntryResponse = z.object({
|
|
kind: z.enum(['directory', 'resource']),
|
|
metadata: z.record(z.string(), zJsonValue),
|
|
name: z.string(),
|
|
path: z.string(),
|
|
resource_type: z.string().nullish(),
|
|
target_id: z.string().nullish(),
|
|
version: z.int().gte(1).nullish(),
|
|
})
|
|
|
|
/**
|
|
* KnowledgeFSEntryListResponse
|
|
*/
|
|
export const zKnowledgeFsEntryListResponse = z.object({
|
|
consistency_class: z.string().nullish(),
|
|
data: z.array(zKnowledgeFsEntryResponse),
|
|
has_more: z.boolean(),
|
|
next_page_token: z.string().nullish(),
|
|
path: z.string(),
|
|
preview: z.boolean().nullish(),
|
|
truncated: z.boolean(),
|
|
})
|
|
|
|
/**
|
|
* KnowledgeFSEntrySemanticChangeResponse
|
|
*/
|
|
export const zKnowledgeFsEntrySemanticChangeResponse = z.object({
|
|
category: z.string(),
|
|
evidence: z.array(z.string()),
|
|
summary: z.string(),
|
|
})
|
|
|
|
/**
|
|
* KnowledgeFSEntrySemanticSummaryResponse
|
|
*/
|
|
export const zKnowledgeFsEntrySemanticSummaryResponse = z.object({
|
|
changes: z.array(zKnowledgeFsEntrySemanticChangeResponse),
|
|
metadata: z.record(z.string(), zJsonValue),
|
|
model: z.string().nullish(),
|
|
summary: z.string(),
|
|
})
|
|
|
|
/**
|
|
* KnowledgeFSEntryComparisonResponse
|
|
*/
|
|
export const zKnowledgeFsEntryComparisonResponse = z.object({
|
|
mode: z.enum(['line', 'word']),
|
|
new_path: z.string(),
|
|
old_path: z.string(),
|
|
operations: z.array(zKnowledgeFsEntryComparisonOperationResponse),
|
|
semantic: zKnowledgeFsEntrySemanticSummaryResponse.nullish(),
|
|
stats: zKnowledgeFsEntryComparisonStatsResponse,
|
|
})
|
|
|
|
/**
|
|
* KnowledgeFSEntryTreeNodeResponse
|
|
*/
|
|
export const zKnowledgeFsEntryTreeNodeResponse = z.object({
|
|
children: z.array(z.lazy((): any => zKnowledgeFsEntryTreeNodeResponse)).nullish(),
|
|
kind: z.enum(['directory', 'resource']),
|
|
metadata: z.record(z.string(), zJsonValue),
|
|
name: z.string(),
|
|
path: z.string(),
|
|
resource_type: z.string().nullish(),
|
|
target_id: z.string().nullish(),
|
|
version: z.int().gte(1).nullish(),
|
|
})
|
|
|
|
/**
|
|
* KnowledgeFSEntryTreeQuery
|
|
*/
|
|
export const zKnowledgeFsEntryTreeQuery = z.object({
|
|
consistency_class: zKnowledgeFsConsistencyClass.nullish(),
|
|
depth: z.int().gte(1).lte(8).nullish(),
|
|
page_size: z.int().gte(1).lte(100).optional().default(20),
|
|
page_token: z.string().min(1).max(8192).nullish(),
|
|
path: z
|
|
.string()
|
|
.min(1)
|
|
.max(4096)
|
|
.regex(/^\/(?:sources|knowledge|evidence|workspaces)(?:\/[^\/\s]+)*$/),
|
|
})
|
|
|
|
/**
|
|
* KnowledgeFSEntryTreeResponse
|
|
*/
|
|
export const zKnowledgeFsEntryTreeResponse = z.object({
|
|
consistency_class: z.string().nullish(),
|
|
has_more: z.boolean(),
|
|
next_page_token: z.string().nullish(),
|
|
path: z.string(),
|
|
preview: z.boolean().nullish(),
|
|
root: zKnowledgeFsEntryTreeNodeResponse,
|
|
truncated: z.boolean(),
|
|
})
|
|
|
|
export const zKnowledgeFsResourceType = z.enum([
|
|
'artifact',
|
|
'document',
|
|
'evidence',
|
|
'node',
|
|
'source',
|
|
'workspace',
|
|
])
|
|
|
|
/**
|
|
* KnowledgeFSEntrySearchQuery
|
|
*/
|
|
export const zKnowledgeFsEntrySearchQuery = z.object({
|
|
consistency_class: zKnowledgeFsConsistencyClass.nullish(),
|
|
metadata_key: z.string().min(1).max(120).nullish(),
|
|
metadata_value: z.string().min(1).max(4000).nullish(),
|
|
name_contains: z.string().min(1).max(240).nullish(),
|
|
page_size: z.int().gte(1).lte(100).optional().default(20),
|
|
page_token: z.string().min(1).max(8192).nullish(),
|
|
path: z
|
|
.string()
|
|
.min(1)
|
|
.max(4096)
|
|
.regex(/^\/(?:sources|knowledge|evidence|workspaces)(?:\/[^\/\s]+)*$/),
|
|
resource_type: zKnowledgeFsResourceType.nullish(),
|
|
})
|
|
|
|
/**
|
|
* Marketplace
|
|
*/
|
|
export const zMarketplace = z.object({
|
|
marketplace_plugin_unique_identifier: z.string(),
|
|
version: z.string().nullish(),
|
|
})
|
|
|
|
/**
|
|
* MemberActionResponse
|
|
*/
|
|
export const zMemberActionResponse = z.object({
|
|
result: z.literal('success').optional().default('success'),
|
|
})
|
|
|
|
/**
|
|
* MemberInvitePayload
|
|
*/
|
|
export const zMemberInvitePayload = z.object({
|
|
email: z.string(),
|
|
role: z.enum(['admin', 'normal']),
|
|
})
|
|
|
|
/**
|
|
* MemberInviteResponse
|
|
*/
|
|
export const zMemberInviteResponse = z.object({
|
|
email: z.string(),
|
|
invite_url: z.string(),
|
|
member_id: z.string(),
|
|
result: z.literal('success').optional().default('success'),
|
|
role: z.string(),
|
|
tenant_id: z.string(),
|
|
})
|
|
|
|
/**
|
|
* MemberListQuery
|
|
*
|
|
* Strict (extra='forbid').
|
|
*/
|
|
export const zMemberListQuery = z.object({
|
|
limit: z.int().gte(1).lte(200).optional().default(20),
|
|
page: z.int().gte(1).optional().default(1),
|
|
})
|
|
|
|
/**
|
|
* MemberResponse
|
|
*/
|
|
export const zMemberResponse = z.object({
|
|
avatar: z.string().nullish(),
|
|
email: z.string(),
|
|
id: z.string(),
|
|
name: z.string(),
|
|
role: z.string(),
|
|
status: z.string(),
|
|
})
|
|
|
|
/**
|
|
* MemberListResponse
|
|
*/
|
|
export const zMemberListResponse = z.object({
|
|
data: z.array(zMemberResponse),
|
|
has_more: z.boolean(),
|
|
limit: z.int(),
|
|
page: z.int(),
|
|
total: z.int(),
|
|
})
|
|
|
|
/**
|
|
* MemberRoleUpdatePayload
|
|
*/
|
|
export const zMemberRoleUpdatePayload = z.object({
|
|
role: z.enum(['admin', 'normal']),
|
|
})
|
|
|
|
/**
|
|
* OpenApiErrorCode
|
|
*/
|
|
export const zOpenApiErrorCode = z.enum([
|
|
'agent_not_published',
|
|
'app_unavailable',
|
|
'bad_gateway',
|
|
'bad_request',
|
|
'completion_request_error',
|
|
'conflict',
|
|
'conversation_completed',
|
|
'file_extension_blocked',
|
|
'file_too_large',
|
|
'filename_not_exists',
|
|
'forbidden',
|
|
'form_not_found',
|
|
'internal_server_error',
|
|
'invalid_param',
|
|
'knowledge_fs_access_denied',
|
|
'knowledge_fs_conflict',
|
|
'knowledge_fs_invalid_request',
|
|
'knowledge_fs_request_rejected',
|
|
'knowledge_fs_request_too_large',
|
|
'knowledge_fs_resource_not_found',
|
|
'knowledge_fs_unavailable',
|
|
'member_license_exceeded',
|
|
'member_limit_exceeded',
|
|
'method_not_allowed',
|
|
'model_currently_not_support',
|
|
'no_file_uploaded',
|
|
'not_acceptable',
|
|
'not_found',
|
|
'provider_not_initialize',
|
|
'provider_quota_exceeded',
|
|
'rate_limit_error',
|
|
'recipient_surface_mismatch',
|
|
'request_entity_too_large',
|
|
'too_many_files',
|
|
'too_many_requests',
|
|
'unauthorized',
|
|
'unknown',
|
|
'unsupported_file_type',
|
|
'unsupported_media_type',
|
|
'upgrade_required',
|
|
])
|
|
|
|
/**
|
|
* Package
|
|
*/
|
|
export const zPackage = z.object({
|
|
plugin_unique_identifier: z.string(),
|
|
version: z.string().nullish(),
|
|
})
|
|
|
|
/**
|
|
* PermittedExternalAppsListResponse
|
|
*/
|
|
export const zPermittedExternalAppsListResponse = z.object({
|
|
data: z.array(zAppListRow),
|
|
has_more: z.boolean(),
|
|
limit: z.int(),
|
|
page: z.int(),
|
|
total: z.int(),
|
|
})
|
|
|
|
/**
|
|
* PluginDependencyType
|
|
*/
|
|
export const zPluginDependencyType = z.enum(['github', 'marketplace', 'package'])
|
|
|
|
/**
|
|
* PluginDependency
|
|
*/
|
|
export const zPluginDependency = z.object({
|
|
current_identifier: z.string().nullish(),
|
|
type: zPluginDependencyType,
|
|
value: z.union([zGithub, zMarketplace, zPackage]),
|
|
})
|
|
|
|
/**
|
|
* CheckDependenciesResult
|
|
*/
|
|
export const zCheckDependenciesResult = z.object({
|
|
leaked_dependencies: z.array(zPluginDependency).optional(),
|
|
})
|
|
|
|
/**
|
|
* RevokeResponse
|
|
*/
|
|
export const zRevokeResponse = z.object({
|
|
status: z.string(),
|
|
})
|
|
|
|
/**
|
|
* ServerVersionResponse
|
|
*
|
|
* Meta endpoint payload for `GET /openapi/v1/_version` — no auth required.
|
|
*/
|
|
export const zServerVersionResponse = z.object({
|
|
edition: zDeploymentEdition,
|
|
version: z.string(),
|
|
})
|
|
|
|
/**
|
|
* SessionListQuery
|
|
*
|
|
* Pagination for GET /account/sessions. Strict (extra='forbid').
|
|
*/
|
|
export const zSessionListQuery = z.object({
|
|
limit: z.int().gte(1).lte(200).optional().default(100),
|
|
page: z.int().gte(1).optional().default(1),
|
|
})
|
|
|
|
/**
|
|
* SessionRow
|
|
*/
|
|
export const zSessionRow = z.object({
|
|
client_id: z.string(),
|
|
created_at: z.string().nullish(),
|
|
device_label: z.string(),
|
|
expires_at: z.string().nullish(),
|
|
id: z.string(),
|
|
last_used_at: z.string().nullish(),
|
|
prefix: z.string(),
|
|
})
|
|
|
|
/**
|
|
* SessionListResponse
|
|
*/
|
|
export const zSessionListResponse = z.object({
|
|
data: z.array(zSessionRow),
|
|
has_more: z.boolean(),
|
|
limit: z.int(),
|
|
page: z.int(),
|
|
total: z.int(),
|
|
})
|
|
|
|
/**
|
|
* SimpleResultResponse
|
|
*/
|
|
export const zSimpleResultResponse = z.object({
|
|
result: z.string(),
|
|
})
|
|
|
|
/**
|
|
* SupportedAppType
|
|
*
|
|
* App types the ``app`` usage face (``get app``) lists and filters.
|
|
*
|
|
* A curated subset of :class:`AppMode`: the real, user-facing app categories.
|
|
* Excludes runtime-only mode tags that are not standalone apps
|
|
* (``rag-pipeline`` is a knowledge ``Pipeline``; ``channel`` is unused) and the
|
|
* roster-owned ``agent`` type (surfaced through the roster, not this list).
|
|
*
|
|
* Members reference ``AppMode.*.value`` so the subset relationship is
|
|
* type-checked: dropping a member from ``AppMode`` breaks this at import.
|
|
* This is the single source for the listable set — params, filters, and the
|
|
* generated CLI whitelist all derive from it.
|
|
*/
|
|
export const zSupportedAppType = z.enum([
|
|
'advanced-chat',
|
|
'agent-chat',
|
|
'chat',
|
|
'completion',
|
|
'workflow',
|
|
])
|
|
|
|
/**
|
|
* AppListQuery
|
|
*
|
|
* mode is a closed enum of listable app types.
|
|
*/
|
|
export const zAppListQuery = z.object({
|
|
limit: z.int().gte(1).lte(200).optional().default(20),
|
|
mode: zSupportedAppType.nullish(),
|
|
name: z.string().max(200).nullish(),
|
|
page: z.int().gte(1).optional().default(1),
|
|
workspace_id: z.uuid(),
|
|
})
|
|
|
|
/**
|
|
* PermittedExternalAppsListQuery
|
|
*
|
|
* Strict (extra='forbid').
|
|
*/
|
|
export const zPermittedExternalAppsListQuery = z.object({
|
|
limit: z.int().gte(1).lte(200).optional().default(20),
|
|
mode: zSupportedAppType.nullish(),
|
|
name: z.string().max(200).nullish(),
|
|
page: z.int().gte(1).optional().default(1),
|
|
})
|
|
|
|
/**
|
|
* TaskStopResponse
|
|
*
|
|
* 200 body for POST /apps/<id>/tasks/<task_id>:stop. The handler always returns
|
|
* {"result": "success"}, so `result` is required (no default) — the generated contract
|
|
* types it as a required `'success'` rather than an optional field.
|
|
*/
|
|
export const zTaskStopResponse = z.object({
|
|
result: z.literal('success'),
|
|
})
|
|
|
|
/**
|
|
* UsageInfo
|
|
*/
|
|
export const zUsageInfo = z.object({
|
|
completion_tokens: z.int().optional().default(0),
|
|
prompt_tokens: z.int().optional().default(0),
|
|
total_tokens: z.int().optional().default(0),
|
|
})
|
|
|
|
/**
|
|
* MessageMetadata
|
|
*/
|
|
export const zMessageMetadata = z.object({
|
|
retriever_resources: z.array(z.record(z.string(), z.unknown())).optional().default([]),
|
|
usage: zUsageInfo.nullish(),
|
|
})
|
|
|
|
/**
|
|
* WorkflowRunData
|
|
*/
|
|
export const zWorkflowRunData = z.object({
|
|
created_at: z.int().nullish(),
|
|
elapsed_time: z.number().nullish(),
|
|
error: z.string().nullish(),
|
|
finished_at: z.int().nullish(),
|
|
id: z.string(),
|
|
outputs: z.record(z.string(), z.unknown()).optional(),
|
|
status: z.string(),
|
|
total_steps: z.int().nullish(),
|
|
total_tokens: z.int().nullish(),
|
|
workflow_id: z.string(),
|
|
})
|
|
|
|
/**
|
|
* WorkspaceDetailResponse
|
|
*/
|
|
export const zWorkspaceDetailResponse = z.object({
|
|
created_at: z.string().nullish(),
|
|
current: z.boolean(),
|
|
id: z.string(),
|
|
name: z.string(),
|
|
role: z.string(),
|
|
status: z.string(),
|
|
})
|
|
|
|
/**
|
|
* WorkspacePayload
|
|
*/
|
|
export const zWorkspacePayload = z.object({
|
|
id: z.string(),
|
|
name: z.string(),
|
|
role: z.string(),
|
|
})
|
|
|
|
/**
|
|
* AccountResponse
|
|
*/
|
|
export const zAccountResponse = z.object({
|
|
account: zAccountPayload.nullish(),
|
|
default_workspace_id: z.string().nullish(),
|
|
subject_email: z.string().nullish(),
|
|
subject_issuer: z.string().nullish(),
|
|
subject_type: z.string(),
|
|
workspaces: z.array(zWorkspacePayload).optional().default([]),
|
|
})
|
|
|
|
/**
|
|
* DeviceTokenResponse
|
|
*/
|
|
export const zDeviceTokenResponse = z.object({
|
|
account: zAccountPayload.nullish(),
|
|
default_workspace_id: z.string().nullish(),
|
|
expires_at: z.string(),
|
|
subject_email: z.string().nullish(),
|
|
subject_issuer: z.string().nullish(),
|
|
subject_type: z.enum(['account', 'external_sso']),
|
|
token: z.string(),
|
|
token_id: z.string(),
|
|
workspaces: z.array(zWorkspacePayload).optional().default([]),
|
|
})
|
|
|
|
/**
|
|
* WorkspaceSummaryResponse
|
|
*/
|
|
export const zWorkspaceSummaryResponse = z.object({
|
|
current: z.boolean(),
|
|
id: z.string(),
|
|
name: z.string(),
|
|
role: z.string(),
|
|
status: z.string(),
|
|
})
|
|
|
|
/**
|
|
* WorkspaceListResponse
|
|
*/
|
|
export const zWorkspaceListResponse = z.object({
|
|
workspaces: z.array(zWorkspaceSummaryResponse),
|
|
})
|
|
|
|
/**
|
|
* Health check
|
|
*/
|
|
export const zGetHealthResponse = zHealthResponse
|
|
|
|
/**
|
|
* Server version
|
|
*/
|
|
export const zGetVersionResponse = zServerVersionResponse
|
|
|
|
/**
|
|
* Account info
|
|
*/
|
|
export const zGetAccountResponse = zAccountResponse
|
|
|
|
export const zGetAccountSessionsQuery = z.object({
|
|
limit: z.int().gte(1).lte(200).optional().default(100),
|
|
page: z.int().gte(1).optional().default(1),
|
|
})
|
|
|
|
/**
|
|
* Session list
|
|
*/
|
|
export const zGetAccountSessionsResponse = zSessionListResponse
|
|
|
|
/**
|
|
* Session revoked
|
|
*/
|
|
export const zDeleteAccountSessionsSelfResponse = zRevokeResponse
|
|
|
|
export const zDeleteAccountSessionsBySessionIdPath = z.object({
|
|
session_id: z.string(),
|
|
})
|
|
|
|
/**
|
|
* Session revoked
|
|
*/
|
|
export const zDeleteAccountSessionsBySessionIdResponse = zRevokeResponse
|
|
|
|
export const zGetAppsQuery = z.object({
|
|
limit: z.int().gte(1).lte(200).optional().default(20),
|
|
mode: z.enum(['advanced-chat', 'agent-chat', 'chat', 'completion', 'workflow']).optional(),
|
|
name: z.string().max(200).optional(),
|
|
page: z.int().gte(1).optional().default(1),
|
|
workspace_id: z.uuid(),
|
|
})
|
|
|
|
/**
|
|
* App list
|
|
*/
|
|
export const zGetAppsResponse = zAppListResponse
|
|
|
|
export const zGetAppsByAppIdPath = z.object({
|
|
app_id: z.string(),
|
|
})
|
|
|
|
export const zGetAppsByAppIdQuery = z.object({
|
|
fields: z.string().optional(),
|
|
})
|
|
|
|
/**
|
|
* App description
|
|
*/
|
|
export const zGetAppsByAppIdResponse = zAppDescribeResponse
|
|
|
|
export const zGetAppsByAppIdDependenciesCheckPath = z.object({
|
|
app_id: z.string(),
|
|
})
|
|
|
|
/**
|
|
* Dependencies checked
|
|
*/
|
|
export const zGetAppsByAppIdDependenciesCheckResponse = zCheckDependenciesResult
|
|
|
|
export const zGetAppsByAppIdDslPath = z.object({
|
|
app_id: z.string(),
|
|
})
|
|
|
|
export const zGetAppsByAppIdDslQuery = z.object({
|
|
include_secret: z.boolean().optional().default(false),
|
|
workflow_id: z.uuid().optional(),
|
|
})
|
|
|
|
/**
|
|
* Export successful
|
|
*/
|
|
export const zGetAppsByAppIdDslResponse = zAppDslExportResponse
|
|
|
|
export const zPostAppsByAppIdFilesPath = z.object({
|
|
app_id: z.string(),
|
|
})
|
|
|
|
/**
|
|
* File uploaded successfully
|
|
*/
|
|
export const zPostAppsByAppIdFilesResponse = zFileResponse
|
|
|
|
export const zGetAppsByAppIdHumanInputFormsByFormTokenPath = z.object({
|
|
app_id: z.string(),
|
|
form_token: z.string(),
|
|
})
|
|
|
|
/**
|
|
* Form definition
|
|
*/
|
|
export const zGetAppsByAppIdHumanInputFormsByFormTokenResponse = zHumanInputFormDefinitionResponse
|
|
|
|
export const zPostAppsByAppIdHumanInputFormsByFormTokenSubmitBody = zHumanInputFormSubmitPayload
|
|
|
|
export const zPostAppsByAppIdHumanInputFormsByFormTokenSubmitPath = z.object({
|
|
app_id: z.string(),
|
|
form_token: z.string(),
|
|
})
|
|
|
|
/**
|
|
* Form submitted
|
|
*/
|
|
export const zPostAppsByAppIdHumanInputFormsByFormTokenSubmitResponse = zFormSubmitResponse
|
|
|
|
export const zGetAppsByAppIdTasksByTaskIdEventsPath = z.object({
|
|
app_id: z.string(),
|
|
task_id: z.string(),
|
|
})
|
|
|
|
export const zGetAppsByAppIdTasksByTaskIdEventsQuery = z.object({
|
|
continue_on_pause: z.boolean().optional().default(false),
|
|
include_state_snapshot: z.boolean().optional().default(false),
|
|
})
|
|
|
|
/**
|
|
* SSE event stream
|
|
*/
|
|
export const zGetAppsByAppIdTasksByTaskIdEventsResponse = zEventStreamResponse
|
|
|
|
export const zPostAppsByAppIdTasksByTaskIdStopPath = z.object({
|
|
app_id: z.string(),
|
|
task_id: z.string(),
|
|
})
|
|
|
|
/**
|
|
* Task stopped
|
|
*/
|
|
export const zPostAppsByAppIdTasksByTaskIdStopResponse = zTaskStopResponse
|
|
|
|
export const zPostAppsByAppIdRunBody = zAppRunRequest
|
|
|
|
export const zPostAppsByAppIdRunPath = z.object({
|
|
app_id: z.string(),
|
|
})
|
|
|
|
/**
|
|
* Run result (SSE stream)
|
|
*/
|
|
export const zPostAppsByAppIdRunResponse = zEventStreamResponse
|
|
|
|
export const zPostOauthDeviceApproveBody = zDeviceMutateRequest
|
|
|
|
/**
|
|
* Approved
|
|
*/
|
|
export const zPostOauthDeviceApproveResponse = zDeviceMutateResponse
|
|
|
|
export const zPostOauthDeviceCodeBody = zDeviceCodeRequest
|
|
|
|
/**
|
|
* Device code created
|
|
*/
|
|
export const zPostOauthDeviceCodeResponse = zDeviceCodeResponse
|
|
|
|
export const zPostOauthDeviceDenyBody = zDeviceMutateRequest
|
|
|
|
/**
|
|
* Denied
|
|
*/
|
|
export const zPostOauthDeviceDenyResponse = zDeviceMutateResponse
|
|
|
|
export const zGetOauthDeviceLookupQuery = z.object({
|
|
user_code: z.string(),
|
|
})
|
|
|
|
/**
|
|
* Device lookup result
|
|
*/
|
|
export const zGetOauthDeviceLookupResponse = zDeviceLookupResponse
|
|
|
|
export const zPostOauthDeviceTokenBody = zDevicePollRequest
|
|
|
|
/**
|
|
* Device token
|
|
*/
|
|
export const zPostOauthDeviceTokenResponse = zDeviceTokenResponse
|
|
|
|
export const zGetPermittedExternalAppsQuery = z.object({
|
|
limit: z.int().gte(1).lte(200).optional().default(20),
|
|
mode: z.enum(['advanced-chat', 'agent-chat', 'chat', 'completion', 'workflow']).optional(),
|
|
name: z.string().max(200).optional(),
|
|
page: z.int().gte(1).optional().default(1),
|
|
})
|
|
|
|
/**
|
|
* Permitted external apps list
|
|
*/
|
|
export const zGetPermittedExternalAppsResponse = zPermittedExternalAppsListResponse
|
|
|
|
export const zGetPermittedExternalAppsByAppIdPath = z.object({
|
|
app_id: z.string(),
|
|
})
|
|
|
|
export const zGetPermittedExternalAppsByAppIdQuery = z.object({
|
|
fields: z.string().optional(),
|
|
})
|
|
|
|
/**
|
|
* Permitted external app description
|
|
*/
|
|
export const zGetPermittedExternalAppsByAppIdResponse = zAppDescribeResponse
|
|
|
|
/**
|
|
* Workspace list
|
|
*/
|
|
export const zGetWorkspacesResponse = zWorkspaceListResponse
|
|
|
|
export const zGetWorkspacesByWorkspaceIdPath = z.object({
|
|
workspace_id: z.string(),
|
|
})
|
|
|
|
/**
|
|
* Workspace detail
|
|
*/
|
|
export const zGetWorkspacesByWorkspaceIdResponse = zWorkspaceDetailResponse
|
|
|
|
export const zPostWorkspacesByWorkspaceIdAppsImportsBody = zAppDslImportPayload
|
|
|
|
export const zPostWorkspacesByWorkspaceIdAppsImportsPath = z.object({
|
|
workspace_id: z.string(),
|
|
})
|
|
|
|
/**
|
|
* Import completed
|
|
*/
|
|
export const zPostWorkspacesByWorkspaceIdAppsImportsResponse = zImport
|
|
|
|
export const zPostWorkspacesByWorkspaceIdAppsImportsByImportIdConfirmPath = z.object({
|
|
import_id: z.string(),
|
|
workspace_id: z.string(),
|
|
})
|
|
|
|
/**
|
|
* Import confirmed
|
|
*/
|
|
export const zPostWorkspacesByWorkspaceIdAppsImportsByImportIdConfirmResponse = zImport
|
|
|
|
export const zGetWorkspacesByWorkspaceIdKnowledgeFsKnowledgeSpacesByKnowledgeSpaceIdFsCatPath =
|
|
z.object({
|
|
knowledge_space_id: z.string(),
|
|
workspace_id: z.string(),
|
|
})
|
|
|
|
export const zGetWorkspacesByWorkspaceIdKnowledgeFsKnowledgeSpacesByKnowledgeSpaceIdFsCatQuery =
|
|
z.object({
|
|
consistency_class: z
|
|
.enum(['cache-consistent', 'eventual-preview', 'path-consistent', 'snapshot-consistent'])
|
|
.optional(),
|
|
page_size: z.int().gte(1).lte(100).optional().default(100),
|
|
page_token: z.string().min(1).max(8192).optional(),
|
|
path: z
|
|
.string()
|
|
.min(1)
|
|
.max(4096)
|
|
.regex(/^\/(?:sources|knowledge|evidence|workspaces)(?:\/[^\/\s]+)*$/),
|
|
})
|
|
|
|
/**
|
|
* Knowledge-space entry content
|
|
*/
|
|
export const zGetWorkspacesByWorkspaceIdKnowledgeFsKnowledgeSpacesByKnowledgeSpaceIdFsCatResponse =
|
|
zKnowledgeFsEntryReadContentResponse
|
|
|
|
export const zPostWorkspacesByWorkspaceIdKnowledgeFsKnowledgeSpacesByKnowledgeSpaceIdFsDiffBody =
|
|
zKnowledgeFsEntryComparePayload
|
|
|
|
export const zPostWorkspacesByWorkspaceIdKnowledgeFsKnowledgeSpacesByKnowledgeSpaceIdFsDiffPath =
|
|
z.object({
|
|
knowledge_space_id: z.string(),
|
|
workspace_id: z.string(),
|
|
})
|
|
|
|
/**
|
|
* Knowledge-space entry comparison
|
|
*/
|
|
export const zPostWorkspacesByWorkspaceIdKnowledgeFsKnowledgeSpacesByKnowledgeSpaceIdFsDiffResponse =
|
|
zKnowledgeFsEntryComparisonResponse
|
|
|
|
export const zGetWorkspacesByWorkspaceIdKnowledgeFsKnowledgeSpacesByKnowledgeSpaceIdFsFindPath =
|
|
z.object({
|
|
knowledge_space_id: z.string(),
|
|
workspace_id: z.string(),
|
|
})
|
|
|
|
export const zGetWorkspacesByWorkspaceIdKnowledgeFsKnowledgeSpacesByKnowledgeSpaceIdFsFindQuery =
|
|
z.object({
|
|
consistency_class: z
|
|
.enum(['cache-consistent', 'eventual-preview', 'path-consistent', 'snapshot-consistent'])
|
|
.optional(),
|
|
metadata_key: z.string().min(1).max(120).optional(),
|
|
metadata_value: z.string().min(1).max(4000).optional(),
|
|
name_contains: z.string().min(1).max(240).optional(),
|
|
page_size: z.int().gte(1).lte(100).optional().default(20),
|
|
page_token: z.string().min(1).max(8192).optional(),
|
|
path: z
|
|
.string()
|
|
.min(1)
|
|
.max(4096)
|
|
.regex(/^\/(?:sources|knowledge|evidence|workspaces)(?:\/[^\/\s]+)*$/),
|
|
resource_type: z
|
|
.enum(['artifact', 'document', 'evidence', 'node', 'source', 'workspace'])
|
|
.optional(),
|
|
})
|
|
|
|
/**
|
|
* Knowledge-space entry search results
|
|
*/
|
|
export const zGetWorkspacesByWorkspaceIdKnowledgeFsKnowledgeSpacesByKnowledgeSpaceIdFsFindResponse =
|
|
zKnowledgeFsEntryListResponse
|
|
|
|
export const zGetWorkspacesByWorkspaceIdKnowledgeFsKnowledgeSpacesByKnowledgeSpaceIdFsGrepPath =
|
|
z.object({
|
|
knowledge_space_id: z.string(),
|
|
workspace_id: z.string(),
|
|
})
|
|
|
|
export const zGetWorkspacesByWorkspaceIdKnowledgeFsKnowledgeSpacesByKnowledgeSpaceIdFsGrepQuery =
|
|
z.object({
|
|
consistency_class: z
|
|
.enum(['cache-consistent', 'eventual-preview', 'path-consistent', 'snapshot-consistent'])
|
|
.optional(),
|
|
page_size: z.int().gte(1).lte(100).optional().default(20),
|
|
page_token: z.string().min(1).max(8192).optional(),
|
|
path: z
|
|
.string()
|
|
.min(1)
|
|
.max(4096)
|
|
.regex(/^\/(?:sources|knowledge|evidence|workspaces)(?:\/[^\/\s]+)*$/),
|
|
text: z.string().min(1).max(4000),
|
|
timeout_ms: z.int().gte(1).lte(10000).optional(),
|
|
})
|
|
|
|
/**
|
|
* Knowledge-space content matches
|
|
*/
|
|
export const zGetWorkspacesByWorkspaceIdKnowledgeFsKnowledgeSpacesByKnowledgeSpaceIdFsGrepResponse =
|
|
zKnowledgeFsEntryContentSearchResponse
|
|
|
|
export const zGetWorkspacesByWorkspaceIdKnowledgeFsKnowledgeSpacesByKnowledgeSpaceIdFsLsPath =
|
|
z.object({
|
|
knowledge_space_id: z.string(),
|
|
workspace_id: z.string(),
|
|
})
|
|
|
|
export const zGetWorkspacesByWorkspaceIdKnowledgeFsKnowledgeSpacesByKnowledgeSpaceIdFsLsQuery =
|
|
z.object({
|
|
consistency_class: z
|
|
.enum(['cache-consistent', 'eventual-preview', 'path-consistent', 'snapshot-consistent'])
|
|
.optional(),
|
|
page_size: z.int().gte(1).lte(100).optional().default(20),
|
|
page_token: z.string().min(1).max(8192).optional(),
|
|
path: z
|
|
.string()
|
|
.min(1)
|
|
.max(4096)
|
|
.regex(/^\/(?:sources|knowledge|evidence|workspaces)(?:\/[^\/\s]+)*$/),
|
|
})
|
|
|
|
/**
|
|
* Knowledge-space entry page
|
|
*/
|
|
export const zGetWorkspacesByWorkspaceIdKnowledgeFsKnowledgeSpacesByKnowledgeSpaceIdFsLsResponse =
|
|
zKnowledgeFsEntryListResponse
|
|
|
|
export const zGetWorkspacesByWorkspaceIdKnowledgeFsKnowledgeSpacesByKnowledgeSpaceIdFsStatPath =
|
|
z.object({
|
|
knowledge_space_id: z.string(),
|
|
workspace_id: z.string(),
|
|
})
|
|
|
|
export const zGetWorkspacesByWorkspaceIdKnowledgeFsKnowledgeSpacesByKnowledgeSpaceIdFsStatQuery =
|
|
z.object({
|
|
consistency_class: z
|
|
.enum(['cache-consistent', 'eventual-preview', 'path-consistent', 'snapshot-consistent'])
|
|
.optional(),
|
|
path: z
|
|
.string()
|
|
.min(1)
|
|
.max(4096)
|
|
.regex(/^\/(?:sources|knowledge|evidence|workspaces)(?:\/[^\/\s]+)*$/),
|
|
})
|
|
|
|
/**
|
|
* Knowledge-space entry metadata
|
|
*/
|
|
export const zGetWorkspacesByWorkspaceIdKnowledgeFsKnowledgeSpacesByKnowledgeSpaceIdFsStatResponse =
|
|
zKnowledgeFsEntryMetadataResponse
|
|
|
|
export const zGetWorkspacesByWorkspaceIdKnowledgeFsKnowledgeSpacesByKnowledgeSpaceIdFsTreePath =
|
|
z.object({
|
|
knowledge_space_id: z.string(),
|
|
workspace_id: z.string(),
|
|
})
|
|
|
|
export const zGetWorkspacesByWorkspaceIdKnowledgeFsKnowledgeSpacesByKnowledgeSpaceIdFsTreeQuery =
|
|
z.object({
|
|
consistency_class: z
|
|
.enum(['cache-consistent', 'eventual-preview', 'path-consistent', 'snapshot-consistent'])
|
|
.optional(),
|
|
depth: z.int().gte(1).lte(8).optional(),
|
|
page_size: z.int().gte(1).lte(100).optional().default(20),
|
|
page_token: z.string().min(1).max(8192).optional(),
|
|
path: z
|
|
.string()
|
|
.min(1)
|
|
.max(4096)
|
|
.regex(/^\/(?:sources|knowledge|evidence|workspaces)(?:\/[^\/\s]+)*$/),
|
|
})
|
|
|
|
/**
|
|
* Knowledge-space entry tree
|
|
*/
|
|
export const zGetWorkspacesByWorkspaceIdKnowledgeFsKnowledgeSpacesByKnowledgeSpaceIdFsTreeResponse =
|
|
zKnowledgeFsEntryTreeResponse
|
|
|
|
export const zGetWorkspacesByWorkspaceIdMembersPath = z.object({
|
|
workspace_id: z.string(),
|
|
})
|
|
|
|
export const zGetWorkspacesByWorkspaceIdMembersQuery = z.object({
|
|
limit: z.int().gte(1).lte(200).optional().default(20),
|
|
page: z.int().gte(1).optional().default(1),
|
|
})
|
|
|
|
/**
|
|
* Member list
|
|
*/
|
|
export const zGetWorkspacesByWorkspaceIdMembersResponse = zMemberListResponse
|
|
|
|
export const zPostWorkspacesByWorkspaceIdMembersBody = zMemberInvitePayload
|
|
|
|
export const zPostWorkspacesByWorkspaceIdMembersPath = z.object({
|
|
workspace_id: z.string(),
|
|
})
|
|
|
|
/**
|
|
* Member invited
|
|
*/
|
|
export const zPostWorkspacesByWorkspaceIdMembersResponse = zMemberInviteResponse
|
|
|
|
export const zDeleteWorkspacesByWorkspaceIdMembersByMemberIdPath = z.object({
|
|
member_id: z.string(),
|
|
workspace_id: z.string(),
|
|
})
|
|
|
|
/**
|
|
* Member removed
|
|
*/
|
|
export const zDeleteWorkspacesByWorkspaceIdMembersByMemberIdResponse = zMemberActionResponse
|
|
|
|
export const zPatchWorkspacesByWorkspaceIdMembersByMemberIdBody = zMemberRoleUpdatePayload
|
|
|
|
export const zPatchWorkspacesByWorkspaceIdMembersByMemberIdPath = z.object({
|
|
member_id: z.string(),
|
|
workspace_id: z.string(),
|
|
})
|
|
|
|
/**
|
|
* Role updated
|
|
*/
|
|
export const zPatchWorkspacesByWorkspaceIdMembersByMemberIdResponse = zMemberActionResponse
|
|
|
|
export const zPostWorkspacesByWorkspaceIdSwitchPath = z.object({
|
|
workspace_id: z.string(),
|
|
})
|
|
|
|
/**
|
|
* Workspace detail
|
|
*/
|
|
export const zPostWorkspacesByWorkspaceIdSwitchResponse = zWorkspaceDetailResponse
|