opensource/dify
2
0
Fork 0
mirror of https://github.com/langgenius/dify.git synced 2026-06-07 16:32:01 +08:00
Code Issues Packages Projects Releases Wiki Activity

refactor: add console client migration demo (#36300)

Browse Source
This commit is contained in:
Stephen Zhou 2026-05-18 15:41:23 +08:00 committed by GitHub
parent 2eb37caf2e
commit 730a0bef9e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
77 changed files with 4932 additions and 416 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
packages/contracts/README.md Normal file
View File

@ -0,0 +1,40 @@
# Contracts
## API OpenAPI Readiness
<!-- api-openapi-readiness:start -->
<!-- This section is auto-generated by scripts/generate-api-readiness-readme.mjs. Do not edit between the markers. -->
Snapshot generated from `packages/contracts/generated/api/readiness.json` after running `pnpm -C packages/contracts gen-api-contract-from-openapi`.
Are we OpenAPI ready? **No.** Current generated API contracts are **16.6% ready**.
| Surface | Ready | Not ready | Total | Ready % |
| --------- | ------: | --------: | ------: | --------: |
| console | 95 | 475 | 570 | 16.7% |
| service | 16 | 72 | 88 | 18.2% |
| web | 5 | 36 | 41 | 12.2% |
| **total** | **116** | **583** | **699** | **16.6%** |
Readiness here means the generated contract operation is not marked with:
> Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
Operations marked with that warning should not be migrated to blindly. Prefer fixing backend OpenAPI annotations first so the generated contract has accurate request and response types, then migrate callers endpoint by endpoint.
The current heuristic marks an operation as not ready when a request body or success response that should have a body contains a loose object type, or when an operation has no documented 2xx response. 204, 205, and 304 responses are treated as bodyless when the request type is otherwise accurate.
<!-- api-openapi-readiness:end -->
## How to Improve Readiness
Improve the ready percentage by fixing the backend annotations that produce loose generated types, then regenerating the contracts.
- Add accurate request body schemas for endpoints that currently generate loose object types.
- Add accurate 2xx response schemas for endpoints that return JSON payloads.
- Use 204 responses for endpoints that intentionally return no body.
- Avoid untyped dictionaries, raw objects, or `additionalProperties: true` responses unless the API really returns an arbitrary object.
- Regenerate with `pnpm -C packages/contracts gen-api-contract` and use this README to verify the updated percentage.
Do not remove the generated warning just to increase the number. The warning should disappear because the backend OpenAPI output became accurate enough for callers to migrate safely.

72
packages/contracts/generated/api/console/account/orpc.gen.ts
View File

@ -45,10 +45,16 @@ import {
/**
* Get account avatar url
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get = oc
.route({
description: 'Get account avatar url',
deprecated: true,
description:
'Get account avatar url\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getAccountAvatar',
@ -74,8 +80,16 @@ export const avatar = {
post,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post2 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postAccountChangeEmailCheckEmailUnique',
@ -104,8 +118,16 @@ export const reset = {
post: post3,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post4 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postAccountChangeEmailValidity',
@ -119,8 +141,16 @@ export const validity = {
post: post4,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post5 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postAccountChangeEmail',
@ -137,8 +167,16 @@ export const changeEmail = {
validity,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post6 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postAccountDeleteFeedback',
@ -152,8 +190,16 @@ export const feedback = {
post: post6,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get2 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getAccountDeleteVerify',
@ -166,8 +212,16 @@ export const verify = {
get: get2,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post7 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postAccountDelete',
@ -222,8 +276,16 @@ export const get5 = oc
})
.output(zGetAccountEducationResponse)
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post8 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postAccountEducation',
@ -240,8 +302,16 @@ export const education = {
verify: verify2,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post9 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postAccountInit',

8
packages/contracts/generated/api/console/activate/orpc.gen.ts
View File

@ -12,10 +12,16 @@ import {
/**
* Check if activation token is valid
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get = oc
.route({
description: 'Check if activation token is valid',
deprecated: true,
description:
'Check if activation token is valid\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getActivateCheck',

8
packages/contracts/generated/api/console/all-workspaces/orpc.gen.ts
View File

@ -5,8 +5,16 @@ import * as z from 'zod'
import { zGetAllWorkspacesQuery, zGetAllWorkspacesResponse } from './zod.gen'
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getAllWorkspaces',

2
packages/contracts/generated/api/console/api-based-extension/types.gen.ts
View File

@ -59,7 +59,7 @@ export type DeleteApiBasedExtensionByIdData = {
export type DeleteApiBasedExtensionByIdResponses = {
204: {
[key: string]: unknown
[key: string]: never
}
}

2
packages/contracts/generated/api/console/api-based-extension/zod.gen.ts
View File

@ -43,7 +43,7 @@ export const zDeleteApiBasedExtensionByIdPath = z.object({
/**
* Extension deleted successfully
*/
export const zDeleteApiBasedExtensionByIdResponse = z.record(z.string(), z.unknown())
export const zDeleteApiBasedExtensionByIdResponse = z.record(z.string(), z.never())
export const zGetApiBasedExtensionByIdPath = z.object({
id: z.string(),

24
packages/contracts/generated/api/console/api-key-auth/orpc.gen.ts
View File

@ -11,8 +11,16 @@ import {
zPostApiKeyAuthDataSourceBindingResponse,
} from './zod.gen'
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postApiKeyAuthDataSourceBinding',
@ -26,8 +34,16 @@ export const binding = {
post,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const delete_ = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'DELETE',
operationId: 'deleteApiKeyAuthDataSourceByBindingId',
@ -41,8 +57,16 @@ export const byBindingId = {
delete: delete_,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getApiKeyAuthDataSource',

8
packages/contracts/generated/api/console/app/orpc.gen.ts
View File

@ -7,10 +7,16 @@ import { zGetAppPromptTemplatesQuery, zGetAppPromptTemplatesResponse } from './z
/**
* Get advanced prompt templates based on app mode and model configuration
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get = oc
.route({
description: 'Get advanced prompt templates based on app mode and model configuration',
deprecated: true,
description:
'Get advanced prompt templates based on app mode and model configuration\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getAppPromptTemplates',

747
packages/contracts/generated/api/console/apps/orpc.gen.ts
View File

File diff suppressed because it is too large Load Diff

24
packages/contracts/generated/api/console/apps/types.gen.ts
View File

@ -1592,7 +1592,7 @@ export type DeleteAppsByAppIdError = DeleteAppsByAppIdErrors[keyof DeleteAppsByA
export type DeleteAppsByAppIdResponses = {
204: {
[key: string]: unknown
[key: string]: never
}
}
@ -2172,7 +2172,7 @@ export type PostAppsByAppIdAnnotationsByAnnotationIdError
export type PostAppsByAppIdAnnotationsByAnnotationIdResponses = {
200: Annotation
204: {
[key: string]: unknown
[key: string]: never
}
}
@ -2318,7 +2318,7 @@ export type DeleteAppsByAppIdChatConversationsByConversationIdError
export type DeleteAppsByAppIdChatConversationsByConversationIdResponses = {
204: {
[key: string]: unknown
[key: string]: never
}
}
@ -2484,7 +2484,7 @@ export type DeleteAppsByAppIdCompletionConversationsByConversationIdError
export type DeleteAppsByAppIdCompletionConversationsByConversationIdResponses = {
204: {
[key: string]: unknown
[key: string]: never
}
}
@ -3287,7 +3287,7 @@ export type DeleteAppsByAppIdTraceConfigError
export type DeleteAppsByAppIdTraceConfigResponses = {
204: {
[key: string]: unknown
[key: string]: never
}
}
@ -3662,7 +3662,7 @@ export type DeleteAppsByAppIdWorkflowCommentsByCommentIdData = {
export type DeleteAppsByAppIdWorkflowCommentsByCommentIdResponses = {
204: {
[key: string]: unknown
[key: string]: never
}
}
@ -3733,7 +3733,7 @@ export type DeleteAppsByAppIdWorkflowCommentsByCommentIdRepliesByReplyIdData = {
export type DeleteAppsByAppIdWorkflowCommentsByCommentIdRepliesByReplyIdResponses = {
204: {
[key: string]: unknown
[key: string]: never
}
}
@ -4307,7 +4307,7 @@ export type DeleteAppsByAppIdWorkflowsDraftNodesByNodeIdVariablesData = {
export type DeleteAppsByAppIdWorkflowsDraftNodesByNodeIdVariablesResponses = {
204: {
[key: string]: unknown
[key: string]: never
}
}
@ -4445,7 +4445,7 @@ export type DeleteAppsByAppIdWorkflowsDraftVariablesData = {
export type DeleteAppsByAppIdWorkflowsDraftVariablesResponses = {
204: {
[key: string]: unknown
[key: string]: never
}
}
@ -4492,7 +4492,7 @@ export type DeleteAppsByAppIdWorkflowsDraftVariablesByVariableIdError
export type DeleteAppsByAppIdWorkflowsDraftVariablesByVariableIdResponses = {
204: {
[key: string]: unknown
[key: string]: never
}
}
@ -4573,7 +4573,7 @@ export type PutAppsByAppIdWorkflowsDraftVariablesByVariableIdResetError
export type PutAppsByAppIdWorkflowsDraftVariablesByVariableIdResetResponses = {
200: WorkflowDraftVariable
204: {
[key: string]: unknown
[key: string]: never
}
}
@ -4766,7 +4766,7 @@ export type DeleteAppsByResourceIdApiKeysByApiKeyIdData = {
export type DeleteAppsByResourceIdApiKeysByApiKeyIdResponses = {
204: {
[key: string]: unknown
[key: string]: never
}
}

27
packages/contracts/generated/api/console/apps/zod.gen.ts
View File

@ -1920,7 +1920,7 @@ export const zDeleteAppsByAppIdPath = z.object({
/**
* App deleted successfully
*/
export const zDeleteAppsByAppIdResponse = z.record(z.string(), z.unknown())
export const zDeleteAppsByAppIdResponse = z.record(z.string(), z.never())
export const zGetAppsByAppIdPath = z.object({
app_id: z.string(),
@ -2209,7 +2209,7 @@ export const zPostAppsByAppIdAnnotationsByAnnotationIdPath = z.object({
export const zPostAppsByAppIdAnnotationsByAnnotationIdResponse = z.union([
zAnnotation,
z.record(z.string(), z.unknown()),
z.record(z.string(), z.never()),
])
export const zGetAppsByAppIdAnnotationsByAnnotationIdHitHistoriesPath = z.object({
@ -2280,7 +2280,7 @@ export const zDeleteAppsByAppIdChatConversationsByConversationIdPath = z.object(
*/
export const zDeleteAppsByAppIdChatConversationsByConversationIdResponse = z.record(
z.string(),
z.unknown(),
z.never(),
)
export const zGetAppsByAppIdChatConversationsByConversationIdPath = z.object({
@ -2357,7 +2357,7 @@ export const zDeleteAppsByAppIdCompletionConversationsByConversationIdPath = z.o
*/
export const zDeleteAppsByAppIdCompletionConversationsByConversationIdResponse = z.record(
z.string(),
z.unknown(),
z.never(),
)
export const zGetAppsByAppIdCompletionConversationsByConversationIdPath = z.object({
@ -2768,7 +2768,7 @@ export const zDeleteAppsByAppIdTraceConfigPath = z.object({
/**
* Tracing configuration deleted successfully
*/
export const zDeleteAppsByAppIdTraceConfigResponse = z.record(z.string(), z.unknown())
export const zDeleteAppsByAppIdTraceConfigResponse = z.record(z.string(), z.never())
export const zGetAppsByAppIdTraceConfigPath = z.object({
app_id: z.string(),
@ -2980,10 +2980,7 @@ export const zDeleteAppsByAppIdWorkflowCommentsByCommentIdPath = z.object({
/**
* Comment deleted successfully
*/
export const zDeleteAppsByAppIdWorkflowCommentsByCommentIdResponse = z.record(
z.string(),
z.unknown(),
)
export const zDeleteAppsByAppIdWorkflowCommentsByCommentIdResponse = z.record(z.string(), z.never())
export const zGetAppsByAppIdWorkflowCommentsByCommentIdPath = z.object({
app_id: z.string(),
@ -3031,7 +3028,7 @@ export const zDeleteAppsByAppIdWorkflowCommentsByCommentIdRepliesByReplyIdPath =
*/
export const zDeleteAppsByAppIdWorkflowCommentsByCommentIdRepliesByReplyIdResponse = z.record(
z.string(),
z.unknown(),
z.never(),
)
export const zPutAppsByAppIdWorkflowCommentsByCommentIdRepliesByReplyIdBody
@ -3376,7 +3373,7 @@ export const zDeleteAppsByAppIdWorkflowsDraftNodesByNodeIdVariablesPath = z.obje
*/
export const zDeleteAppsByAppIdWorkflowsDraftNodesByNodeIdVariablesResponse = z.record(
z.string(),
z.unknown(),
z.never(),
)
export const zGetAppsByAppIdWorkflowsDraftNodesByNodeIdVariablesPath = z.object({
@ -3439,7 +3436,7 @@ export const zDeleteAppsByAppIdWorkflowsDraftVariablesPath = z.object({
/**
* Workflow variables deleted successfully
*/
export const zDeleteAppsByAppIdWorkflowsDraftVariablesResponse = z.record(z.string(), z.unknown())
export const zDeleteAppsByAppIdWorkflowsDraftVariablesResponse = z.record(z.string(), z.never())
export const zGetAppsByAppIdWorkflowsDraftVariablesPath = z.object({
app_id: z.string(),
@ -3465,7 +3462,7 @@ export const zDeleteAppsByAppIdWorkflowsDraftVariablesByVariableIdPath = z.objec
*/
export const zDeleteAppsByAppIdWorkflowsDraftVariablesByVariableIdResponse = z.record(
z.string(),
z.unknown(),
z.never(),
)
export const zGetAppsByAppIdWorkflowsDraftVariablesByVariableIdPath = z.object({
@ -3498,7 +3495,7 @@ export const zPutAppsByAppIdWorkflowsDraftVariablesByVariableIdResetPath = z.obj
export const zPutAppsByAppIdWorkflowsDraftVariablesByVariableIdResetResponse = z.union([
zWorkflowDraftVariable,
z.record(z.string(), z.unknown()),
z.record(z.string(), z.never()),
])
export const zGetAppsByAppIdWorkflowsPublishPath = z.object({
@ -3597,7 +3594,7 @@ export const zDeleteAppsByResourceIdApiKeysByApiKeyIdPath = z.object({
/**
* API key deleted successfully
*/
export const zDeleteAppsByResourceIdApiKeysByApiKeyIdResponse = z.record(z.string(), z.unknown())
export const zDeleteAppsByResourceIdApiKeysByApiKeyIdResponse = z.record(z.string(), z.never())
export const zGetAppsByServerIdServerRefreshPath = z.object({
server_id: z.string(),

80
packages/contracts/generated/api/console/auth/orpc.gen.ts
View File

@ -30,8 +30,16 @@ import {
zPostAuthPluginDatasourceByProviderIdUpdateResponse,
} from './zod.gen'
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getAuthPluginDatasourceDefaultList',
@ -44,8 +52,16 @@ export const defaultList = {
get,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get2 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getAuthPluginDatasourceList',
@ -58,8 +74,16 @@ export const list = {
get: get2,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const delete_ = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'DELETE',
operationId: 'deleteAuthPluginDatasourceByProviderIdCustomClient',
@ -69,8 +93,16 @@ export const delete_ = oc
.input(z.object({ params: zDeleteAuthPluginDatasourceByProviderIdCustomClientPath }))
.output(zDeleteAuthPluginDatasourceByProviderIdCustomClientResponse)
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postAuthPluginDatasourceByProviderIdCustomClient',
@ -90,8 +122,16 @@ export const customClient = {
post,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post2 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postAuthPluginDatasourceByProviderIdDefault',
@ -110,8 +150,16 @@ export const default_ = {
post: post2,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post3 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postAuthPluginDatasourceByProviderIdDelete',
@ -130,8 +178,16 @@ export const delete2 = {
post: post3,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post4 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postAuthPluginDatasourceByProviderIdUpdate',
@ -150,8 +206,16 @@ export const update = {
post: post4,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post5 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postAuthPluginDatasourceByProviderIdUpdateName',
@ -170,8 +234,16 @@ export const updateName = {
post: post5,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get3 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getAuthPluginDatasourceByProviderId',
@ -181,8 +253,16 @@ export const get3 = oc
.input(z.object({ params: zGetAuthPluginDatasourceByProviderIdPath }))
.output(zGetAuthPluginDatasourceByProviderIdResponse)
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post6 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postAuthPluginDatasourceByProviderId',

24
packages/contracts/generated/api/console/billing/orpc.gen.ts
View File

@ -11,8 +11,16 @@ import {
zPutBillingPartnersByPartnerKeyTenantsResponse,
} from './zod.gen'
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getBillingInvoices',
@ -27,10 +35,16 @@ export const invoices = {
/**
* Sync partner tenants bindings
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const put = oc
.route({
description: 'Sync partner tenants bindings',
deprecated: true,
description:
'Sync partner tenants bindings\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'PUT',
operationId: 'putBillingPartnersByPartnerKeyTenants',
@ -57,8 +71,16 @@ export const partners = {
byPartnerKey,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get2 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getBillingSubscription',

8
packages/contracts/generated/api/console/compliance/orpc.gen.ts
View File

@ -7,10 +7,16 @@ import { zGetComplianceDownloadQuery, zGetComplianceDownloadResponse } from './z
/**
* Get compliance document download link
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get = oc
.route({
description: 'Get compliance document download link',
deprecated: true,
description:
'Get compliance document download link\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getComplianceDownload',

32
packages/contracts/generated/api/console/data-source/orpc.gen.ts
View File

@ -12,8 +12,16 @@ import {
zPatchDataSourceIntegratesResponse,
} from './zod.gen'
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDataSourceIntegratesByBindingIdByAction',
@ -23,8 +31,16 @@ export const get = oc
.input(z.object({ params: zGetDataSourceIntegratesByBindingIdByActionPath }))
.output(zGetDataSourceIntegratesByBindingIdByActionResponse)
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const patch = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'PATCH',
operationId: 'patchDataSourceIntegratesByBindingIdByAction',
@ -43,8 +59,16 @@ export const byBindingId = {
byAction,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get2 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDataSourceIntegrates',
@ -53,8 +77,16 @@ export const get2 = oc
})
.output(zGetDataSourceIntegratesResponse)
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const patch2 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'PATCH',
operationId: 'patchDataSourceIntegrates',

594
packages/contracts/generated/api/console/datasets/orpc.gen.ts
View File

File diff suppressed because it is too large Load Diff

4
packages/contracts/generated/api/console/datasets/types.gen.ts
View File

@ -720,7 +720,7 @@ export type DeleteDatasetsApiKeysByApiKeyIdData = {
export type DeleteDatasetsApiKeysByApiKeyIdResponses = {
204: {
[key: string]: unknown
[key: string]: never
}
}
@ -2303,7 +2303,7 @@ export type DeleteDatasetsByResourceIdApiKeysByApiKeyIdData = {
export type DeleteDatasetsByResourceIdApiKeysByApiKeyIdResponses = {
204: {
[key: string]: unknown
[key: string]: never
}
}

7
packages/contracts/generated/api/console/datasets/zod.gen.ts
View File

@ -796,7 +796,7 @@ export const zDeleteDatasetsApiKeysByApiKeyIdPath = z.object({
/**
* API key deleted successfully
*/
export const zDeleteDatasetsApiKeysByApiKeyIdResponse = z.record(z.string(), z.unknown())
export const zDeleteDatasetsApiKeysByApiKeyIdResponse = z.record(z.string(), z.never())
export const zGetDatasetsBatchImportStatusByJobIdPath = z.object({
job_id: z.string(),
@ -1672,7 +1672,4 @@ export const zDeleteDatasetsByResourceIdApiKeysByApiKeyIdPath = z.object({
/**
* API key deleted successfully
*/
export const zDeleteDatasetsByResourceIdApiKeysByApiKeyIdResponse = z.record(
z.string(),
z.unknown(),
)
export const zDeleteDatasetsByResourceIdApiKeysByApiKeyIdResponse = z.record(z.string(), z.never())

16
packages/contracts/generated/api/console/email-code-login/orpc.gen.ts
View File

@ -10,8 +10,16 @@ import {
zPostEmailCodeLoginValidityResponse,
} from './zod.gen'
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postEmailCodeLoginValidity',
@ -25,8 +33,16 @@ export const validity = {
post,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post2 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postEmailCodeLogin',

24
packages/contracts/generated/api/console/email-register/orpc.gen.ts
View File

@ -8,8 +8,16 @@ import {
zPostEmailRegisterValidityResponse,
} from './zod.gen'
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postEmailRegisterSendEmail',
@ -22,8 +30,16 @@ export const sendEmail = {
post,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post2 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postEmailRegisterValidity',
@ -36,8 +52,16 @@ export const validity = {
post: post2,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post3 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postEmailRegister',

15
packages/contracts/generated/api/console/explore/orpc.gen.ts
View File

@ -11,8 +11,16 @@ import {
zGetExploreBannersResponse,
} from './zod.gen'
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getExploreAppsByAppId',
@ -44,9 +52,16 @@ export const apps = {
/**
* Get banner list
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get3 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getExploreBanners',

8
packages/contracts/generated/api/console/features/orpc.gen.ts
View File

@ -8,10 +8,16 @@ import { zGetFeaturesResponse } from './zod.gen'
* Get feature configuration for current tenant
*
* Get feature configuration for current tenant
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get = oc
.route({
description: 'Get feature configuration for current tenant',
deprecated: true,
description:
'Get feature configuration for current tenant\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getFeatures',

16
packages/contracts/generated/api/console/files/orpc.gen.ts
View File

@ -11,8 +11,16 @@ import {
zPostFilesUploadResponse,
} from './zod.gen'
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getFilesSupportType',
@ -51,8 +59,16 @@ export const upload = {
post,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get3 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getFilesByFileIdPreview',

15
packages/contracts/generated/api/console/form/orpc.gen.ts
View File

@ -14,10 +14,16 @@ import {
* Get human input form definition by form token
*
* GET /console/api/form/human_input/<form_token>
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get = oc
.route({
description: 'GET /console/api/form/human_input/<form_token>',
deprecated: true,
description:
'GET /console/api/form/human_input/<form_token>\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getFormHumanInputByFormToken',
@ -40,11 +46,16 @@ export const get = oc
* },
* "action": "Approve"
* }
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post = oc
.route({
deprecated: true,
description:
'POST /console/api/form/human_input/<form_token>\n\nRequest body:\n{\n "inputs": {\n "content": "User input content"\n },\n "action": "Approve"\n}',
'POST /console/api/form/human_input/<form_token>\n\nRequest body:\n{\n "inputs": {\n "content": "User input content"\n },\n "action": "Approve"\n}\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postFormHumanInputByFormToken',

8
packages/contracts/generated/api/console/info/orpc.gen.ts
View File

@ -4,8 +4,16 @@ import { oc } from '@orpc/contract'
import { zPostInfoResponse } from './zod.gen'
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postInfo',

196
packages/contracts/generated/api/console/installed-apps/orpc.gen.ts
View File

@ -67,8 +67,16 @@ import {
zPostInstalledAppsResponse,
} from './zod.gen'
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postInstalledAppsByInstalledAppIdAudioToText',
@ -82,8 +90,16 @@ export const audioToText = {
post,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post2 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postInstalledAppsByInstalledAppIdChatMessagesByTaskIdStop',
@ -101,8 +117,16 @@ export const byTaskId = {
stop,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post3 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postInstalledAppsByInstalledAppIdChatMessages',
@ -122,8 +146,16 @@ export const chatMessages = {
byTaskId,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post4 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postInstalledAppsByInstalledAppIdCompletionMessagesByTaskIdStop',
@ -141,8 +173,16 @@ export const byTaskId2 = {
stop: stop2,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post5 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postInstalledAppsByInstalledAppIdCompletionMessages',
@ -162,8 +202,16 @@ export const completionMessages = {
byTaskId: byTaskId2,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post6 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postInstalledAppsByInstalledAppIdConversationsByCIdName',
@ -182,8 +230,16 @@ export const name = {
post: post6,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const patch = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'PATCH',
operationId: 'patchInstalledAppsByInstalledAppIdConversationsByCIdPin',
@ -197,8 +253,16 @@ export const pin = {
patch,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const patch2 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'PATCH',
operationId: 'patchInstalledAppsByInstalledAppIdConversationsByCIdUnpin',
@ -212,8 +276,16 @@ export const unpin = {
patch: patch2,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const delete_ = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'DELETE',
operationId: 'deleteInstalledAppsByInstalledAppIdConversationsByCId',
@ -230,8 +302,16 @@ export const byCId = {
unpin,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getInstalledAppsByInstalledAppIdConversations',
@ -251,8 +331,16 @@ export const conversations = {
byCId,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post7 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postInstalledAppsByInstalledAppIdMessagesByMessageIdFeedbacks',
@ -271,8 +359,16 @@ export const feedbacks = {
post: post7,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get2 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getInstalledAppsByInstalledAppIdMessagesByMessageIdMoreLikeThis',
@ -291,8 +387,16 @@ export const moreLikeThis = {
get: get2,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get3 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getInstalledAppsByInstalledAppIdMessagesByMessageIdSuggestedQuestions',
@ -316,8 +420,16 @@ export const byMessageId = {
suggestedQuestions,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get4 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getInstalledAppsByInstalledAppIdMessages',
@ -339,9 +451,16 @@ export const messages = {
/**
* Get app meta
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get5 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getInstalledAppsByInstalledAppIdMeta',
@ -358,9 +477,16 @@ export const meta = {
/**
* Retrieve app parameters
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get6 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getInstalledAppsByInstalledAppIdParameters',
@ -375,8 +501,16 @@ export const parameters = {
get: get6,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const delete2 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'DELETE',
operationId: 'deleteInstalledAppsByInstalledAppIdSavedMessagesByMessageId',
@ -390,8 +524,16 @@ export const byMessageId2 = {
delete: delete2,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get7 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getInstalledAppsByInstalledAppIdSavedMessages',
@ -406,8 +548,16 @@ export const get7 = oc
)
.output(zGetInstalledAppsByInstalledAppIdSavedMessagesResponse)
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post8 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postInstalledAppsByInstalledAppIdSavedMessages',
@ -428,8 +578,16 @@ export const savedMessages = {
byMessageId: byMessageId2,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post9 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postInstalledAppsByInstalledAppIdTextToAudio',
@ -450,9 +608,16 @@ export const textToAudio = {
/**
* Run workflow
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post10 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postInstalledAppsByInstalledAppIdWorkflowsRun',
@ -474,9 +639,16 @@ export const run = {
/**
* Stop workflow task
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post11 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postInstalledAppsByInstalledAppIdWorkflowsTasksByTaskIdStop',
@ -504,8 +676,16 @@ export const workflows = {
tasks,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const delete3 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'DELETE',
operationId: 'deleteInstalledAppsByInstalledAppId',
@ -515,8 +695,16 @@ export const delete3 = oc
.input(z.object({ params: zDeleteInstalledAppsByInstalledAppIdPath }))
.output(zDeleteInstalledAppsByInstalledAppIdResponse)
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const patch3 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'PATCH',
operationId: 'patchInstalledAppsByInstalledAppId',
@ -551,8 +739,16 @@ export const get8 = oc
})
.output(zGetInstalledAppsResponse)
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post12 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postInstalledApps',

16
packages/contracts/generated/api/console/instruction-generate/orpc.gen.ts
View File

@ -12,10 +12,16 @@ import {
/**
* Get instruction generation template
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post = oc
.route({
description: 'Get instruction generation template',
deprecated: true,
description:
'Get instruction generation template\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postInstructionGenerateTemplate',
@ -31,10 +37,16 @@ export const template = {
/**
* Generate instruction for workflow nodes or general use
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post2 = oc
.route({
description: 'Generate instruction for workflow nodes or general use',
deprecated: true,
description:
'Generate instruction for workflow nodes or general use\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postInstructionGenerate',

7
packages/contracts/generated/api/console/login/orpc.gen.ts
View File

@ -7,9 +7,16 @@ import { zPostLoginBody, zPostLoginResponse } from './zod.gen'
/**
* Authenticate user and login
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postLogin',

8
packages/contracts/generated/api/console/logout/orpc.gen.ts
View File

@ -4,8 +4,16 @@ import { oc } from '@orpc/contract'
import { zPostLogoutResponse } from './zod.gen'
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postLogout',

8
packages/contracts/generated/api/console/mcp/orpc.gen.ts
View File

@ -4,8 +4,16 @@ import { oc } from '@orpc/contract'
import { zGetMcpOauthCallbackResponse } from './zod.gen'
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getMcpOauthCallback',

15
packages/contracts/generated/api/console/notification/orpc.gen.ts
View File

@ -6,10 +6,16 @@ import { zGetNotificationResponse, zPostNotificationDismissResponse } from './zo
/**
* Mark a notification as dismissed for the current user.
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post = oc
.route({
description: 'Mark a notification as dismissed for the current user.',
deprecated: true,
description:
'Mark a notification as dismissed for the current user.\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postNotificationDismiss',
@ -24,11 +30,16 @@ export const dismiss = {
/**
* Return the active in-product notification for the current user in their interface language (falls back to English if unavailable). The notification is NOT marked as seen here; call POST /notification/dismiss when the user explicitly closes the modal.
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get = oc
.route({
deprecated: true,
description:
'Return the active in-product notification for the current user in their interface language (falls back to English if unavailable). The notification is NOT marked as seen here; call POST /notification/dismiss when the user explicitly closes the modal.',
'Return the active in-product notification for the current user in their interface language (falls back to English if unavailable). The notification is NOT marked as seen here; call POST /notification/dismiss when the user explicitly closes the modal.\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getNotification',

24
packages/contracts/generated/api/console/notion/orpc.gen.ts
View File

@ -12,8 +12,16 @@ import {
zPostNotionPagesByPageIdByPageTypePreviewResponse,
} from './zod.gen'
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getNotionPagesByPageIdByPageTypePreview',
@ -23,8 +31,16 @@ export const get = oc
.input(z.object({ params: zGetNotionPagesByPageIdByPageTypePreviewPath }))
.output(zGetNotionPagesByPageIdByPageTypePreviewResponse)
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postNotionPagesByPageIdByPageTypePreview',
@ -56,8 +72,16 @@ export const pages = {
byPageId,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get2 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getNotionPreImportPages',

95
packages/contracts/generated/api/console/oauth/orpc.gen.ts
View File

@ -38,10 +38,16 @@ import {
/**
* Handle OAuth callback and complete login process
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get = oc
.route({
description: 'Handle OAuth callback and complete login process',
deprecated: true,
description:
'Handle OAuth callback and complete login process\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getOauthAuthorizeByProvider',
@ -94,10 +100,16 @@ export const binding = {
/**
* Handle OAuth callback from data source provider
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get3 = oc
.route({
description: 'Handle OAuth callback from data source provider',
deprecated: true,
description:
'Handle OAuth callback from data source provider\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getOauthDataSourceCallbackByProvider',
@ -171,10 +183,16 @@ export const dataSource = {
/**
* Initiate OAuth login process
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get6 = oc
.route({
description: 'Initiate OAuth login process',
deprecated: true,
description:
'Initiate OAuth login process\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getOauthLoginByProvider',
@ -197,8 +215,16 @@ export const login = {
byProvider: byProvider5,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get7 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getOauthPluginByProviderIdDatasourceCallback',
@ -212,8 +238,16 @@ export const callback2 = {
get: get7,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get8 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getOauthPluginByProviderIdDatasourceGetAuthorizationUrl',
@ -236,8 +270,16 @@ export const byProviderId = {
datasource,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get9 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getOauthPluginByProviderToolAuthorizationUrl',
@ -251,8 +293,16 @@ export const authorizationUrl = {
get: get9,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get10 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getOauthPluginByProviderToolCallback',
@ -273,9 +323,16 @@ export const tool = {
/**
* Handle OAuth callback for trigger provider
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get11 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getOauthPluginByProviderTriggerCallback',
@ -304,8 +361,16 @@ export const plugin = {
byProvider: byProvider6,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postOauthProviderAccount',
@ -318,8 +383,16 @@ export const account = {
post,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post2 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postOauthProviderAuthorize',
@ -332,8 +405,16 @@ export const authorize2 = {
post: post2,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post3 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postOauthProviderToken',
@ -346,8 +427,16 @@ export const token = {
post: post3,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post4 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postOauthProvider',

95
packages/contracts/generated/api/console/orpc.gen.ts Normal file
View File

@ -0,0 +1,95 @@
// This file is auto-generated by @hey-api/openapi-ts
import { account } from './account/orpc.gen'
import { activate } from './activate/orpc.gen'
import { allWorkspaces } from './all-workspaces/orpc.gen'
import { apiBasedExtension } from './api-based-extension/orpc.gen'
import { apiKeyAuth } from './api-key-auth/orpc.gen'
import { app } from './app/orpc.gen'
import { apps } from './apps/orpc.gen'
import { auth } from './auth/orpc.gen'
import { billing } from './billing/orpc.gen'
import { codeBasedExtension } from './code-based-extension/orpc.gen'
import { compliance } from './compliance/orpc.gen'
import { dataSource } from './data-source/orpc.gen'
import { datasets } from './datasets/orpc.gen'
import { emailCodeLogin } from './email-code-login/orpc.gen'
import { emailRegister } from './email-register/orpc.gen'
import { explore } from './explore/orpc.gen'
import { features } from './features/orpc.gen'
import { files } from './files/orpc.gen'
import { forgotPassword } from './forgot-password/orpc.gen'
import { form } from './form/orpc.gen'
import { info } from './info/orpc.gen'
import { installedApps } from './installed-apps/orpc.gen'
import { instructionGenerate } from './instruction-generate/orpc.gen'
import { login } from './login/orpc.gen'
import { logout } from './logout/orpc.gen'
import { mcp } from './mcp/orpc.gen'
import { notification } from './notification/orpc.gen'
import { notion } from './notion/orpc.gen'
import { oauth } from './oauth/orpc.gen'
import { rag } from './rag/orpc.gen'
import { refreshToken } from './refresh-token/orpc.gen'
import { remoteFiles } from './remote-files/orpc.gen'
import { resetPassword } from './reset-password/orpc.gen'
import { ruleCodeGenerate } from './rule-code-generate/orpc.gen'
import { ruleGenerate } from './rule-generate/orpc.gen'
import { ruleStructuredOutputGenerate } from './rule-structured-output-generate/orpc.gen'
import { spec } from './spec/orpc.gen'
import { systemFeatures } from './system-features/orpc.gen'
import { tagBindings } from './tag-bindings/orpc.gen'
import { tags } from './tags/orpc.gen'
import { test } from './test/orpc.gen'
import { trialApps } from './trial-apps/orpc.gen'
import { website } from './website/orpc.gen'
import { workflow } from './workflow/orpc.gen'
import { workspaces } from './workspaces/orpc.gen'
export const contract = {
account,
activate,
allWorkspaces,
apiBasedExtension,
apiKeyAuth,
app,
apps,
auth,
billing,
codeBasedExtension,
compliance,
dataSource,
datasets,
emailCodeLogin,
emailRegister,
explore,
features,
files,
forgotPassword,
form,
info,
installedApps,
instructionGenerate,
login,
logout,
mcp,
notification,
notion,
oauth,
rag,
refreshToken,
remoteFiles,
resetPassword,
ruleCodeGenerate,
ruleGenerate,
ruleStructuredOutputGenerate,
spec,
systemFeatures,
tagBindings,
tags,
test,
trialApps,
website,
workflow,
workspaces,
}

369
packages/contracts/generated/api/console/rag/orpc.gen.ts
View File

@ -118,8 +118,16 @@ import {
zPutRagPipelinesByPipelineIdWorkflowsDraftVariablesByVariableIdResetResponse,
} from './zod.gen'
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const delete_ = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'DELETE',
operationId: 'deleteRagPipelineCustomizedTemplatesByTemplateId',
@ -129,8 +137,16 @@ export const delete_ = oc
.input(z.object({ params: zDeleteRagPipelineCustomizedTemplatesByTemplateIdPath }))
.output(zDeleteRagPipelineCustomizedTemplatesByTemplateIdResponse)
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const patch = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'PATCH',
operationId: 'patchRagPipelineCustomizedTemplatesByTemplateId',
@ -140,8 +156,16 @@ export const patch = oc
.input(z.object({ params: zPatchRagPipelineCustomizedTemplatesByTemplateIdPath }))
.output(zPatchRagPipelineCustomizedTemplatesByTemplateIdResponse)
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postRagPipelineCustomizedTemplatesByTemplateId',
@ -165,8 +189,16 @@ export const customized = {
templates,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post2 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postRagPipelineDataset',
@ -180,8 +212,16 @@ export const dataset = {
post: post2,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post3 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postRagPipelineEmptyDataset',
@ -194,8 +234,16 @@ export const emptyDataset = {
post: post3,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getRagPipelineTemplatesByTemplateId',
@ -209,8 +257,16 @@ export const byTemplateId2 = {
get,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get2 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getRagPipelineTemplates',
@ -231,8 +287,16 @@ export const pipeline = {
templates: templates2,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get3 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getRagPipelinesDatasourcePlugins',
@ -245,8 +309,16 @@ export const datasourcePlugins = {
get: get3,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post4 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postRagPipelinesImportsByImportIdConfirm',
@ -264,8 +336,16 @@ export const byImportId = {
confirm,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get4 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getRagPipelinesImportsByPipelineIdCheckDependencies',
@ -283,8 +363,16 @@ export const byPipelineId = {
checkDependencies,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post5 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postRagPipelinesImports',
@ -300,8 +388,16 @@ export const imports = {
byPipelineId,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get5 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getRagPipelinesRecommendedPlugins',
@ -314,8 +410,16 @@ export const recommendedPlugins = {
get: get5,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post6 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postRagPipelinesTransformDatasetsByDatasetId',
@ -337,8 +441,16 @@ export const transform = {
datasets,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post7 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postRagPipelinesByPipelineIdCustomizedPublish',
@ -361,8 +473,16 @@ export const customized2 = {
publish,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get6 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getRagPipelinesByPipelineIdExports',
@ -378,9 +498,16 @@ export const exports_ = {
/**
* Stop workflow task
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post8 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postRagPipelinesByPipelineIdWorkflowRunsTasksByTaskIdStop',
@ -465,9 +592,16 @@ export const workflowRuns = {
/**
* Get default block config
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get10 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getRagPipelinesByPipelineIdWorkflowsDefaultWorkflowBlockConfigsByBlockType',
@ -488,9 +622,16 @@ export const byBlockType = {
/**
* Get default block config
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get11 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getRagPipelinesByPipelineIdWorkflowsDefaultWorkflowBlockConfigs',
@ -508,9 +649,16 @@ export const defaultWorkflowBlockConfigs = {
/**
* Run rag pipeline datasource
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post9 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postRagPipelinesByPipelineIdWorkflowsDraftDatasourceNodesByNodeIdRun',
@ -540,9 +688,16 @@ export const nodes = {
/**
* Set datasource variables
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post10 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postRagPipelinesByPipelineIdWorkflowsDraftDatasourceVariablesInspect',
@ -567,8 +722,16 @@ export const datasource = {
variablesInspect,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get12 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getRagPipelinesByPipelineIdWorkflowsDraftEnvironmentVariables',
@ -584,9 +747,16 @@ export const environmentVariables = {
/**
* Run draft workflow iteration node
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post11 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postRagPipelinesByPipelineIdWorkflowsDraftIterationNodesByNodeIdRun',
@ -620,9 +790,16 @@ export const iteration = {
/**
* Run draft workflow loop node
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post12 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postRagPipelinesByPipelineIdWorkflowsDraftLoopNodesByNodeIdRun',
@ -671,9 +848,16 @@ export const lastRun = {
/**
* Run draft workflow node
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post13 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postRagPipelinesByPipelineIdWorkflowsDraftNodesByNodeIdRun',
@ -693,8 +877,16 @@ export const run4 = {
post: post13,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const delete2 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'DELETE',
operationId: 'deleteRagPipelinesByPipelineIdWorkflowsDraftNodesByNodeIdVariables',
@ -706,8 +898,16 @@ export const delete2 = oc
)
.output(zDeleteRagPipelinesByPipelineIdWorkflowsDraftNodesByNodeIdVariablesResponse)
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get14 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getRagPipelinesByPipelineIdWorkflowsDraftNodesByNodeIdVariables',
@ -734,9 +934,16 @@ export const nodes4 = {
/**
* Get first step parameters of rag pipeline
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get15 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getRagPipelinesByPipelineIdWorkflowsDraftPreProcessingParameters',
@ -759,9 +966,16 @@ export const preProcessing = {
/**
* Get second step parameters of rag pipeline
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get16 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getRagPipelinesByPipelineIdWorkflowsDraftProcessingParameters',
@ -782,9 +996,16 @@ export const processing = {
/**
* Run draft workflow
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post14 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postRagPipelinesByPipelineIdWorkflowsDraftRun',
@ -804,8 +1025,16 @@ export const run5 = {
post: post14,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get17 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getRagPipelinesByPipelineIdWorkflowsDraftSystemVariables',
@ -819,8 +1048,16 @@ export const systemVariables = {
get: get17,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const put = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'PUT',
operationId: 'putRagPipelinesByPipelineIdWorkflowsDraftVariablesByVariableIdReset',
@ -836,8 +1073,16 @@ export const reset = {
put,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const delete3 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'DELETE',
operationId: 'deleteRagPipelinesByPipelineIdWorkflowsDraftVariablesByVariableId',
@ -849,8 +1094,16 @@ export const delete3 = oc
)
.output(zDeleteRagPipelinesByPipelineIdWorkflowsDraftVariablesByVariableIdResponse)
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get18 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getRagPipelinesByPipelineIdWorkflowsDraftVariablesByVariableId',
@ -860,8 +1113,16 @@ export const get18 = oc
.input(z.object({ params: zGetRagPipelinesByPipelineIdWorkflowsDraftVariablesByVariableIdPath }))
.output(zGetRagPipelinesByPipelineIdWorkflowsDraftVariablesByVariableIdResponse)
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const patch2 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'PATCH',
operationId: 'patchRagPipelinesByPipelineIdWorkflowsDraftVariablesByVariableId',
@ -880,8 +1141,16 @@ export const byVariableId = {
reset,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const delete4 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'DELETE',
operationId: 'deleteRagPipelinesByPipelineIdWorkflowsDraftVariables',
@ -891,8 +1160,16 @@ export const delete4 = oc
.input(z.object({ params: zDeleteRagPipelinesByPipelineIdWorkflowsDraftVariablesPath }))
.output(zDeleteRagPipelinesByPipelineIdWorkflowsDraftVariablesResponse)
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get19 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getRagPipelinesByPipelineIdWorkflowsDraftVariables',
@ -910,9 +1187,16 @@ export const variables2 = {
/**
* Get draft rag pipeline's workflow
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get20 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getRagPipelinesByPipelineIdWorkflowsDraft',
@ -925,9 +1209,16 @@ export const get20 = oc
/**
* Sync draft workflow
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post15 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postRagPipelinesByPipelineIdWorkflowsDraft',
@ -955,9 +1246,16 @@ export const draft = {
/**
* Get published pipeline
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get21 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getRagPipelinesByPipelineIdWorkflowsPublish',
@ -970,9 +1268,16 @@ export const get21 = oc
/**
* Publish workflow
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post16 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postRagPipelinesByPipelineIdWorkflowsPublish',
@ -990,9 +1295,16 @@ export const publish2 = {
/**
* Run datasource content preview
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post17 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postRagPipelinesByPipelineIdWorkflowsPublishedDatasourceNodesByNodeIdPreview',
@ -1014,9 +1326,16 @@ export const preview = {
/**
* Run rag pipeline datasource
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post18 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postRagPipelinesByPipelineIdWorkflowsPublishedDatasourceNodesByNodeIdRun',
@ -1051,9 +1370,16 @@ export const datasource2 = {
/**
* Get first step parameters of rag pipeline
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get22 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getRagPipelinesByPipelineIdWorkflowsPublishedPreProcessingParameters',
@ -1076,9 +1402,16 @@ export const preProcessing2 = {
/**
* Get second step parameters of rag pipeline
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get23 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getRagPipelinesByPipelineIdWorkflowsPublishedProcessingParameters',
@ -1101,9 +1434,16 @@ export const processing2 = {
/**
* Run published workflow
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post19 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postRagPipelinesByPipelineIdWorkflowsPublishedRun',
@ -1130,8 +1470,16 @@ export const published = {
run: run7,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post20 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postRagPipelinesByPipelineIdWorkflowsByWorkflowIdRestore',
@ -1147,9 +1495,16 @@ export const restore = {
/**
* Delete a published workflow version that is not currently active on the pipeline
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const delete5 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'DELETE',
operationId: 'deleteRagPipelinesByPipelineIdWorkflowsByWorkflowId',
@ -1162,9 +1517,16 @@ export const delete5 = oc
/**
* Update workflow attributes
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const patch3 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'PATCH',
operationId: 'patchRagPipelinesByPipelineIdWorkflowsByWorkflowId',
@ -1183,9 +1545,16 @@ export const byWorkflowId = {
/**
* Get published workflows
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get24 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getRagPipelinesByPipelineIdWorkflows',

8
packages/contracts/generated/api/console/refresh-token/orpc.gen.ts
View File

@ -4,8 +4,16 @@ import { oc } from '@orpc/contract'
import { zPostRefreshTokenResponse } from './zod.gen'
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postRefreshToken',

16
packages/contracts/generated/api/console/remote-files/orpc.gen.ts
View File

@ -9,8 +9,16 @@ import {
zPostRemoteFilesUploadResponse,
} from './zod.gen'
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postRemoteFilesUpload',
@ -23,8 +31,16 @@ export const upload = {
post,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getRemoteFilesByUrl',

8
packages/contracts/generated/api/console/reset-password/orpc.gen.ts
View File

@ -5,8 +5,16 @@ import * as z from 'zod'
import { zPostResetPasswordBody, zPostResetPasswordResponse } from './zod.gen'
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postResetPassword',

8
packages/contracts/generated/api/console/rule-code-generate/orpc.gen.ts
View File

@ -7,10 +7,16 @@ import { zPostRuleCodeGenerateBody, zPostRuleCodeGenerateResponse } from './zod.
/**
* Generate code rules using LLM
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post = oc
.route({
description: 'Generate code rules using LLM',
deprecated: true,
description:
'Generate code rules using LLM\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postRuleCodeGenerate',

8
packages/contracts/generated/api/console/rule-generate/orpc.gen.ts
View File

@ -7,10 +7,16 @@ import { zPostRuleGenerateBody, zPostRuleGenerateResponse } from './zod.gen'
/**
* Generate rule configuration using LLM
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post = oc
.route({
description: 'Generate rule configuration using LLM',
deprecated: true,
description:
'Generate rule configuration using LLM\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postRuleGenerate',

8
packages/contracts/generated/api/console/rule-structured-output-generate/orpc.gen.ts
View File

@ -10,10 +10,16 @@ import {
/**
* Generate structured output rules using LLM
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post = oc
.route({
description: 'Generate structured output rules using LLM',
deprecated: true,
description:
'Generate structured output rules using LLM\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postRuleStructuredOutputGenerate',

8
packages/contracts/generated/api/console/spec/orpc.gen.ts
View File

@ -8,10 +8,16 @@ import { zGetSpecSchemaDefinitionsResponse } from './zod.gen'
* Get system JSON Schema definitions specification
*
* Used for frontend component type mapping
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get = oc
.route({
description: 'Used for frontend component type mapping',
deprecated: true,
description:
'Used for frontend component type mapping\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getSpecSchemaDefinitions',

7
packages/contracts/generated/api/console/system-features/orpc.gen.ts
View File

@ -14,11 +14,16 @@ import { zGetSystemFeaturesResponse } from './zod.gen'
* Authentication would create circular dependency (can't login without dashboard loading).
*
* Only non-sensitive configuration data should be returned by this endpoint.
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get = oc
.route({
deprecated: true,
description:
'Get system-wide feature configuration\nNOTE: This endpoint is unauthenticated by design, as it provides system features\ndata required for dashboard initialization.\n\nAuthentication would create circular dependency (can\'t login without dashboard loading).\n\nOnly non-sensitive configuration data should be returned by this endpoint.',
'Get system-wide feature configuration\nNOTE: This endpoint is unauthenticated by design, as it provides system features\ndata required for dashboard initialization.\n\nAuthentication would create circular dependency (can\'t login without dashboard loading).\n\nOnly non-sensitive configuration data should be returned by this endpoint.\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getSystemFeatures',

16
packages/contracts/generated/api/console/tag-bindings/orpc.gen.ts
View File

@ -12,10 +12,16 @@ import {
/**
* Remove one or more tag bindings from a target.
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post = oc
.route({
description: 'Remove one or more tag bindings from a target.',
deprecated: true,
description:
'Remove one or more tag bindings from a target.\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postTagBindingsRemove',
@ -29,8 +35,16 @@ export const remove = {
post,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post2 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postTagBindings',

24
packages/contracts/generated/api/console/tags/orpc.gen.ts
View File

@ -15,8 +15,16 @@ import {
zPostTagsResponse,
} from './zod.gen'
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const delete_ = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'DELETE',
operationId: 'deleteTagsByTagId',
@ -26,8 +34,16 @@ export const delete_ = oc
.input(z.object({ params: zDeleteTagsByTagIdPath }))
.output(zDeleteTagsByTagIdResponse)
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const patch = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'PATCH',
operationId: 'patchTagsByTagId',
@ -53,8 +69,16 @@ export const get = oc
.input(z.object({ query: zGetTagsQuery.optional() }))
.output(zGetTagsResponse)
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postTags',

8
packages/contracts/generated/api/console/test/orpc.gen.ts
View File

@ -7,10 +7,16 @@ import { zPostTestRetrievalBody, zPostTestRetrievalResponse } from './zod.gen'
/**
* Bedrock retrieval test (internal use only)
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post = oc
.route({
description: 'Bedrock retrieval test (internal use only)',
deprecated: true,
description:
'Bedrock retrieval test (internal use only)\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postTestRetrieval',

90
packages/contracts/generated/api/console/trial-apps/orpc.gen.ts
View File

@ -34,8 +34,16 @@ import {
zPostTrialAppsByAppIdWorkflowsTasksByTaskIdStopResponse,
} from './zod.gen'
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postTrialAppsByAppIdAudioToText',
@ -49,8 +57,16 @@ export const audioToText = {
post,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post2 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postTrialAppsByAppIdChatMessages',
@ -69,8 +85,16 @@ export const chatMessages = {
post: post2,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post3 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postTrialAppsByAppIdCompletionMessages',
@ -89,8 +113,16 @@ export const completionMessages = {
post: post3,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getTrialAppsByAppIdDatasets',
@ -104,8 +136,16 @@ export const datasets = {
get,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get2 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getTrialAppsByAppIdMessagesByMessageIdSuggestedQuestions',
@ -129,9 +169,16 @@ export const messages = {
/**
* Retrieve app parameters
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get3 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getTrialAppsByAppIdParameters',
@ -150,11 +197,16 @@ export const parameters = {
* Retrieve app site info
*
* Returns the site configuration for the application including theme, icons, and text.
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get4 = oc
.route({
deprecated: true,
description:
'Returns the site configuration for the application including theme, icons, and text.',
'Returns the site configuration for the application including theme, icons, and text.\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getTrialAppsByAppIdSite',
@ -169,8 +221,16 @@ export const site = {
get: get4,
}
/**
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post4 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postTrialAppsByAppIdTextToAudio',
@ -191,9 +251,16 @@ export const textToAudio = {
/**
* Run workflow
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post5 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postTrialAppsByAppIdWorkflowsRun',
@ -215,9 +282,16 @@ export const run = {
/**
* Stop workflow task
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post6 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postTrialAppsByAppIdWorkflowsTasksByTaskIdStop',
@ -242,9 +316,16 @@ export const tasks = {
/**
* Get workflow detail
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get5 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getTrialAppsByAppIdWorkflows',
@ -263,9 +344,16 @@ export const workflows = {
/**
* Get app detail
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get6 = oc
.route({
deprecated: true,
description:
'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getTrialAppsByAppId',

16
packages/contracts/generated/api/console/website/orpc.gen.ts
View File

@ -13,10 +13,16 @@ import {
/**
* Get website crawl status
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get = oc
.route({
description: 'Get website crawl status',
deprecated: true,
description:
'Get website crawl status\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getWebsiteCrawlStatusByJobId',
@ -41,10 +47,16 @@ export const status = {
/**
* Crawl website content
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post = oc
.route({
description: 'Crawl website content',
deprecated: true,
description:
'Crawl website content\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postWebsiteCrawl',

7
packages/contracts/generated/api/console/workflow/orpc.gen.ts
View File

@ -16,11 +16,16 @@ import {
* GET /console/api/workflow/<workflow_run_id>/events
*
* Returns Server-Sent Events stream.
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get = oc
.route({
deprecated: true,
description:
'GET /console/api/workflow/<workflow_run_id>/events\n\nReturns Server-Sent Events stream.',
'GET /console/api/workflow/<workflow_run_id>/events\n\nReturns Server-Sent Events stream.\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getWorkflowByWorkflowRunIdEvents',

1046
packages/contracts/generated/api/console/workspaces/orpc.gen.ts
View File

File diff suppressed because it is too large Load Diff

17
packages/contracts/generated/api/readiness.json Normal file
View File

@ -0,0 +1,17 @@
{
"surfaces": {
"console": {
"notReady": 475,
"total": 570
},
"service": {
"notReady": 72,
"total": 88
},
"web": {
"notReady": 36,
"total": 41
}
},
"warning": "Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate."
}

536
packages/contracts/generated/api/service/orpc.gen.ts
View File

File diff suppressed because it is too large Load Diff

20
packages/contracts/generated/api/service/types.gen.ts
View File

@ -694,7 +694,7 @@ export type DeleteAppsAnnotationsByAnnotationIdError
export type DeleteAppsAnnotationsByAnnotationIdResponses = {
204: {
[key: string]: unknown
[key: string]: never
}
}
@ -949,7 +949,7 @@ export type DeleteConversationsByCIdError
export type DeleteConversationsByCIdResponses = {
204: {
[key: string]: unknown
[key: string]: never
}
}
@ -1153,7 +1153,7 @@ export type DeleteDatasetsTagsError = DeleteDatasetsTagsErrors[keyof DeleteDatas
export type DeleteDatasetsTagsResponses = {
204: {
[key: string]: unknown
[key: string]: never
}
}
@ -1256,7 +1256,7 @@ export type PostDatasetsTagsBindingError
export type PostDatasetsTagsBindingResponses = {
204: {
[key: string]: unknown
[key: string]: never
}
}
@ -1284,7 +1284,7 @@ export type PostDatasetsTagsUnbindingError
export type PostDatasetsTagsUnbindingResponses = {
204: {
[key: string]: unknown
[key: string]: never
}
}
@ -1317,7 +1317,7 @@ export type DeleteDatasetsByDatasetIdError
export type DeleteDatasetsByDatasetIdResponses = {
204: {
[key: string]: unknown
[key: string]: never
}
}
@ -1698,7 +1698,7 @@ export type DeleteDatasetsByDatasetIdDocumentsByDocumentIdError
export type DeleteDatasetsByDatasetIdDocumentsByDocumentIdResponses = {
204: {
[key: string]: unknown
[key: string]: never
}
}
@ -1897,7 +1897,7 @@ export type DeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdErr
export type DeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdResponses = {
204: {
[key: string]: unknown
[key: string]: never
}
}
@ -2065,7 +2065,7 @@ export type DeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChi
export type DeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdResponses
= {
204: {
[key: string]: unknown
[key: string]: never
}
}
@ -2404,7 +2404,7 @@ export type DeleteDatasetsByDatasetIdMetadataByMetadataIdError
export type DeleteDatasetsByDatasetIdMetadataByMetadataIdResponses = {
204: {
[key: string]: unknown
[key: string]: never
}
}

20
packages/contracts/generated/api/service/zod.gen.ts
View File

@ -768,7 +768,7 @@ export const zDeleteAppsAnnotationsByAnnotationIdPath = z.object({
/**
* Annotation deleted successfully
*/
export const zDeleteAppsAnnotationsByAnnotationIdResponse = z.record(z.string(), z.unknown())
export const zDeleteAppsAnnotationsByAnnotationIdResponse = z.record(z.string(), z.never())
export const zPutAppsAnnotationsByAnnotationIdBody = zAnnotationCreatePayload
@ -839,7 +839,7 @@ export const zDeleteConversationsByCIdPath = z.object({
/**
* Conversation deleted successfully
*/
export const zDeleteConversationsByCIdResponse = z.record(z.string(), z.unknown())
export const zDeleteConversationsByCIdResponse = z.record(z.string(), z.never())
export const zPostConversationsByCIdNameBody = zConversationRenamePayload
@ -902,7 +902,7 @@ export const zDeleteDatasetsTagsBody = zTagDeletePayload
/**
* Tag deleted successfully
*/
export const zDeleteDatasetsTagsResponse = z.record(z.string(), z.unknown())
export const zDeleteDatasetsTagsResponse = z.record(z.string(), z.never())
/**
* Tags retrieved successfully
@ -928,14 +928,14 @@ export const zPostDatasetsTagsBindingBody = zTagBindingPayload
/**
* Tags bound successfully
*/
export const zPostDatasetsTagsBindingResponse = z.record(z.string(), z.unknown())
export const zPostDatasetsTagsBindingResponse = z.record(z.string(), z.never())
export const zPostDatasetsTagsUnbindingBody = zTagUnbindingPayload
/**
* Tags unbound successfully
*/
export const zPostDatasetsTagsUnbindingResponse = z.record(z.string(), z.unknown())
export const zPostDatasetsTagsUnbindingResponse = z.record(z.string(), z.never())
export const zDeleteDatasetsByDatasetIdPath = z.object({
dataset_id: z.string(),
@ -944,7 +944,7 @@ export const zDeleteDatasetsByDatasetIdPath = z.object({
/**
* Dataset deleted successfully
*/
export const zDeleteDatasetsByDatasetIdResponse = z.record(z.string(), z.unknown())
export const zDeleteDatasetsByDatasetIdResponse = z.record(z.string(), z.never())
export const zGetDatasetsByDatasetIdPath = z.object({
dataset_id: z.string(),
@ -1088,7 +1088,7 @@ export const zDeleteDatasetsByDatasetIdDocumentsByDocumentIdPath = z.object({
*/
export const zDeleteDatasetsByDatasetIdDocumentsByDocumentIdResponse = z.record(
z.string(),
z.unknown(),
z.never(),
)
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdPath = z.object({
@ -1174,7 +1174,7 @@ export const zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdP
*/
export const zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdResponse = z.record(
z.string(),
z.unknown(),
z.never(),
)
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdPath = z.object({
@ -1256,7 +1256,7 @@ export const zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdC
* Child chunk deleted successfully
*/
export const zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdResponse
= z.record(z.string(), z.unknown())
= z.record(z.string(), z.never())
export const zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdBody
= zChildChunkUpdatePayload
@ -1394,7 +1394,7 @@ export const zDeleteDatasetsByDatasetIdMetadataByMetadataIdPath = z.object({
*/
export const zDeleteDatasetsByDatasetIdMetadataByMetadataIdResponse = z.record(
z.string(),
z.unknown(),
z.never(),
)
export const zPatchDatasetsByDatasetIdMetadataByMetadataIdBody = zMetadataUpdatePayload

286
packages/contracts/generated/api/web/orpc.gen.ts
View File

@ -85,10 +85,16 @@ import {
* Convert audio to text
*
* Convert audio file to text using speech-to-text service.
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post = oc
.route({
description: 'Convert audio file to text using speech-to-text service.',
deprecated: true,
description:
'Convert audio file to text using speech-to-text service.\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postAudioToText',
@ -104,10 +110,16 @@ export const audioToText = {
/**
* Stop a running chat message task.
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post2 = oc
.route({
description: 'Stop a running chat message task.',
deprecated: true,
description:
'Stop a running chat message task.\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postChatMessagesByTaskIdStop',
@ -127,10 +139,16 @@ export const byTaskId = {
/**
* Create a chat message for conversational applications.
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post3 = oc
.route({
description: 'Create a chat message for conversational applications.',
deprecated: true,
description:
'Create a chat message for conversational applications.\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postChatMessages',
@ -147,10 +165,16 @@ export const chatMessages = {
/**
* Stop a running completion message task.
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post4 = oc
.route({
description: 'Stop a running completion message task.',
deprecated: true,
description:
'Stop a running completion message task.\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postCompletionMessagesByTaskIdStop',
@ -170,10 +194,16 @@ export const byTaskId2 = {
/**
* Create a completion message for text generation applications.
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post5 = oc
.route({
description: 'Create a completion message for text generation applications.',
deprecated: true,
description:
'Create a completion message for text generation applications.\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postCompletionMessages',
@ -190,10 +220,16 @@ export const completionMessages = {
/**
* Rename a specific conversation with a custom name or auto-generate one.
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post6 = oc
.route({
description: 'Rename a specific conversation with a custom name or auto-generate one.',
deprecated: true,
description:
'Rename a specific conversation with a custom name or auto-generate one.\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postConversationsByCIdName',
@ -214,10 +250,16 @@ export const name = {
/**
* Pin a specific conversation to keep it at the top of the list.
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const patch = oc
.route({
description: 'Pin a specific conversation to keep it at the top of the list.',
deprecated: true,
description:
'Pin a specific conversation to keep it at the top of the list.\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'PATCH',
operationId: 'patchConversationsByCIdPin',
@ -233,10 +275,16 @@ export const pin = {
/**
* Unpin a specific conversation to remove it from the top of the list.
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const patch2 = oc
.route({
description: 'Unpin a specific conversation to remove it from the top of the list.',
deprecated: true,
description:
'Unpin a specific conversation to remove it from the top of the list.\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'PATCH',
operationId: 'patchConversationsByCIdUnpin',
@ -275,10 +323,16 @@ export const byCId = {
/**
* Retrieve paginated list of conversations for a chat application.
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get = oc
.route({
description: 'Retrieve paginated list of conversations for a chat application.',
deprecated: true,
description:
'Retrieve paginated list of conversations for a chat application.\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getConversations',
@ -295,10 +349,16 @@ export const conversations = {
/**
* Verify email code and complete login
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post7 = oc
.route({
description: 'Verify email code and complete login',
deprecated: true,
description:
'Verify email code and complete login\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postEmailCodeLoginValidity',
@ -314,10 +374,16 @@ export const validity = {
/**
* Send email verification code for login
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post8 = oc
.route({
description: 'Send email verification code for login',
deprecated: true,
description:
'Send email verification code for login\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postEmailCodeLogin',
@ -382,10 +448,16 @@ export const files = {
/**
* Reset user password with verification token
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post10 = oc
.route({
description: 'Reset user password with verification token',
deprecated: true,
description:
'Reset user password with verification token\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postForgotPasswordResets',
@ -401,10 +473,16 @@ export const resets = {
/**
* Verify password reset token validity
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post11 = oc
.route({
description: 'Verify password reset token validity',
deprecated: true,
description:
'Verify password reset token validity\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postForgotPasswordValidity',
@ -420,10 +498,16 @@ export const validity2 = {
/**
* Send password reset email
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post12 = oc
.route({
description: 'Send password reset email',
deprecated: true,
description:
'Send password reset email\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postForgotPassword',
@ -443,10 +527,16 @@ export const forgotPassword = {
* Get human input form definition by token
*
* GET /api/form/human_input/<form_token>
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get2 = oc
.route({
description: 'GET /api/form/human_input/<form_token>',
deprecated: true,
description:
'GET /api/form/human_input/<form_token>\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getFormHumanInputByFormToken',
@ -469,11 +559,16 @@ export const get2 = oc
* },
* "action": "Approve"
* }
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post13 = oc
.route({
deprecated: true,
description:
'POST /api/form/human_input/<form_token>\n\nRequest body:\n{\n "inputs": {\n "content": "User input content"\n },\n "action": "Approve"\n}',
'POST /api/form/human_input/<form_token>\n\nRequest body:\n{\n "inputs": {\n "content": "User input content"\n },\n "action": "Approve"\n}\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postFormHumanInputByFormToken',
@ -499,10 +594,16 @@ export const form = {
/**
* Check login status
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get3 = oc
.route({
description: 'Check login status',
deprecated: true,
description:
'Check login status\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getLoginStatus',
@ -519,10 +620,16 @@ export const status = {
* Authenticate user and login
*
* Authenticate user for web application access
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post14 = oc
.route({
description: 'Authenticate user for web application access',
deprecated: true,
description:
'Authenticate user for web application access\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postLogin',
@ -540,10 +647,16 @@ export const login = {
/**
* Logout user from web application
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post15 = oc
.route({
description: 'Logout user from web application',
deprecated: true,
description:
'Logout user from web application\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postLogout',
@ -558,10 +671,16 @@ export const logout = {
/**
* Submit feedback (like/dislike) for a specific message.
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post16 = oc
.route({
description: 'Submit feedback (like/dislike) for a specific message.',
deprecated: true,
description:
'Submit feedback (like/dislike) for a specific message.\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postMessagesByMessageIdFeedbacks',
@ -582,10 +701,16 @@ export const feedbacks = {
/**
* Generate a new completion similar to an existing message (completion apps only).
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get4 = oc
.route({
description: 'Generate a new completion similar to an existing message (completion apps only).',
deprecated: true,
description:
'Generate a new completion similar to an existing message (completion apps only).\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getMessagesByMessageIdMoreLikeThis',
@ -606,10 +731,16 @@ export const moreLikeThis = {
/**
* Get suggested follow-up questions after a message (chat apps only).
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get5 = oc
.route({
description: 'Get suggested follow-up questions after a message (chat apps only).',
deprecated: true,
description:
'Get suggested follow-up questions after a message (chat apps only).\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getMessagesByMessageIdSuggestedQuestions',
@ -631,10 +762,16 @@ export const byMessageId = {
/**
* Retrieve paginated list of messages from a conversation in a chat application.
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get6 = oc
.route({
description: 'Retrieve paginated list of messages from a conversation in a chat application.',
deprecated: true,
description:
'Retrieve paginated list of messages from a conversation in a chat application.\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getMessages',
@ -653,10 +790,16 @@ export const messages = {
* Get app meta
*
* Retrieve the metadata for a specific app.
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get7 = oc
.route({
description: 'Retrieve the metadata for a specific app.',
deprecated: true,
description:
'Retrieve the metadata for a specific app.\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getMeta',
@ -674,10 +817,16 @@ export const meta = {
* Retrieve app parameters
*
* Retrieve the parameters for a specific app.
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get8 = oc
.route({
description: 'Retrieve the parameters for a specific app.',
deprecated: true,
description:
'Retrieve the parameters for a specific app.\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getParameters',
@ -693,10 +842,16 @@ export const parameters = {
/**
* Get authentication passport for web application access
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get9 = oc
.route({
description: 'Get authentication passport for web application access',
deprecated: true,
description:
'Get authentication passport for web application access\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getPassport',
@ -813,10 +968,16 @@ export const byMessageId2 = {
/**
* Retrieve paginated list of saved messages for a completion application.
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get11 = oc
.route({
description: 'Retrieve paginated list of saved messages for a completion application.',
deprecated: true,
description:
'Retrieve paginated list of saved messages for a completion application.\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getSavedMessages',
@ -828,10 +989,16 @@ export const get11 = oc
/**
* Save a specific message for later reference.
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post18 = oc
.route({
description: 'Save a specific message for later reference.',
deprecated: true,
description:
'Save a specific message for later reference.\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postSavedMessages',
@ -851,10 +1018,16 @@ export const savedMessages = {
* Retrieve app site info
*
* Retrieve app site information and configuration.
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get12 = oc
.route({
description: 'Retrieve app site information and configuration.',
deprecated: true,
description:
'Retrieve app site information and configuration.\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getSite',
@ -887,11 +1060,16 @@ export const site = {
* Authentication would create circular dependency (can't authenticate without webapp loading).
*
* Only non-sensitive configuration data should be returned by this endpoint.
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get13 = oc
.route({
deprecated: true,
description:
'Get system feature flags and configuration\nReturns the current system feature flags and configuration\nthat control various functionalities across the platform.\n\nReturns:\n dict: System feature configuration object\n\nThis endpoint is akin to the `SystemFeatureApi` endpoint in api/controllers/console/feature.py,\nexcept it is intended for use by the web app, instead of the console dashboard.\n\nNOTE: This endpoint is unauthenticated by design, as it provides system features\ndata required for webapp initialization.\n\nAuthentication would create circular dependency (can\'t authenticate without webapp loading).\n\nOnly non-sensitive configuration data should be returned by this endpoint.',
'Get system feature flags and configuration\nReturns the current system feature flags and configuration\nthat control various functionalities across the platform.\n\nReturns:\n dict: System feature configuration object\n\nThis endpoint is akin to the `SystemFeatureApi` endpoint in api/controllers/console/feature.py,\nexcept it is intended for use by the web app, instead of the console dashboard.\n\nNOTE: This endpoint is unauthenticated by design, as it provides system features\ndata required for webapp initialization.\n\nAuthentication would create circular dependency (can\'t authenticate without webapp loading).\n\nOnly non-sensitive configuration data should be returned by this endpoint.\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getSystemFeatures',
@ -909,10 +1087,16 @@ export const systemFeatures = {
* Convert text to audio
*
* Convert text to audio using text-to-speech service.
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post19 = oc
.route({
description: 'Convert text to audio using text-to-speech service.',
deprecated: true,
description:
'Convert text to audio using text-to-speech service.\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postTextToAudio',
@ -929,10 +1113,16 @@ export const textToAudio = {
/**
* Retrieve the access mode for a web application (public or restricted).
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get14 = oc
.route({
description: 'Retrieve the access mode for a web application (public or restricted).',
deprecated: true,
description:
'Retrieve the access mode for a web application (public or restricted).\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getWebappAccessMode',
@ -948,10 +1138,16 @@ export const accessMode = {
/**
* Check if user has permission to access a web application.
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get15 = oc
.route({
description: 'Check if user has permission to access a web application.',
deprecated: true,
description:
'Check if user has permission to access a web application.\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getWebappPermission',
@ -976,10 +1172,16 @@ export const webapp = {
* GET /api/workflow/<task_id>/events
*
* Returns Server-Sent Events stream.
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const get16 = oc
.route({
description: 'GET /api/workflow/<task_id>/events\n\nReturns Server-Sent Events stream.',
deprecated: true,
description:
'GET /api/workflow/<task_id>/events\n\nReturns Server-Sent Events stream.\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getWorkflowByTaskIdEvents',
@ -1006,10 +1208,16 @@ export const workflow = {
* Run workflow
*
* Execute a workflow with provided inputs and files.
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post20 = oc
.route({
description: 'Execute a workflow with provided inputs and files.',
deprecated: true,
description:
'Execute a workflow with provided inputs and files.\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postWorkflowsRun',
@ -1028,10 +1236,16 @@ export const run = {
* Stop workflow task
*
* Stop a running workflow task.
*
* Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.
*
* @deprecated
*/
export const post21 = oc
.route({
description: 'Stop a running workflow task.',
deprecated: true,
description:
'Stop a running workflow task.\n\nGenerated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postWorkflowsTasksByTaskIdStop',

4
packages/contracts/generated/api/web/types.gen.ts
View File

@ -417,7 +417,7 @@ export type DeleteConversationsByCIdError
export type DeleteConversationsByCIdResponses = {
204: {
[key: string]: unknown
[key: string]: never
}
}
@ -1250,7 +1250,7 @@ export type DeleteSavedMessagesByMessageIdError
export type DeleteSavedMessagesByMessageIdResponses = {
204: {
[key: string]: unknown
[key: string]: never
}
}

4
packages/contracts/generated/api/web/zod.gen.ts
View File

@ -271,7 +271,7 @@ export const zDeleteConversationsByCIdPath = z.object({
/**
* Conversation deleted successfully
*/
export const zDeleteConversationsByCIdResponse = z.record(z.string(), z.unknown())
export const zDeleteConversationsByCIdResponse = z.record(z.string(), z.never())
export const zPostConversationsByCIdNamePath = z.object({
c_id: z.string(),
@ -482,7 +482,7 @@ export const zDeleteSavedMessagesByMessageIdPath = z.object({
/**
* Message removed successfully
*/
export const zDeleteSavedMessagesByMessageIdResponse = z.record(z.string(), z.unknown())
export const zDeleteSavedMessagesByMessageIdResponse = z.record(z.string(), z.never())
/**
* Success

225
packages/contracts/openapi-ts.api.config.ts
View File

@ -11,6 +11,7 @@ type SwaggerSchema = JsonObject & {
'$ref'?: string
'x-nullable'?: boolean
'additionalProperties'?: unknown
'allOf'?: SwaggerSchema[]
'anyOf'?: SwaggerSchema[]
'const'?: unknown
'default'?: unknown
@ -19,6 +20,7 @@ type SwaggerSchema = JsonObject & {
'enum'?: unknown[]
'format'?: string
'items'?: SwaggerSchema
'oneOf'?: SwaggerSchema[]
'properties'?: Record<string, SwaggerSchema>
'required'?: string[]
'type'?: string
@ -38,6 +40,8 @@ type SwaggerResponse = JsonObject & {
}
type SwaggerOperation = JsonObject & {
deprecated?: boolean
description?: string
operationId?: string
parameters?: SwaggerParameter[]
responses?: Record<string, SwaggerResponse>
@ -54,8 +58,16 @@ type ApiSpec = {
}
type ApiJob = {
clean?: boolean
document: SwaggerDocument
outputPath: string
plugins?: UserConfig['plugins']
source?: {
callback: () => void
enabled: true
path: null
serialize: () => string
}
}
type ApiContractOperation = {
@ -63,10 +75,17 @@ type ApiContractOperation = {
path: string
}
type ApiReadinessSurfaceStats = {
notReady: number
total: number
}
const currentDir = path.dirname(fileURLToPath(import.meta.url))
const apiOpenApiDir = path.resolve(currentDir, 'openapi')
const apiReadinessStatsPath = path.resolve(currentDir, 'generated/api/readiness.json')
const operationMethods = new Set(['delete', 'get', 'patch', 'post', 'put'])
const noBodyResponseStatuses = new Set(['204', '205', '304'])
const apiSpecs: ApiSpec[] = [
{ filename: 'console-swagger.json', name: 'console' },
@ -74,6 +93,9 @@ const apiSpecs: ApiSpec[] = [
{ filename: 'service-swagger.json', name: 'service' },
]
const inaccurateGeneratedContractDescription = 'Generated contract types may be inaccurate because backend OpenAPI annotations are incomplete. Do not migrate callers until the generated contract is accurate.'
const apiReadinessStats: Record<string, ApiReadinessSurfaceStats> = {}
const isObject = (value: unknown): value is JsonObject => {
return !!value && typeof value === 'object' && !Array.isArray(value)
}
@ -83,6 +105,13 @@ const unknownObjectSchema = (): SwaggerSchema => ({
type: 'object',
})
const noContentSchema = (): SwaggerSchema => ({
// Hey API's Swagger 2.0 pipeline currently needs a response schema symbol even for no-content responses.
additionalProperties: false,
properties: {},
type: 'object',
})
const toWords = (value: string) => {
return value
.replace(/[{}]/g, '')
@ -425,7 +454,12 @@ const normalizeGetBodyParameters = (
const normalizeResponses = (operation: SwaggerOperation) => {
const responses = operation.responses ??= {}
for (const response of Object.values(responses)) {
for (const [status, response] of Object.entries(responses)) {
if (noBodyResponseStatuses.has(status)) {
response.schema = noContentSchema()
continue
}
if (!response.schema)
response.schema = unknownObjectSchema()
}
@ -438,7 +472,103 @@ const normalizeResponses = (operation: SwaggerOperation) => {
}
}
const normalizeOperations = (document: SwaggerDocument) => {
const hasProperties = (schema: SwaggerSchema) => {
return isObject(schema.properties) && Object.keys(schema.properties).length > 0
}
const isEmptySchemaObject = (value: unknown) => {
return isObject(value) && Object.keys(value).length === 0
}
const isLooseObjectSchema = (schema: SwaggerSchema) => {
if (hasProperties(schema))
return false
if (schema.additionalProperties === true || isEmptySchemaObject(schema.additionalProperties))
return true
return schema.type === 'object' && schema.additionalProperties === undefined
}
const hasLooseSchema = (
schema: SwaggerSchema | undefined,
definitions: Record<string, SwaggerSchema>,
visitedRefs = new Set<string>(),
): boolean => {
if (!schema)
return true
const ref = schema?.$ref
if (ref?.startsWith('#/definitions/')) {
const refName = ref.slice('#/definitions/'.length)
if (visitedRefs.has(refName))
return false
return hasLooseSchema(definitions[refName], definitions, new Set([...visitedRefs, refName]))
}
const normalizedSchema = withoutNullableWrapper(schema)
for (const variants of [normalizedSchema.allOf, normalizedSchema.anyOf, normalizedSchema.oneOf]) {
if (Array.isArray(variants) && variants.some(item => !isNullSchema(item) && hasLooseSchema(item, definitions, visitedRefs)))
return true
}
if (normalizedSchema.type === 'array')
return hasLooseSchema(normalizedSchema.items, definitions, visitedRefs)
if (isLooseObjectSchema(normalizedSchema))
return true
if (isObject(normalizedSchema.additionalProperties) && hasLooseSchema(normalizedSchema.additionalProperties, definitions, visitedRefs))
return true
return Object.values(normalizedSchema.properties ?? {})
.some(property => hasLooseSchema(property, definitions, visitedRefs))
}
const hasPossiblyInaccurateGeneratedContractTypes = (
operation: SwaggerOperation,
definitions: Record<string, SwaggerSchema>,
) => {
const successResponses = Object.entries(operation.responses ?? {})
.filter(([status]) => /^2\d\d$/.test(status))
if (successResponses.length === 0)
return true
const successResponsesWithBody = successResponses.filter(([status]) => !noBodyResponseStatuses.has(status))
if (successResponsesWithBody.some(([, response]) => hasLooseSchema(response.schema, definitions)))
return true
return operation.parameters?.some((parameter) => {
return parameter.in === 'body' && hasLooseSchema(parameter.schema, definitions)
}) ?? false
}
const appendOperationDescription = (operation: SwaggerOperation, description: string) => {
const currentDescription = operation.description?.trim()
operation.description = currentDescription ? `${currentDescription}\n\n${description}` : description
}
const markPossiblyInaccurateGeneratedContract = (operation: SwaggerOperation) => {
operation.deprecated = true
appendOperationDescription(operation, inaccurateGeneratedContractDescription)
}
const recordApiReadiness = (surface: string, isReady: boolean) => {
const stats = apiReadinessStats[surface] ??= {
notReady: 0,
total: 0,
}
stats.total += 1
if (!isReady)
stats.notReady += 1
}
const normalizeOperations = (document: SwaggerDocument, surface: string) => {
const definitions = document.definitions ??= {}
for (const [routePath, pathItem] of Object.entries(document.paths ?? {})) {
@ -450,14 +580,19 @@ const normalizeOperations = (document: SwaggerDocument) => {
swaggerOperation.operationId = operationId(method, routePath)
normalizeResponses(swaggerOperation)
const hasPossiblyInaccurateTypes = hasPossiblyInaccurateGeneratedContractTypes(swaggerOperation, definitions)
recordApiReadiness(surface, !hasPossiblyInaccurateTypes)
if (method === 'get')
normalizeGetBodyParameters(swaggerOperation, definitions)
if (hasPossiblyInaccurateTypes)
markPossiblyInaccurateGeneratedContract(swaggerOperation)
}
}
}
const normalizeApiSwagger = (document: SwaggerDocument) => {
const normalizeApiSwagger = (document: SwaggerDocument, surface: string) => {
document.definitions ??= {}
// Flask-RESTX emits Pydantic nested $defs inside individual schemas while
@ -466,11 +601,25 @@ const normalizeApiSwagger = (document: SwaggerDocument) => {
ensureReferencedDefinitions(document)
normalizeNullableAnyOf(document)
removeNullDefaults(document)
normalizeOperations(document)
normalizeOperations(document, surface)
return document
}
const writeApiReadinessStats = () => {
const sortedSurfaces = Object.entries(apiReadinessStats)
.sort(([left], [right]) => left.localeCompare(right))
fs.mkdirSync(path.dirname(apiReadinessStatsPath), { recursive: true })
fs.writeFileSync(
apiReadinessStatsPath,
`${JSON.stringify({
surfaces: Object.fromEntries(sortedSurfaces),
warning: inaccurateGeneratedContractDescription,
}, null, 2)}\n`,
)
}
const topLevelPathSegment = (routePath: string) => {
return routePath.split('/').filter(Boolean)[0] ?? 'root'
}
@ -520,6 +669,50 @@ const cloneDocumentWithPaths = (
} satisfies SwaggerDocument
}
const consoleContractEntryContent = (segments: string[]) => {
const contracts = segments.map((segment) => {
return {
importPath: toKebabCase(segment),
name: toCamelCase(segmentWords(segment)),
}
})
const imports = contracts
.map(contract => `import { ${contract.name} } from './${contract.importPath}/orpc.gen'`)
.join('\n')
const contractEntries = contracts.map(contract => ` ${contract.name},`).join('\n')
return `// This file is auto-generated by @hey-api/openapi-ts
${imports}
export const contract = {
${contractEntries}
}
`
}
const writeConsoleContractEntry = (segments: string[]) => {
const entryPath = path.resolve(currentDir, 'generated/api/console/orpc.gen.ts')
fs.mkdirSync(path.dirname(entryPath), { recursive: true })
fs.writeFileSync(entryPath, consoleContractEntryContent(segments))
}
const createConsoleContractEntryJob = (document: SwaggerDocument, segments: string[]): ApiJob => {
return {
clean: false,
document,
outputPath: 'generated/api/console',
plugins: [],
source: {
callback: () => writeConsoleContractEntry(segments),
enabled: true,
path: null,
serialize: () => '',
},
}
}
const splitConsoleDocument = (document: SwaggerDocument) => {
const pathsBySegment = new Map<string, Record<string, Record<string, unknown>>>()
@ -530,16 +723,17 @@ const splitConsoleDocument = (document: SwaggerDocument) => {
pathsBySegment.set(segment, paths)
}
return [...pathsBySegment.entries()]
.sort(([left], [right]) => left.localeCompare(right))
.map(([segment, paths]): ApiJob => ({
document: cloneDocumentWithPaths(document, paths),
outputPath: `generated/api/console/${toKebabCase(segment)}`,
}))
const segments = [...pathsBySegment.keys()].sort((left, right) => left.localeCompare(right))
const jobs = segments.map((segment): ApiJob => ({
document: cloneDocumentWithPaths(document, pathsBySegment.get(segment) ?? {}),
outputPath: `generated/api/console/${toKebabCase(segment)}`,
}))
return [...jobs, createConsoleContractEntryJob(document, segments)]
}
const createApiJobs = (spec: ApiSpec): ApiJob[] => {
const document = normalizeApiSwagger(readApiSwagger(spec.filename))
const document = normalizeApiSwagger(readApiSwagger(spec.filename), spec.name)
if (spec.name === 'console')
return splitConsoleDocument(document)
@ -552,19 +746,24 @@ const createApiJobs = (spec: ApiSpec): ApiJob[] => {
]
}
const apiJobs = apiSpecs.flatMap(createApiJobs)
writeApiReadinessStats()
const createApiConfig = (job: ApiJob): UserConfig => ({
input: job.document,
logs: {
file: false,
},
output: {
...(job.clean === undefined ? {} : { clean: job.clean }),
entryFile: false,
fileName: {
suffix: '.gen',
},
path: job.outputPath,
...(job.source ? { source: job.source } : {}),
},
plugins: [
plugins: job.plugins ?? [
{
'comments': false,
'name': '@hey-api/typescript',
@ -597,4 +796,4 @@ const createApiConfig = (job: ApiJob): UserConfig => ({
],
})
export default defineConfig(apiSpecs.flatMap(createApiJobs).map(createApiConfig))
export default defineConfig(apiJobs.map(createApiConfig))

3
packages/contracts/package.json
View File

@ -15,8 +15,9 @@
},
"scripts": {
"gen-api-contract": "pnpm gen-api-openapi && pnpm gen-api-contract-from-openapi",
"gen-api-contract-from-openapi": "node -e \"fs.rmSync('generated/api', { recursive: true, force: true })\" && openapi-ts -f openapi-ts.api.config.ts && vp fmt generated/api && eslint --fix generated/api",
"gen-api-contract-from-openapi": "node -e \"fs.rmSync('generated/api', { recursive: true, force: true })\" && openapi-ts -f openapi-ts.api.config.ts && vp fmt generated/api && eslint --fix generated/api && pnpm gen-api-readiness-readme",
"gen-api-openapi": "uv run --project ../../api ../../api/dev/generate_swagger_specs.py --output-dir openapi",
"gen-api-readiness-readme": "node scripts/generate-api-readiness-readme.mjs && eslint --fix README.md",
"gen-enterprise-contract": "openapi-ts -f openapi-ts.enterprise.config.ts",
"type-check": "tsgo"
},

94
packages/contracts/scripts/generate-api-readiness-readme.mjs Normal file
View File

@ -0,0 +1,94 @@
import fs from 'node:fs'
import path from 'node:path'
import { fileURLToPath } from 'node:url'
const currentDir = path.dirname(fileURLToPath(import.meta.url))
const packageDir = path.resolve(currentDir, '..')
const readinessStatsPath = path.resolve(packageDir, 'generated/api/readiness.json')
const readmePath = path.resolve(packageDir, 'README.md')
const readinessStartMarker = '<!-- api-openapi-readiness:start -->'
const readinessEndMarker = '<!-- api-openapi-readiness:end -->'
const formatPercent = (ready, total) => {
return total === 0 ? '0.0%' : `${((ready / total) * 100).toFixed(1)}%`
}
const collectStats = () => {
if (!fs.existsSync(readinessStatsPath)) {
throw new Error(
`Missing API readiness stats: ${readinessStatsPath}. Run "pnpm -C packages/contracts gen-api-contract-from-openapi" first.`,
)
}
return JSON.parse(fs.readFileSync(readinessStatsPath, 'utf8'))
}
const tableRow = (surface, ready, notReady, total) => {
return `| ${surface} | ${ready} | ${notReady} | ${total} | ${formatPercent(ready, total)} |`
}
const renderReadinessSection = (stats) => {
const rows = Object.entries(stats.surfaces)
.sort(([left], [right]) => left.localeCompare(right))
.map(([surface, stat]) => tableRow(surface, stat.total - stat.notReady, stat.notReady, stat.total))
const totals = Object.values(stats.surfaces).reduce(
(summary, stat) => {
summary.notReady += stat.notReady
summary.total += stat.total
return summary
},
{ notReady: 0, total: 0 },
)
const totalReady = totals.total - totals.notReady
if (totals.total === 0)
throw new Error(`No API readiness stats found in ${readinessStatsPath}`)
return `${readinessStartMarker}
<!-- This section is auto-generated by scripts/generate-api-readiness-readme.mjs. Do not edit between the markers. -->
Snapshot generated from \`packages/contracts/generated/api/readiness.json\` after running \`pnpm -C packages/contracts gen-api-contract-from-openapi\`.
Are we OpenAPI ready? **No.** Current generated API contracts are **${formatPercent(totalReady, totals.total)} ready**.
| Surface | Ready | Not ready | Total | Ready % |
| --- | ---: | ---: | ---: | ---: |
${rows.join('\n')}
| **total** | **${totalReady}** | **${totals.notReady}** | **${totals.total}** | **${formatPercent(totalReady, totals.total)}** |
Readiness here means the generated contract operation is not marked with:
> ${stats.warning}
Operations marked with that warning should not be migrated to blindly. Prefer fixing backend OpenAPI annotations first so the generated contract has accurate request and response types, then migrate callers endpoint by endpoint.
The current heuristic marks an operation as not ready when a request body or success response that should have a body contains a loose object type, or when an operation has no documented 2xx response. 204, 205, and 304 responses are treated as bodyless when the request type is otherwise accurate.
${readinessEndMarker}
`
}
const updateReadme = (readinessSection) => {
const readme = fs.readFileSync(readmePath, 'utf8')
const startIndex = readme.indexOf(readinessStartMarker)
const endIndex = readme.indexOf(readinessEndMarker)
if (startIndex === -1 || endIndex === -1 || endIndex < startIndex) {
throw new Error(
`Missing readiness markers in ${readmePath}. Expected ${readinessStartMarker} and ${readinessEndMarker}.`,
)
}
const nextReadme = [
readme.slice(0, startIndex),
readinessSection,
readme.slice(endIndex + readinessEndMarker.length),
].join('')
fs.writeFileSync(readmePath, nextReadme)
}
updateReadme(renderReadinessSection(collectStats()))

22
web/app/components/app/annotation/__tests__/filter.spec.tsx
View File

@ -1,7 +1,7 @@
import type { AnnotationCountResponse } from '@dify/contracts/api/console/apps/types.gen'
import type { UseQueryResult } from '@tanstack/react-query'
import type { Mock } from 'vitest'
import type { QueryParam } from '../filter'
import type { AnnotationsCountResponse } from '@/models/log'
import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
import { fireEvent, render, screen } from '@testing-library/react'
import * as React from 'react'
@ -69,7 +69,7 @@ describe('Filter', () => {
it('should render nothing when data is loading', () => {
// Arrange
mockUseAnnotationsCount.mockReturnValue(
createMockQueryResult<AnnotationsCountResponse>({ isLoading: true }),
createMockQueryResult<AnnotationCountResponse>({ isLoading: true }),
)
// Act
@ -90,7 +90,7 @@ describe('Filter', () => {
it('should render nothing when data is undefined', () => {
// Arrange
mockUseAnnotationsCount.mockReturnValue(
createMockQueryResult<AnnotationsCountResponse>({ data: undefined, isLoading: false }),
createMockQueryResult<AnnotationCountResponse>({ data: undefined, isLoading: false }),
)
// Act
@ -111,7 +111,7 @@ describe('Filter', () => {
it('should render filter and children when data is available', () => {
// Arrange
mockUseAnnotationsCount.mockReturnValue(
createMockQueryResult<AnnotationsCountResponse>({
createMockQueryResult<AnnotationCountResponse>({
data: { count: 20 },
isLoading: false,
}),
@ -141,7 +141,7 @@ describe('Filter', () => {
it('should call useAnnotationsCount with appId', () => {
// Arrange
mockUseAnnotationsCount.mockReturnValue(
createMockQueryResult<AnnotationsCountResponse>({
createMockQueryResult<AnnotationCountResponse>({
data: { count: 10 },
isLoading: false,
}),
@ -165,7 +165,7 @@ describe('Filter', () => {
it('should display keyword value in input', () => {
// Arrange
mockUseAnnotationsCount.mockReturnValue(
createMockQueryResult<AnnotationsCountResponse>({
createMockQueryResult<AnnotationCountResponse>({
data: { count: 10 },
isLoading: false,
}),
@ -195,7 +195,7 @@ describe('Filter', () => {
it('should call setQueryParams when typing in search input', () => {
// Arrange
mockUseAnnotationsCount.mockReturnValue(
createMockQueryResult<AnnotationsCountResponse>({
createMockQueryResult<AnnotationCountResponse>({
data: { count: 20 },
isLoading: false,
}),
@ -224,7 +224,7 @@ describe('Filter', () => {
it('should call setQueryParams with empty keyword when clearing input', () => {
// Arrange
mockUseAnnotationsCount.mockReturnValue(
createMockQueryResult<AnnotationsCountResponse>({
createMockQueryResult<AnnotationCountResponse>({
data: { count: 20 },
isLoading: false,
}),
@ -257,7 +257,7 @@ describe('Filter', () => {
it('should handle empty keyword in queryParams', () => {
// Arrange
mockUseAnnotationsCount.mockReturnValue(
createMockQueryResult<AnnotationsCountResponse>({
createMockQueryResult<AnnotationCountResponse>({
data: { count: 5 },
isLoading: false,
}),
@ -281,7 +281,7 @@ describe('Filter', () => {
it('should handle undefined keyword in queryParams', () => {
// Arrange
mockUseAnnotationsCount.mockReturnValue(
createMockQueryResult<AnnotationsCountResponse>({
createMockQueryResult<AnnotationCountResponse>({
data: { count: 5 },
isLoading: false,
}),
@ -305,7 +305,7 @@ describe('Filter', () => {
it('should handle zero count', () => {
// Arrange
mockUseAnnotationsCount.mockReturnValue(
createMockQueryResult<AnnotationsCountResponse>({
createMockQueryResult<AnnotationCountResponse>({
data: { count: 0 },
isLoading: false,
}),

14
web/app/components/header/account-setting/api-based-extension-page/__tests__/index.spec.tsx
View File

@ -1,6 +1,6 @@
import type { ApiBasedExtensionResponse } from '@dify/contracts/api/console/api-based-extension/types.gen'
import type { SetStateAction } from 'react'
import type { ModalContextState, ModalState } from '@/context/modal-context'
import type { ApiBasedExtension } from '@/models/common'
import { fireEvent, render, screen } from '@testing-library/react'
import { useModalContext } from '@/context/modal-context'
import { useApiBasedExtensions } from '@/service/use-common'
@ -16,7 +16,7 @@ vi.mock('@/context/modal-context', () => ({
describe('ApiBasedExtensionPage', () => {
const mockRefetch = vi.fn<() => void>()
const mockSetShowApiBasedExtensionModal = vi.fn<(value: SetStateAction<ModalState<ApiBasedExtension> | null>) => void>()
const mockSetShowApiBasedExtensionModal = vi.fn<(value: SetStateAction<ModalState<Partial<ApiBasedExtensionResponse>> | null>) => void>()
beforeEach(() => {
vi.clearAllMocks()
@ -44,9 +44,9 @@ describe('ApiBasedExtensionPage', () => {
it('should render list of extensions when data exists', () => {
// Arrange
const mockData = [
{ id: '1', name: 'Extension 1', api_endpoint: 'url1' },
{ id: '2', name: 'Extension 2', api_endpoint: 'url2' },
const mockData: ApiBasedExtensionResponse[] = [
{ id: '1', name: 'Extension 1', api_endpoint: 'url1', api_key: 'key1' },
{ id: '2', name: 'Extension 2', api_endpoint: 'url2', api_key: 'key2' },
]
vi.mocked(useApiBasedExtensions).mockReturnValue({
@ -158,7 +158,9 @@ describe('ApiBasedExtensionPage', () => {
it('should call refetch when an item is updated', () => {
// Arrange
const mockData = [{ id: '1', name: 'Extension 1', api_endpoint: 'url1' }]
const mockData: ApiBasedExtensionResponse[] = [
{ id: '1', name: 'Extension 1', api_endpoint: 'url1', api_key: 'key1' },
]
vi.mocked(useApiBasedExtensions).mockReturnValue({
data: mockData,
isPending: false,

11
web/app/components/header/account-setting/api-based-extension-page/__tests__/item.spec.tsx
View File

@ -1,6 +1,6 @@
import type { ApiBasedExtensionResponse } from '@dify/contracts/api/console/api-based-extension/types.gen'
import type { TFunction } from 'i18next'
import type { ModalContextState } from '@/context/modal-context'
import type { ApiBasedExtension } from '@/models/common'
import { fireEvent, render, screen, waitFor, within } from '@testing-library/react'
import * as reactI18next from 'react-i18next'
import { useModalContext } from '@/context/modal-context'
@ -17,7 +17,7 @@ vi.mock('@/service/common', () => ({
}))
describe('Item Component', () => {
const mockData: ApiBasedExtension = {
const mockData: ApiBasedExtensionResponse = {
id: '1',
name: 'Test Extension',
api_endpoint: 'https://api.example.com',
@ -46,7 +46,12 @@ describe('Item Component', () => {
it('should render with minimal extension data', () => {
// Arrange
const minimalData: ApiBasedExtension = { id: '2' }
const minimalData: ApiBasedExtensionResponse = {
id: '2',
name: '',
api_endpoint: '',
api_key: '',
}
// Act
render(<Item data={minimalData} onUpdate={mockOnUpdate} />)

26
web/app/components/header/account-setting/api-based-extension-page/__tests__/modal.spec.tsx
View File

@ -1,3 +1,4 @@
import type { ApiBasedExtensionResponse } from '@dify/contracts/api/console/api-based-extension/types.gen'
import type { TFunction } from 'i18next'
import type { ReactElement } from 'react'
import { fireEvent, render as RTLRender, screen, waitFor } from '@testing-library/react'
@ -36,6 +37,13 @@ describe('ApiBasedExtensionModal', () => {
const mockOnCancel = vi.fn()
const mockOnSave = vi.fn()
const mockDocLink = vi.fn((path?: string) => `https://docs.dify.ai${path || ''}`)
const mockExtension = (overrides: Partial<ApiBasedExtensionResponse> = {}): ApiBasedExtensionResponse => ({
id: '1',
name: 'Existing',
api_endpoint: 'url',
api_key: 'key',
...overrides,
})
const render = (ui: ReactElement) => RTLRender(ui)
@ -58,7 +66,7 @@ describe('ApiBasedExtensionModal', () => {
it('should render correctly for editing an existing extension', () => {
// Arrange
const data = { id: '1', name: 'Existing', api_endpoint: 'url', api_key: 'key' }
const data = mockExtension()
// Act
render(<ApiBasedExtensionModal data={data} onCancel={mockOnCancel} onSave={mockOnSave} />)
@ -74,7 +82,13 @@ describe('ApiBasedExtensionModal', () => {
describe('Form Submissions', () => {
it('should call addApiBasedExtension on save for new extension', async () => {
// Arrange
vi.mocked(addApiBasedExtension).mockResolvedValue({ id: 'new-id' })
const newExtension = mockExtension({
id: 'new-id',
name: 'New Ext',
api_endpoint: 'https://api.test',
api_key: 'secret-key',
})
vi.mocked(addApiBasedExtension).mockResolvedValue(newExtension)
render(<ApiBasedExtensionModal data={{}} onCancel={mockOnCancel} onSave={mockOnSave} />)
// Act
@ -93,13 +107,13 @@ describe('ApiBasedExtensionModal', () => {
api_key: 'secret-key',
},
})
expect(mockOnSave).toHaveBeenCalledWith({ id: 'new-id' })
expect(mockOnSave).toHaveBeenCalledWith(newExtension)
})
})
it('should call updateApiBasedExtension on save for existing extension', async () => {
// Arrange
const data = { id: '1', name: 'Existing', api_endpoint: 'url', api_key: 'long-secret-key' }
const data = mockExtension({ api_key: 'long-secret-key' })
vi.mocked(updateApiBasedExtension).mockResolvedValue({ ...data, name: 'Updated' })
render(<ApiBasedExtensionModal data={data} onCancel={mockOnCancel} onSave={mockOnSave} />)
@ -125,7 +139,7 @@ describe('ApiBasedExtensionModal', () => {
it('should call updateApiBasedExtension with new api_key when key is changed', async () => {
// Arrange
const data = { id: '1', name: 'Existing', api_endpoint: 'url', api_key: 'old-key' }
const data = mockExtension({ api_key: 'old-key' })
vi.mocked(updateApiBasedExtension).mockResolvedValue({ ...data, api_key: 'new-longer-key' })
render(<ApiBasedExtensionModal data={data} onCancel={mockOnCancel} onSave={mockOnSave} />)
@ -165,7 +179,7 @@ describe('ApiBasedExtensionModal', () => {
describe('Interactions', () => {
it('should work when onSave is not provided', async () => {
// Arrange
vi.mocked(addApiBasedExtension).mockResolvedValue({ id: 'new-id' })
vi.mocked(addApiBasedExtension).mockResolvedValue(mockExtension({ id: 'new-id' }))
render(<ApiBasedExtensionModal data={{}} onCancel={mockOnCancel} />)
// Act

10
web/app/components/header/account-setting/api-based-extension-page/__tests__/selector.spec.tsx
View File

@ -1,6 +1,6 @@
import type { ApiBasedExtensionResponse } from '@dify/contracts/api/console/api-based-extension/types.gen'
import type { UseQueryResult } from '@tanstack/react-query'
import type { ModalContextState } from '@/context/modal-context'
import type { ApiBasedExtension } from '@/models/common'
import { fireEvent, render, screen } from '@testing-library/react'
import { ACCOUNT_SETTING_TAB } from '@/app/components/header/account-setting/constants'
import { useModalContext } from '@/context/modal-context'
@ -23,9 +23,9 @@ describe('ApiBasedExtensionSelector', () => {
const mockSetShowApiBasedExtensionModal = vi.fn()
const mockRefetch = vi.fn()
const mockData: ApiBasedExtension[] = [
{ id: '1', name: 'Extension 1', api_endpoint: 'https://api1.test' },
{ id: '2', name: 'Extension 2', api_endpoint: 'https://api2.test' },
const mockData: ApiBasedExtensionResponse[] = [
{ id: '1', name: 'Extension 1', api_endpoint: 'https://api1.test', api_key: 'key1' },
{ id: '2', name: 'Extension 2', api_endpoint: 'https://api2.test', api_key: 'key2' },
]
beforeEach(() => {
@ -39,7 +39,7 @@ describe('ApiBasedExtensionSelector', () => {
refetch: mockRefetch,
isPending: false,
isError: false,
} as unknown as UseQueryResult<ApiBasedExtension[], Error>)
} as unknown as UseQueryResult<ApiBasedExtensionResponse[], Error>)
})
describe('Rendering', () => {

4
web/app/components/header/account-setting/api-based-extension-page/item.tsx
View File

@ -1,5 +1,5 @@
import type { ApiBasedExtensionResponse } from '@dify/contracts/api/console/api-based-extension/types.gen'
import type { FC } from 'react'
import type { ApiBasedExtension } from '@/models/common'
import {
AlertDialog,
AlertDialogActions,
@ -19,7 +19,7 @@ import { useModalContext } from '@/context/modal-context'
import { deleteApiBasedExtension } from '@/service/common'
type ItemProps = {
data: ApiBasedExtension
data: ApiBasedExtensionResponse
onUpdate: () => void
}
const Item: FC<ItemProps> = ({

20
web/app/components/header/account-setting/api-based-extension-page/modal.tsx
View File

@ -1,5 +1,8 @@
import type {
ApiBasedExtensionPayload,
ApiBasedExtensionResponse,
} from '@dify/contracts/api/console/api-based-extension/types.gen'
import type { FC } from 'react'
import type { ApiBasedExtension } from '@/models/common'
import { Button } from '@langgenius/dify-ui/button'
import { Dialog, DialogContent } from '@langgenius/dify-ui/dialog'
import { toast } from '@langgenius/dify-ui/toast'
@ -9,15 +12,10 @@ import { BookOpen01 } from '@/app/components/base/icons/src/vender/line/educatio
import { useDocLink } from '@/context/i18n'
import { addApiBasedExtension, updateApiBasedExtension } from '@/service/common'
export type ApiBasedExtensionData = {
name?: string
apiEndpoint?: string
apiKey?: string
}
type ApiBasedExtensionModalProps = {
data: ApiBasedExtension
data: Partial<ApiBasedExtensionResponse>
onCancel: () => void
onSave?: (newData: ApiBasedExtension) => void
onSave?: (newData: ApiBasedExtensionResponse) => void
}
const ApiBasedExtensionModal: FC<ApiBasedExtensionModalProps> = ({ data, onCancel, onSave }) => {
const { t } = useTranslation()
@ -35,11 +33,11 @@ const ApiBasedExtensionModal: FC<ApiBasedExtensionModalProps> = ({ data, onCance
return
}
try {
let res: ApiBasedExtension = {}
let res = {} as ApiBasedExtensionResponse
if (!data.id) {
res = await addApiBasedExtension({
url: '/api-based-extension',
body: localeData,
body: localeData as ApiBasedExtensionPayload,
})
}
else {
@ -48,7 +46,7 @@ const ApiBasedExtensionModal: FC<ApiBasedExtensionModalProps> = ({ data, onCance
body: {
...localeData,
api_key: data.api_key === localeData.api_key ? '[__HIDDEN__]' : localeData.api_key,
},
} as ApiBasedExtensionPayload,
})
toast.success(t('actionMsg.modifiedSuccessfully', { ns: 'common' }))
}

2
web/app/components/header/account-setting/api-based-extension-page/selector.tsx
View File

@ -96,7 +96,7 @@ const ApiBasedExtensionSelector: FC<ApiBasedExtensionSelectorProps> = ({
<div
key={item.id}
className="w-full cursor-pointer rounded-md px-3 py-1.5 text-left hover:stroke-state-base-hover"
onClick={() => handleSelect(item.id!)}
onClick={() => handleSelect(item.id)}
>
<div className="text-sm text-text-primary">{item.name}</div>
<div className="text-xs text-text-tertiary">{item.api_endpoint}</div>

7
web/context/modal-context-provider.tsx
View File

@ -1,5 +1,6 @@
'use client'
import type { ApiBasedExtensionResponse } from '@dify/contracts/api/console/api-based-extension/types.gen'
import type { ReactNode, SetStateAction } from 'react'
import type { ModalState, ModelModalType } from './modal-context'
import type { OpeningStatement } from '@/app/components/base/features/types'
@ -9,7 +10,7 @@ import type { ModelLoadBalancingModalProps } from '@/app/components/header/accou
import type { UpdatePluginPayload } from '@/app/components/plugins/types'
import type { InputVar } from '@/app/components/workflow/types'
import type { ExpireNoticeModalPayloadProps } from '@/app/education-apply/expire-notice-modal'
import type { ApiBasedExtension, ExternalDataTool } from '@/models/common'
import type { ExternalDataTool } from '@/models/common'
import type { ModerationConfig, PromptVariable } from '@/models/debug'
import { useCallback, useEffect, useRef, useState } from 'react'
import {
@ -89,7 +90,7 @@ export const ModalContextProvider = ({
? urlAccountModalState.payload
: DEFAULT_ACCOUNT_SETTING_TAB)
: null
const [showApiBasedExtensionModal, setShowApiBasedExtensionModal] = useState<ModalState<ApiBasedExtension> | null>(null)
const [showApiBasedExtensionModal, setShowApiBasedExtensionModal] = useState<ModalState<Partial<ApiBasedExtensionResponse>> | null>(null)
const [showModerationSettingModal, setShowModerationSettingModal] = useState<ModalState<ModerationConfig> | null>(null)
const [showExternalDataToolModal, setShowExternalDataToolModal] = useState<ModalState<ExternalDataTool> | null>(null)
const [showModelModal, setShowModelModal] = useState<ModalState<ModelModalType> | null>(null)
@ -205,7 +206,7 @@ export const ModalContextProvider = ({
showOpeningModal.onCancelCallback()
}, [showOpeningModal])
const handleSaveApiBasedExtension = (newApiBasedExtension: ApiBasedExtension) => {
const handleSaveApiBasedExtension = (newApiBasedExtension: ApiBasedExtensionResponse) => {
if (showApiBasedExtensionModal?.onSaveCallback)
showApiBasedExtensionModal.onSaveCallback(newApiBasedExtension)
setShowApiBasedExtensionModal(null)

4
web/context/modal-context.ts
View File

@ -1,5 +1,6 @@
'use client'
import type { ApiBasedExtensionResponse } from '@dify/contracts/api/console/api-based-extension/types.gen'
import type { Dispatch, SetStateAction } from 'react'
import type { TriggerEventsLimitModalPayload } from './hooks/use-trigger-events-limit-modal'
import type { OpeningStatement } from '@/app/components/base/features/types'
@ -18,7 +19,6 @@ import type { UpdatePluginPayload } from '@/app/components/plugins/types'
import type { InputVar } from '@/app/components/workflow/types'
import type { ExpireNoticeModalPayloadProps } from '@/app/education-apply/expire-notice-modal'
import type {
ApiBasedExtension,
ExternalDataTool,
} from '@/models/common'
import type { ModerationConfig, PromptVariable } from '@/models/debug'
@ -48,7 +48,7 @@ export type ModelModalType = {
export type ModalContextState = {
setShowAccountSettingModal: Dispatch<SetStateAction<ModalState<AccountSettingTab> | null>>
setShowApiBasedExtensionModal: Dispatch<SetStateAction<ModalState<ApiBasedExtension> | null>>
setShowApiBasedExtensionModal: Dispatch<SetStateAction<ModalState<Partial<ApiBasedExtensionResponse>> | null>>
setShowModerationSettingModal: Dispatch<SetStateAction<ModalState<ModerationConfig> | null>>
setShowExternalDataToolModal: Dispatch<SetStateAction<ModalState<ExternalDataTool> | null>>
setShowPricingModal: () => void

16
web/contract/router.ts
View File

@ -1,4 +1,5 @@
import type { InferContractRouterInputs } from '@orpc/contract'
import { contract as communityContract } from '@dify/contracts/api/console/orpc.gen'
import { contract as enterpriseContract } from '@dify/contracts/enterprise/orpc.gen'
import { accountAvatarContract } from './console/account'
import { appDeleteContract, appListContract, workflowOnlineUsersContract } from './console/apps'
@ -62,21 +63,27 @@ export const marketplaceRouterContract = {
export type MarketPlaceInputs = InferContractRouterInputs<typeof marketplaceRouterContract>
// Hand-written console contracts below are temporary overrides for gaps in the
// generated community contract. Prefer fixing backend OpenAPI annotations so
// generated contracts include accurate method, path, input, and output types;
// once generated contracts are correct, the matching hand-written contracts
// should be removed instead of kept in parallel.
export const consoleRouterContract = {
// `enterprise` is the only backend-generated contract wired in here. Community API contracts
// are generated too, but backend definitions are not complete enough to consume directly yet,
// so those routes stay manually maintained for now.
enterprise: enterpriseContract,
...communityContract,
account: {
...communityContract.account,
avatar: accountAvatarContract,
},
systemFeatures: systemFeaturesContract,
apps: {
...communityContract.apps,
list: appListContract,
deleteApp: appDeleteContract,
workflowOnlineUsers: workflowOnlineUsersContract,
},
explore: {
...communityContract.explore,
apps: exploreAppsContract,
appDetail: exploreAppDetailContract,
installedApps: exploreInstalledAppsContract,
@ -88,6 +95,7 @@ export const consoleRouterContract = {
banners: exploreBannersContract,
},
trialApps: {
...communityContract.trialApps,
info: trialAppInfoContract,
datasets: trialAppDatasetsContract,
parameters: trialAppParametersContract,
@ -102,6 +110,7 @@ export const consoleRouterContract = {
latestVersions: pluginLatestVersionsContract,
},
billing: {
...communityContract.billing,
invoices: invoicesContract,
bindPartnerStack: bindPartnerStackContract,
},
@ -115,6 +124,7 @@ export const consoleRouterContract = {
notification: notificationContract,
notificationDismiss: notificationDismissContract,
tags: {
...communityContract.tags,
list: tagListContract,
create: tagCreateContract,
update: tagUpdateContract,

7
web/models/common.ts
View File

@ -190,13 +190,6 @@ export type InvitationResponse = CommonResponse & {
invitation_results: InvitationResult[]
}
export type ApiBasedExtension = {
id?: string
name?: string
api_endpoint?: string
api_key?: string
}
export type CodeBasedExtensionForm = {
type: string
label: I18nText

4
web/models/log.ts
View File

@ -202,10 +202,6 @@ export type LogMessageAnnotationsRequest = Omit<LogMessageFeedbacksRequest, 'rat
export type LogMessageAnnotationsResponse = LogMessageFeedbacksResponse
export type AnnotationsCountResponse = {
count: number
}
export enum WorkflowRunTriggeredFrom {
DEBUGGING = 'debugging',
APP_RUN = 'app-run',

30
web/service/base.ts
View File

@ -830,6 +830,12 @@ export const request = async<T>(url: string, options = {}, otherOptions?: IOther
}
// request methods
/**
* @deprecated For console JSON APIs, prefer generated contract clients (`consoleClient`/`consoleQuery`)
* only after the backend OpenAPI schema produces accurate method, path, input, and output types.
* Keep this helper for endpoints whose generated contract is missing or too loose, and for non-console
* flows such as public APIs, marketplace APIs, streaming, upload, or download.
*/
export const get = <T>(url: string, options = {}, otherOptions?: IOtherOptions) => {
return request<T>(url, Object.assign({}, options, { method: 'GET' }), otherOptions)
}
@ -844,6 +850,12 @@ export const getMarketplace = <T>(url: string, options = {}, otherOptions?: IOth
return get<T>(url, options, { ...otherOptions, isMarketplaceAPI: true })
}
/**
* @deprecated For console JSON APIs, prefer generated contract clients (`consoleClient`/`consoleQuery`)
* only after the backend OpenAPI schema produces accurate method, path, input, and output types.
* Keep this helper for endpoints whose generated contract is missing or too loose, and for non-console
* flows such as public APIs, marketplace APIs, streaming, upload, or download.
*/
export const post = <T>(url: string, options = {}, otherOptions?: IOtherOptions) => {
return request<T>(url, Object.assign({}, options, { method: 'POST' }), otherOptions)
}
@ -857,10 +869,22 @@ export const postPublic = <T>(url: string, options = {}, otherOptions?: IOtherOp
return post<T>(url, options, { ...otherOptions, isPublicAPI: true })
}
/**
* @deprecated For console JSON APIs, prefer generated contract clients (`consoleClient`/`consoleQuery`)
* only after the backend OpenAPI schema produces accurate method, path, input, and output types.
* Keep this helper for endpoints whose generated contract is missing or too loose, and for non-console
* flows such as public APIs, marketplace APIs, streaming, upload, or download.
*/
export const put = <T>(url: string, options = {}, otherOptions?: IOtherOptions) => {
return request<T>(url, Object.assign({}, options, { method: 'PUT' }), otherOptions)
}
/**
* @deprecated For console JSON APIs, prefer generated contract clients (`consoleClient`/`consoleQuery`)
* only after the backend OpenAPI schema produces accurate method, path, input, and output types.
* Keep this helper for endpoints whose generated contract is missing or too loose, and for non-console
* flows such as public APIs, marketplace APIs, streaming, upload, or download.
*/
export const del = <T>(url: string, options = {}, otherOptions?: IOtherOptions) => {
return request<T>(url, Object.assign({}, options, { method: 'DELETE' }), otherOptions)
}
@ -869,6 +893,12 @@ export const delPublic = <T>(url: string, options = {}, otherOptions?: IOtherOpt
return del<T>(url, options, { ...otherOptions, isPublicAPI: true })
}
/**
* @deprecated For console JSON APIs, prefer generated contract clients (`consoleClient`/`consoleQuery`)
* only after the backend OpenAPI schema produces accurate method, path, input, and output types.
* Keep this helper for endpoints whose generated contract is missing or too loose, and for non-console
* flows such as public APIs, marketplace APIs, streaming, upload, or download.
*/
export const patch = <T>(url: string, options = {}, otherOptions?: IOtherOptions) => {
return request<T>(url, Object.assign({}, options, { method: 'PATCH' }), otherOptions)
}

22
web/service/common.ts
View File

@ -1,3 +1,8 @@
import type {
ApiBasedExtensionListResponse,
ApiBasedExtensionPayload,
ApiBasedExtensionResponse,
} from '@dify/contracts/api/console/api-based-extension/types.gen'
import type {
DefaultModelResponse,
Model,
@ -13,7 +18,6 @@ import type {
} from '@/models/app'
import type {
AccountIntegrate,
ApiBasedExtension,
CodeBasedExtension,
CommonResponse,
DataSourceNotion,
@ -271,20 +275,20 @@ export const fetchDataSourceNotionBinding = (url: string): Promise<{ result: str
return get<{ result: string }>(url)
}
export const fetchApiBasedExtensionList = (url: string): Promise<ApiBasedExtension[]> => {
return get<ApiBasedExtension[]>(url)
export const fetchApiBasedExtensionList = (url: string): Promise<ApiBasedExtensionListResponse> => {
return get<ApiBasedExtensionListResponse>(url)
}
export const fetchApiBasedExtensionDetail = (url: string): Promise<ApiBasedExtension> => {
return get<ApiBasedExtension>(url)
export const fetchApiBasedExtensionDetail = (url: string): Promise<ApiBasedExtensionResponse> => {
return get<ApiBasedExtensionResponse>(url)
}
export const addApiBasedExtension = ({ url, body }: { url: string, body: ApiBasedExtension }): Promise<ApiBasedExtension> => {
return post<ApiBasedExtension>(url, { body })
export const addApiBasedExtension = ({ url, body }: { url: string, body: ApiBasedExtensionPayload }): Promise<ApiBasedExtensionResponse> => {
return post<ApiBasedExtensionResponse>(url, { body })
}
export const updateApiBasedExtension = ({ url, body }: { url: string, body: ApiBasedExtension }): Promise<ApiBasedExtension> => {
return post<ApiBasedExtension>(url, { body })
export const updateApiBasedExtension = ({ url, body }: { url: string, body: ApiBasedExtensionPayload }): Promise<ApiBasedExtensionResponse> => {
return post<ApiBasedExtensionResponse>(url, { body })
}
export const deleteApiBasedExtension = (url: string): Promise<{ result: string }> => {

6
web/service/use-common.ts
View File

@ -7,7 +7,6 @@ import type {
} from '@/app/components/header/account-setting/model-provider-page/declarations'
import type {
AccountIntegrate,
ApiBasedExtension,
CodeBasedExtension,
CommonResponse,
FileUploadConfigResponse,
@ -24,6 +23,7 @@ import type { RETRIEVE_METHOD } from '@/types/app'
import { queryOptions, useMutation, useQuery, useQueryClient } from '@tanstack/react-query'
import { IS_DEV } from '@/config'
import { get, post } from './base'
import { consoleClient } from './client'
/**
* True iff `err` is a 401 Response thrown by `service/base.ts`.
@ -320,9 +320,9 @@ export const useCodeBasedExtensions = (module: string) => {
}
export const useApiBasedExtensions = () => {
return useQuery<ApiBasedExtension[]>({
return useQuery({
queryKey: commonQueryKeys.apiBasedExtensions,
queryFn: () => get<ApiBasedExtension[]>('/api-based-extension'),
queryFn: () => consoleClient.apiBasedExtension.get(),
})
}

10
web/service/use-log.ts
View File

@ -1,5 +1,4 @@
import type {
AnnotationsCountResponse,
ChatConversationFullDetailResponse,
ChatConversationsRequest,
ChatConversationsResponse,
@ -11,15 +10,20 @@ import type {
} from '@/models/log'
import { useQuery } from '@tanstack/react-query'
import { get } from './base'
import { consoleClient } from './client'
const NAME_SPACE = 'log'
// ============ Annotations Count ============
export const useAnnotationsCount = (appId: string) => {
return useQuery<AnnotationsCountResponse>({
return useQuery({
queryKey: [NAME_SPACE, 'annotations-count', appId],
queryFn: () => get<AnnotationsCountResponse>(`/apps/${appId}/annotations/count`),
queryFn: () => consoleClient.apps.byAppId.annotations.count.get({
params: {
app_id: appId,
},
}),
enabled: !!appId,
})
}