From ae0b67a6c30f94b8c13e11290fafa8056e440af6 Mon Sep 17 00:00:00 2001 From: Tony Xiao Date: Sun, 18 Feb 2024 11:17:54 -0800 Subject: [PATCH] chore: Regen openapi --- kits/sdk/venice.oas.d.ts | 26 ++++++++++++++++++++ kits/sdk/venice.oas.json | 32 ++++++++++++++++++------ packages/engine-backend/types.ts | 42 +++++++++++++++++--------------- 3 files changed, 72 insertions(+), 28 deletions(-) diff --git a/kits/sdk/venice.oas.d.ts b/kits/sdk/venice.oas.d.ts index 4bcaabc6..b927d4c2 100644 --- a/kits/sdk/venice.oas.d.ts +++ b/kits/sdk/venice.oas.d.ts @@ -1352,9 +1352,22 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Run sync in the background, not compatible with other options for now... */ + async?: boolean | null + /** @description Only sync resource metadata and skip pipelines */ metaOnly?: boolean | null + /** @description Remove `state` of pipeline and trigger a full resync */ fullResync?: boolean | null + /** @description + * Triggers provider to refresh data from its source + * https://plaid.com/docs/api/products/transactions/#transactionsrefresh + * This may also load historical transactions. For example, + * Finicity treats historical transaction as premium service. + * */ todo_upstreamRefresh?: boolean | null + /** @description + * See coda's implmementation. Requires adding a new message to the sync protocol + * to remove all data from a particular source_id */ todo_removeUnsyncedData?: boolean | null } } @@ -2081,9 +2094,22 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Run sync in the background, not compatible with other options for now... */ + async?: boolean | null + /** @description Only sync resource metadata and skip pipelines */ metaOnly?: boolean | null + /** @description Remove `state` of pipeline and trigger a full resync */ fullResync?: boolean | null + /** @description + * Triggers provider to refresh data from its source + * https://plaid.com/docs/api/products/transactions/#transactionsrefresh + * This may also load historical transactions. For example, + * Finicity treats historical transaction as premium service. + * */ todo_upstreamRefresh?: boolean | null + /** @description + * See coda's implmementation. Requires adding a new message to the sync protocol + * to remove all data from a particular source_id */ todo_removeUnsyncedData?: boolean | null } } diff --git a/kits/sdk/venice.oas.json b/kits/sdk/venice.oas.json index 0169a8e9..0e0948bf 100644 --- a/kits/sdk/venice.oas.json +++ b/kits/sdk/venice.oas.json @@ -763,17 +763,25 @@ "schema": { "type": "object", "properties": { + "async": { + "type": ["boolean", "null"], + "description": "Run sync in the background, not compatible with other options for now..." + }, "metaOnly": { - "type": ["boolean", "null"] + "type": ["boolean", "null"], + "description": "Only sync resource metadata and skip pipelines " }, "fullResync": { - "type": ["boolean", "null"] + "type": ["boolean", "null"], + "description": "Remove `state` of pipeline and trigger a full resync" }, "todo_upstreamRefresh": { - "type": ["boolean", "null"] + "type": ["boolean", "null"], + "description": "\n Triggers provider to refresh data from its source\n https://plaid.com/docs/api/products/transactions/#transactionsrefresh\n This may also load historical transactions. For example,\n Finicity treats historical transaction as premium service.\n " }, "todo_removeUnsyncedData": { - "type": ["boolean", "null"] + "type": ["boolean", "null"], + "description": "\n See coda's implmementation. Requires adding a new message to the sync protocol\n to remove all data from a particular source_id" } } } @@ -1727,17 +1735,25 @@ "schema": { "type": "object", "properties": { + "async": { + "type": ["boolean", "null"], + "description": "Run sync in the background, not compatible with other options for now..." + }, "metaOnly": { - "type": ["boolean", "null"] + "type": ["boolean", "null"], + "description": "Only sync resource metadata and skip pipelines " }, "fullResync": { - "type": ["boolean", "null"] + "type": ["boolean", "null"], + "description": "Remove `state` of pipeline and trigger a full resync" }, "todo_upstreamRefresh": { - "type": ["boolean", "null"] + "type": ["boolean", "null"], + "description": "\n Triggers provider to refresh data from its source\n https://plaid.com/docs/api/products/transactions/#transactionsrefresh\n This may also load historical transactions. For example,\n Finicity treats historical transaction as premium service.\n " }, "todo_removeUnsyncedData": { - "type": ["boolean", "null"] + "type": ["boolean", "null"], + "description": "\n See coda's implmementation. Requires adding a new message to the sync protocol\n to remove all data from a particular source_id" } } } diff --git a/packages/engine-backend/types.ts b/packages/engine-backend/types.ts index c75f4a2e..fad17ab0 100644 --- a/packages/engine-backend/types.ts +++ b/packages/engine-backend/types.ts @@ -54,34 +54,36 @@ export interface PipelineInput< watch?: boolean } -export const zSyncOptions = z.object({ - async: z - .boolean() - .nullish() - .describe( - 'Run sync in the background, not compatible with other options for now...', - ), +export const zSyncOptions = z + .object({ + async: z + .boolean() + .nullish() + .describe( + 'Run sync in the background, not compatible with other options for now...', + ), - metaOnly: z - .boolean() - .nullish() - .describe('Only sync resource metadata and skip pipelines '), + metaOnly: z + .boolean() + .nullish() + .describe('Only sync resource metadata and skip pipelines '), - fullResync: z - .boolean() - .nullish() - .describe('Remove `state` of pipeline and trigger a full resync'), + fullResync: z + .boolean() + .nullish() + .describe('Remove `state` of pipeline and trigger a full resync'), - todo_upstreamRefresh: z.boolean().nullish().describe(` + todo_upstreamRefresh: z.boolean().nullish().describe(` Triggers provider to refresh data from its source https://plaid.com/docs/api/products/transactions/#transactionsrefresh This may also load historical transactions. For example, Finicity treats historical transaction as premium service. `), - // See coda's implmementation. Requires adding a new message to the sync protocol - // to remove all data from a particular source_id - todo_removeUnsyncedData: z.boolean().nullish().describe(` + // See coda's implmementation. Requires adding a new message to the sync protocol + // to remove all data from a particular source_id + todo_removeUnsyncedData: z.boolean().nullish().describe(` See coda's implmementation. Requires adding a new message to the sync protocol to remove all data from a particular source_id`), -}) + }) + .openapi({ref: 'SyncOptions'})