Skip to content

Commit

Permalink
feat: converted Databox.exec into Databox.query + cleaned up other Da…
Browse files Browse the repository at this point in the history
…tabox endpoints
  • Loading branch information
calebjclark committed Dec 13, 2022
1 parent 62fe366 commit a483c3d
Showing 1 changed file with 10 additions and 27 deletions.
37 changes: 10 additions & 27 deletions specification/databox/DataboxApis.ts
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,11 @@ export const DataboxApiSchemas = {
.describe('The identities this databox allows gift card payments for (if any).'),
}),
},
'Databox.exec': {
'Databox.query': {
args: z.object({
functionName: z.string().default('default').describe('The function to execute'),
sql: z.string().describe('The SQL command(s) you want to run'),
boundValues: z.array(z.any()).optional().describe('An array of values you want to use as bound parameters'),
versionHash: databoxVersionHashValidation.describe('The hash of this unique databox version'),
input: z.any().optional().describe('Optional input parameters for this function call'),
payment: PaymentSchema.optional().describe(
'Payment for this request created with an approved Ulixee Sidechain.',
),
Expand All @@ -98,13 +98,13 @@ export const DataboxApiSchemas = {
.optional(),
}),
},
'Databox.execLocalScript': {
'Databox.queryLocalScript': {
args: z.object({
functionName: z.string().describe('The function to execute').default('default'),
sql: z.string().describe('The SQL command(s) you want to run'),
boundValues: z.array(z.any()).optional().describe('An array of values you want to use as bound parameters'),
scriptPath: z
.string()
.describe('A path to a local script to run. NOTE: API only enabled in development.'),
input: z.any().optional().describe('Optional input parameters for your databox'),
}),
result: z.object({
latestVersionHash: databoxVersionHashValidation,
Expand Down Expand Up @@ -139,31 +139,13 @@ export const DataboxApiSchemas = {
}),
result: z.any({}),
},
'Databox.queryInternalFunctionSetup': {
args: z.object({
name: z.string(),
sql: z.string(),
boundValues: z.any({}).optional(),
databoxVersionHash: z.string().optional(),
databoxInstanceId: z.string().optional(),
}),
result: z.any({}),
},
'Databox.queryInternalFunction': {
args: z.object({
name: z.string(),
sql: z.string(),
boundValues: z.any({}).optional(),
functionRecords: z.array(z.any({})),
databoxVersionHash: z.string().optional(),
databoxInstanceId: z.string().optional(),
}),
result: z.any({}),
},
'Databox.queryInternalSetup': {
args: z.object({
sql: z.string(),
boundValues: z.any({}).optional(),
input: z.any({}).optional(),
output: z.array(z.any({})),
databoxVersionHash: z.string().optional(),
databoxInstanceId: z.string().optional(),
}),
Expand All @@ -173,7 +155,8 @@ export const DataboxApiSchemas = {
args: z.object({
sql: z.string(),
boundValues: z.any({}).optional(),
functionRecordsByName: z.record(z.array(z.any({}))),
inputByFunctionName: z.record(z.any()),
outputByFunctionName: z.record(z.array(z.any({}))),
databoxVersionHash: z.string().optional(),
databoxInstanceId: z.string().optional(),
}),
Expand Down

0 comments on commit a483c3d

Please sign in to comment.