diff --git a/graphql/codegen/src/__tests__/codegen/__snapshots__/cli-generator.test.ts.snap b/graphql/codegen/src/__tests__/codegen/__snapshots__/cli-generator.test.ts.snap index 92dad2ed4..d1e1adf9c 100644 --- a/graphql/codegen/src/__tests__/codegen/__snapshots__/cli-generator.test.ts.snap +++ b/graphql/codegen/src/__tests__/codegen/__snapshots__/cli-generator.test.ts.snap @@ -295,7 +295,7 @@ CRUD operations for Car records. | \`isElectric\` | Boolean | | \`createdAt\` | Datetime | -**Create fields:** \`make\`, \`model\`, \`year\`, \`isElectric\` +**Required create fields:** \`make\`, \`model\`, \`year\`, \`isElectric\` ### \`driver\` @@ -317,7 +317,7 @@ CRUD operations for Driver records. | \`name\` | String | | \`licenseNumber\` | String | -**Create fields:** \`name\`, \`licenseNumber\` +**Required create fields:** \`name\`, \`licenseNumber\` ## Custom Operations @@ -337,8 +337,8 @@ Authenticate a user | Argument | Type | |----------|------| - | \`email\` | String (required) | - | \`password\` | String (required) | + | \`--email\` | String (required) | + | \`--password\` | String (required) | ## Output @@ -349,6 +349,14 @@ myapp car list | jq '.[]' myapp car get --id | jq '.' \`\`\` +## Non-Interactive Mode + +Use \`--no-tty\` to skip all interactive prompts (useful for scripts and CI): + +\`\`\`bash +myapp --no-tty car create --name "Sedan" --year 2024 +\`\`\` + --- Built by the [Constructive](https://constructive.io) team. @@ -454,7 +462,7 @@ myapp car list ### Create a car \`\`\`bash -myapp car create --make "value" --model "value" --year "value" --isElectric "value" +myapp car create --make --model --year --isElectric \`\`\` ### Get a car by id @@ -493,7 +501,7 @@ myapp driver list ### Create a driver \`\`\`bash -myapp driver create --name "value" --licenseNumber "value" +myapp driver create --name --licenseNumber \`\`\` ### Get a driver by id @@ -576,6 +584,9 @@ myapp auth set-token myapp car list myapp car get --id myapp car create -- + +# Non-interactive mode (skip all prompts, use flags only) +myapp --no-tty car list \`\`\` ## Examples @@ -589,6 +600,12 @@ myapp auth set-token myapp car list \`\`\` +### Non-interactive mode (for scripts and CI) + +\`\`\`bash +myapp --no-tty car create -- +\`\`\` + ## References See the \`references/\` directory for detailed per-entity API documentation: @@ -2895,7 +2912,7 @@ CRUD operations for User records. | \`email\` | String | | \`name\` | String | -**Create fields:** \`email\`, \`name\` +**Required create fields:** \`email\`, \`name\` ### \`auth:current-user\` @@ -2913,8 +2930,8 @@ Authenticate a user | Argument | Type | |----------|------| - | \`email\` | String (required) | - | \`password\` | String (required) | + | \`--email\` | String (required) | + | \`--password\` | String (required) | - **Flags:** \`--save-token\` auto-saves returned token to credentials ## members Commands @@ -2938,7 +2955,7 @@ CRUD operations for Member records. | \`id\` | UUID | | \`role\` | String | -**Create fields:** \`role\` +**Required create fields:** \`role\` ## app Commands @@ -2965,7 +2982,7 @@ CRUD operations for Car records. | \`isElectric\` | Boolean | | \`createdAt\` | Datetime | -**Create fields:** \`make\`, \`model\`, \`year\`, \`isElectric\` +**Required create fields:** \`make\`, \`model\`, \`year\`, \`isElectric\` ## Output @@ -2976,6 +2993,14 @@ myapp auth:user list | jq '.[]' myapp auth:user get --id | jq '.' \`\`\` +## Non-Interactive Mode + +Use \`--no-tty\` to skip all interactive prompts (useful for scripts and CI): + +\`\`\`bash +myapp --no-tty auth:user create --name "Example" +\`\`\` + --- Built by the [Constructive](https://constructive.io) team. @@ -3127,7 +3152,7 @@ myapp auth:user list ### Create a user \`\`\`bash -myapp auth:user create --email "value" --name "value" +myapp auth:user create --email --name \`\`\` ", "fileName": "cli-auth/references/user.md", @@ -3198,6 +3223,9 @@ CLI commands for the auth API target — 1 tables and 2 custom operations via my myapp auth:user list myapp auth:user get --id myapp auth:user create -- + +# Non-interactive mode (skip all prompts, use flags only) +myapp --no-tty auth:user list \`\`\` ## Examples @@ -3208,6 +3236,12 @@ myapp auth:user create -- myapp auth:user list \`\`\` +### Non-interactive mode (for scripts and CI) + +\`\`\`bash +myapp --no-tty auth:user create -- +\`\`\` + ## References See the \`references/\` directory for detailed per-entity API documentation: @@ -3246,7 +3280,7 @@ myapp members:member list ### Create a member \`\`\`bash -myapp members:member create --role "value" +myapp members:member create --role \`\`\` ", "fileName": "cli-members/references/member.md", @@ -3270,6 +3304,9 @@ CLI commands for the members API target — 1 tables and 0 custom operations via myapp members:member list myapp members:member get --id myapp members:member create -- + +# Non-interactive mode (skip all prompts, use flags only) +myapp --no-tty members:member list \`\`\` ## Examples @@ -3280,6 +3317,12 @@ myapp members:member create -- myapp members:member list \`\`\` +### Non-interactive mode (for scripts and CI) + +\`\`\`bash +myapp --no-tty members:member create -- +\`\`\` + ## References See the \`references/\` directory for detailed per-entity API documentation: @@ -3316,7 +3359,7 @@ myapp app:car list ### Create a car \`\`\`bash -myapp app:car create --make "value" --model "value" --year "value" --isElectric "value" +myapp app:car create --make --model --year --isElectric \`\`\` ", "fileName": "cli-app/references/car.md", @@ -3340,6 +3383,9 @@ CLI commands for the app API target — 1 tables and 0 custom operations via mya myapp app:car list myapp app:car get --id myapp app:car create -- + +# Non-interactive mode (skip all prompts, use flags only) +myapp --no-tty app:car list \`\`\` ## Examples @@ -3350,6 +3396,12 @@ myapp app:car create -- myapp app:car list \`\`\` +### Non-interactive mode (for scripts and CI) + +\`\`\`bash +myapp --no-tty app:car create -- +\`\`\` + ## References See the \`references/\` directory for detailed per-entity API documentation: diff --git a/graphql/codegen/src/core/codegen/cli/docs-generator.ts b/graphql/codegen/src/core/codegen/cli/docs-generator.ts index 414949d8f..64977c90f 100644 --- a/graphql/codegen/src/core/codegen/cli/docs-generator.ts +++ b/graphql/codegen/src/core/codegen/cli/docs-generator.ts @@ -1,8 +1,10 @@ import { toKebabCase } from 'komoji'; -import type { CleanTable, CleanOperation } from '../../../types/schema'; +import type { CleanTable, CleanOperation, TypeRegistry } from '../../../types/schema'; import { - formatArgType, + flattenArgs, + flattenedArgsToFlags, + cleanTypeName, getEditableFields, getReadmeHeader, getReadmeFooter, @@ -16,6 +18,7 @@ import { getTableNames, getPrimaryKeyInfo, } from '../utils'; +import { getFieldsWithDefaults } from './table-command-generator'; export { resolveDocsConfig } from '../docs-utils'; export type { GeneratedDocFile, McpTool } from '../docs-utils'; @@ -24,6 +27,7 @@ export function generateReadme( tables: CleanTable[], customOperations: CleanOperation[], toolName: string, + registry?: TypeRegistry, ): GeneratedDocFile { const lines: string[] = []; @@ -113,10 +117,21 @@ export function generateReadme( lines.push('| Field | Type |'); lines.push('|-------|------|'); for (const f of scalarFields) { - lines.push(`| \`${f.name}\` | ${f.type.gqlType} |`); + lines.push(`| \`${f.name}\` | ${cleanTypeName(f.type.gqlType)} |`); } lines.push(''); - lines.push(`**Create fields:** ${editableFields.map((f) => `\`${f.name}\``).join(', ')}`); + const defaultFields = getFieldsWithDefaults(table, registry); + const requiredCreate = editableFields.filter((f) => !defaultFields.has(f.name)); + const optionalCreate = editableFields.filter((f) => defaultFields.has(f.name)); + if (requiredCreate.length > 0) { + lines.push(`**Required create fields:** ${requiredCreate.map((f) => `\`${f.name}\``).join(', ')}`); + } + if (optionalCreate.length > 0) { + lines.push(`**Optional create fields (backend defaults):** ${optionalCreate.map((f) => `\`${f.name}\``).join(', ')}`); + } + if (requiredCreate.length === 0 && optionalCreate.length === 0) { + lines.push(`**Create fields:** ${editableFields.map((f) => `\`${f.name}\``).join(', ')}`); + } lines.push(''); } } @@ -126,18 +141,20 @@ export function generateReadme( lines.push(''); for (const op of customOperations) { const kebab = toKebabCase(op.name); + const flat = flattenArgs(op.args, registry); lines.push(`### \`${kebab}\``); lines.push(''); lines.push(op.description || op.name); lines.push(''); lines.push(`- **Type:** ${op.kind}`); - if (op.args.length > 0) { + if (flat.length > 0) { lines.push('- **Arguments:**'); lines.push(''); lines.push(' | Argument | Type |'); lines.push(' |----------|------|'); - for (const arg of op.args) { - lines.push(` | \`${arg.name}\` | ${formatArgType(arg)} |`); + for (const a of flat) { + const reqLabel = a.required ? ' (required)' : ''; + lines.push(` | \`--${a.flag}\` | ${a.type}${reqLabel} |`); } } else { lines.push('- **Arguments:** none'); @@ -155,6 +172,14 @@ export function generateReadme( lines.push(`${toolName} car get --id | jq '.'`); lines.push('```'); lines.push(''); + lines.push('## Non-Interactive Mode'); + lines.push(''); + lines.push('Use `--no-tty` to skip all interactive prompts (useful for scripts and CI):'); + lines.push(''); + lines.push('```bash'); + lines.push(`${toolName} --no-tty car create --name "Sedan" --year 2024`); + lines.push('```'); + lines.push(''); lines.push(...getReadmeFooter()); @@ -168,6 +193,7 @@ export function generateAgentsDocs( tables: CleanTable[], customOperations: CleanOperation[], toolName: string, + registry?: TypeRegistry, ): GeneratedDocFile { const lines: string[] = []; @@ -247,6 +273,13 @@ export function generateAgentsDocs( const pk = getPrimaryKeyInfo(table)[0]; const scalarFields = getScalarFields(table); const editableFields = getEditableFields(table); + const defaultFields = getFieldsWithDefaults(table, registry); + const requiredCreateFields = editableFields.filter((f) => !defaultFields.has(f.name)); + const optionalCreateFields = editableFields.filter((f) => defaultFields.has(f.name)); + const createFlags = [ + ...requiredCreateFields.map((f) => `--${f.name} `), + ...optionalCreateFields.map((f) => `[--${f.name} ]`), + ].join(' '); lines.push(`### TOOL: ${kebab}`); lines.push(''); @@ -256,19 +289,20 @@ export function generateAgentsDocs( lines.push('SUBCOMMANDS:'); lines.push(` ${toolName} ${kebab} list List all records`); lines.push(` ${toolName} ${kebab} get --${pk.name} Get one record`); - lines.push(` ${toolName} ${kebab} create ${editableFields.map((f) => `--${f.name} `).join(' ')}`); + lines.push(` ${toolName} ${kebab} create ${createFlags}`); lines.push(` ${toolName} ${kebab} update --${pk.name} ${editableFields.map((f) => `[--${f.name} ]`).join(' ')}`); lines.push(` ${toolName} ${kebab} delete --${pk.name} Delete one record`); lines.push(''); lines.push('INPUT FIELDS:'); for (const f of scalarFields) { const isPk = f.name === pk.name; - lines.push(` ${f.name}: ${f.type.gqlType}${isPk ? ' (primary key)' : ''}`); + lines.push(` ${f.name}: ${cleanTypeName(f.type.gqlType)}${isPk ? ' (primary key)' : ''}`); } lines.push(''); lines.push('EDITABLE FIELDS (for create/update):'); for (const f of editableFields) { - lines.push(` ${f.name}: ${f.type.gqlType}`); + const optLabel = defaultFields.has(f.name) ? ' (optional, has backend default)' : ''; + lines.push(` ${f.name}: ${cleanTypeName(f.type.gqlType)}${optLabel}`); } lines.push(''); lines.push('OUTPUT: JSON'); @@ -283,6 +317,7 @@ export function generateAgentsDocs( for (const op of customOperations) { const kebab = toKebabCase(op.name); + const flat = flattenArgs(op.args, registry); lines.push(`### TOOL: ${kebab}`); lines.push(''); @@ -290,13 +325,14 @@ export function generateAgentsDocs( lines.push(''); lines.push('```'); lines.push(`TYPE: ${op.kind}`); - if (op.args.length > 0) { - const flags = op.args.map((a) => `--${a.name} `).join(' '); + if (flat.length > 0) { + const flags = flattenedArgsToFlags(flat); lines.push(`USAGE: ${toolName} ${kebab} ${flags}`); lines.push(''); lines.push('INPUT:'); - for (const arg of op.args) { - lines.push(` ${arg.name}: ${formatArgType(arg)}`); + for (const a of flat) { + const reqLabel = a.required ? ' (required)' : ''; + lines.push(` ${a.flag}: ${a.type}${reqLabel}`); } } else { lines.push(`USAGE: ${toolName} ${kebab}`); @@ -384,6 +420,7 @@ export function getCliMcpTools( tables: CleanTable[], customOperations: CleanOperation[], toolName: string, + registry?: TypeRegistry, ): McpTool[] { const tools: McpTool[] = []; @@ -466,6 +503,10 @@ export function getCliMcpTools( const pk = getPrimaryKeyInfo(table)[0]; const scalarFields = getScalarFields(table); const editableFields = getEditableFields(table); + const defaultFields = getFieldsWithDefaults(table, registry); + const requiredCreateFieldNames = editableFields + .filter((f) => !defaultFields.has(f.name)) + .map((f) => f.name); tools.push({ name: `${toolName}_${kebab}_list`, @@ -491,7 +532,7 @@ export function getCliMcpTools( const createProps: Record = {}; for (const f of editableFields) { createProps[f.name] = { - type: gqlTypeToJsonSchemaType(f.type.gqlType), + type: gqlTypeToJsonSchemaType(cleanTypeName(f.type.gqlType)), description: `${table.name} ${f.name}`, }; } @@ -501,7 +542,7 @@ export function getCliMcpTools( inputSchema: { type: 'object', properties: createProps, - required: editableFields.map((f) => f.name), + ...(requiredCreateFieldNames.length > 0 ? { required: requiredCreateFieldNames } : {}), }, }); @@ -513,7 +554,7 @@ export function getCliMcpTools( }; for (const f of editableFields) { updateProps[f.name] = { - type: gqlTypeToJsonSchemaType(f.type.gqlType), + type: gqlTypeToJsonSchemaType(cleanTypeName(f.type.gqlType)), description: `${table.name} ${f.name}`, }; } @@ -549,7 +590,7 @@ export function getCliMcpTools( _meta: { fields: scalarFields.map((f) => ({ name: f.name, - type: f.type.gqlType, + type: cleanTypeName(f.type.gqlType), editable: editableFields.some((ef) => ef.name === f.name), primaryKey: f.name === pk.name, })), @@ -559,18 +600,17 @@ export function getCliMcpTools( for (const op of customOperations) { const kebab = toKebabCase(op.name); + const flat = flattenArgs(op.args, registry); const props: Record = {}; const required: string[] = []; - for (const arg of op.args) { - const isRequired = arg.type.kind === 'NON_NULL'; - const baseType = isRequired && arg.type.ofType ? arg.type.ofType : arg.type; - props[arg.name] = { - type: gqlTypeToJsonSchemaType(baseType.name ?? 'String'), - description: arg.description || arg.name, + for (const a of flat) { + props[a.flag] = { + type: gqlTypeToJsonSchemaType(a.type), + description: a.description || a.flag, }; - if (isRequired) { - required.push(arg.name); + if (a.required) { + required.push(a.flag); } } @@ -593,6 +633,7 @@ export function generateSkills( customOperations: CleanOperation[], toolName: string, targetName: string, + registry?: TypeRegistry, ): GeneratedDocFile[] { const files: GeneratedDocFile[] = []; const skillName = `cli-${targetName}`; @@ -659,6 +700,11 @@ export function generateSkills( const kebab = toKebabCase(singularName); const pk = getPrimaryKeyInfo(table)[0]; const editableFields = getEditableFields(table); + const defaultFields = getFieldsWithDefaults(table, registry); + const createFlags = [ + ...editableFields.filter((f) => !defaultFields.has(f.name)).map((f) => `--${f.name} `), + ...editableFields.filter((f) => defaultFields.has(f.name)).map((f) => `[--${f.name} ]`), + ].join(' '); referenceNames.push(kebab); @@ -670,7 +716,7 @@ export function generateSkills( usage: [ `${toolName} ${kebab} list`, `${toolName} ${kebab} get --${pk.name} `, - `${toolName} ${kebab} create ${editableFields.map((f) => `--${f.name} `).join(' ')}`, + `${toolName} ${kebab} create ${createFlags}`, `${toolName} ${kebab} update --${pk.name} ${editableFields.map((f) => `[--${f.name} ]`).join(' ')}`, `${toolName} ${kebab} delete --${pk.name} `, ], @@ -682,7 +728,7 @@ export function generateSkills( { description: `Create a ${singularName}`, code: [ - `${toolName} ${kebab} create ${editableFields.map((f) => `--${f.name} "value"`).join(' ')}`, + `${toolName} ${kebab} create ${createFlags}`, ], }, { @@ -697,9 +743,10 @@ export function generateSkills( // Custom operation references for (const op of customOperations) { const kebab = toKebabCase(op.name); + const flat = flattenArgs(op.args, registry); const usage = - op.args.length > 0 - ? `${toolName} ${kebab} ${op.args.map((a) => `--${a.name} `).join(' ')}` + flat.length > 0 + ? `${toolName} ${kebab} ${flattenedArgsToFlags(flat)}` : `${toolName} ${kebab}`; referenceNames.push(kebab); @@ -740,6 +787,9 @@ export function generateSkills( `${toolName} ${tableKebabs[0] || 'model'} list`, `${toolName} ${tableKebabs[0] || 'model'} get --id `, `${toolName} ${tableKebabs[0] || 'model'} create -- `, + '', + `# Non-interactive mode (skip all prompts, use flags only)`, + `${toolName} --no-tty ${tableKebabs[0] || 'model'} list`, ], examples: [ { @@ -751,6 +801,12 @@ export function generateSkills( `${toolName} ${tableKebabs[0] || 'model'} list`, ], }, + { + description: 'Non-interactive mode (for scripts and CI)', + code: [ + `${toolName} --no-tty ${tableKebabs[0] || 'model'} create -- `, + ], + }, ], }, referenceNames, @@ -763,6 +819,7 @@ export function generateSkills( export interface MultiTargetDocsInput { toolName: string; builtinNames: { auth: string; context: string }; + registry?: TypeRegistry; targets: Array<{ name: string; endpoint: string; @@ -775,7 +832,7 @@ export interface MultiTargetDocsInput { export function generateMultiTargetReadme( input: MultiTargetDocsInput, ): GeneratedDocFile { - const { toolName, builtinNames, targets } = input; + const { toolName, builtinNames, targets, registry } = input; const lines: string[] = []; lines.push(...getReadmeHeader(`${toolName} CLI`)); @@ -911,6 +968,7 @@ export function generateMultiTargetReadme( const pk = getPrimaryKeyInfo(table)[0]; const scalarFields = getScalarFields(table); const editableFields = getEditableFields(table); + const defaultFields = getFieldsWithDefaults(table, registry); lines.push(`### \`${tgt.name}:${kebab}\``); lines.push(''); @@ -929,27 +987,39 @@ export function generateMultiTargetReadme( lines.push('| Field | Type |'); lines.push('|-------|------|'); for (const f of scalarFields) { - lines.push(`| \`${f.name}\` | ${f.type.gqlType} |`); + lines.push(`| \`${f.name}\` | ${cleanTypeName(f.type.gqlType)} |`); } lines.push(''); - lines.push(`**Create fields:** ${editableFields.map((f) => `\`${f.name}\``).join(', ')}`); + const requiredCreate = editableFields.filter((f) => !defaultFields.has(f.name)); + const optionalCreate = editableFields.filter((f) => defaultFields.has(f.name)); + if (requiredCreate.length > 0) { + lines.push(`**Required create fields:** ${requiredCreate.map((f) => `\`${f.name}\``).join(', ')}`); + } + if (optionalCreate.length > 0) { + lines.push(`**Optional create fields (backend defaults):** ${optionalCreate.map((f) => `\`${f.name}\``).join(', ')}`); + } + if (requiredCreate.length === 0 && optionalCreate.length === 0) { + lines.push(`**Create fields:** ${editableFields.map((f) => `\`${f.name}\``).join(', ')}`); + } lines.push(''); } for (const op of tgt.customOperations) { const kebab = toKebabCase(op.name); + const flat = flattenArgs(op.args, registry); lines.push(`### \`${tgt.name}:${kebab}\``); lines.push(''); lines.push(op.description || op.name); lines.push(''); lines.push(`- **Type:** ${op.kind}`); - if (op.args.length > 0) { + if (flat.length > 0) { lines.push('- **Arguments:**'); lines.push(''); lines.push(' | Argument | Type |'); lines.push(' |----------|------|'); - for (const arg of op.args) { - lines.push(` | \`${arg.name}\` | ${formatArgType(arg)} |`); + for (const a of flat) { + const reqLabel = a.required ? ' (required)' : ''; + lines.push(` | \`--${a.flag}\` | ${a.type}${reqLabel} |`); } } else { lines.push('- **Arguments:** none'); @@ -974,6 +1044,18 @@ export function generateMultiTargetReadme( } lines.push('```'); lines.push(''); + lines.push('## Non-Interactive Mode'); + lines.push(''); + lines.push('Use `--no-tty` to skip all interactive prompts (useful for scripts and CI):'); + lines.push(''); + lines.push('```bash'); + if (targets.length > 0 && targets[0].tables.length > 0) { + const tgt = targets[0]; + const kebab = toKebabCase(getTableNames(tgt.tables[0]).singularName); + lines.push(`${toolName} --no-tty ${tgt.name}:${kebab} create --name "Example"`); + } + lines.push('```'); + lines.push(''); lines.push(...getReadmeFooter()); @@ -986,7 +1068,7 @@ export function generateMultiTargetReadme( export function generateMultiTargetAgentsDocs( input: MultiTargetDocsInput, ): GeneratedDocFile { - const { toolName, builtinNames, targets } = input; + const { toolName, builtinNames, targets, registry } = input; const lines: string[] = []; lines.push(`# ${toolName} CLI - Agent Reference`); @@ -1086,6 +1168,13 @@ export function generateMultiTargetAgentsDocs( const pk = getPrimaryKeyInfo(table)[0]; const scalarFields = getScalarFields(table); const editableFields = getEditableFields(table); + const defaultFields = getFieldsWithDefaults(table, registry); + const requiredCreateFields = editableFields.filter((f) => !defaultFields.has(f.name)); + const optionalCreateFields = editableFields.filter((f) => defaultFields.has(f.name)); + const createFlags = [ + ...requiredCreateFields.map((f) => `--${f.name} `), + ...optionalCreateFields.map((f) => `[--${f.name} ]`), + ].join(' '); lines.push(`### TOOL: ${tgt.name}:${kebab}`); lines.push(''); @@ -1095,19 +1184,20 @@ export function generateMultiTargetAgentsDocs( lines.push('SUBCOMMANDS:'); lines.push(` ${toolName} ${tgt.name}:${kebab} list List all records`); lines.push(` ${toolName} ${tgt.name}:${kebab} get --${pk.name} Get one record`); - lines.push(` ${toolName} ${tgt.name}:${kebab} create ${editableFields.map((f) => `--${f.name} `).join(' ')}`); + lines.push(` ${toolName} ${tgt.name}:${kebab} create ${createFlags}`); lines.push(` ${toolName} ${tgt.name}:${kebab} update --${pk.name} ${editableFields.map((f) => `[--${f.name} ]`).join(' ')}`); lines.push(` ${toolName} ${tgt.name}:${kebab} delete --${pk.name} Delete one record`); lines.push(''); lines.push('INPUT FIELDS:'); for (const f of scalarFields) { const isPk = f.name === pk.name; - lines.push(` ${f.name}: ${f.type.gqlType}${isPk ? ' (primary key)' : ''}`); + lines.push(` ${f.name}: ${cleanTypeName(f.type.gqlType)}${isPk ? ' (primary key)' : ''}`); } lines.push(''); lines.push('EDITABLE FIELDS (for create/update):'); for (const f of editableFields) { - lines.push(` ${f.name}: ${f.type.gqlType}`); + const optLabel = defaultFields.has(f.name) ? ' (optional, has backend default)' : ''; + lines.push(` ${f.name}: ${cleanTypeName(f.type.gqlType)}${optLabel}`); } lines.push(''); lines.push('OUTPUT: JSON'); @@ -1122,6 +1212,7 @@ export function generateMultiTargetAgentsDocs( for (const op of tgt.customOperations) { const kebab = toKebabCase(op.name); + const flat = flattenArgs(op.args, registry); lines.push(`### TOOL: ${tgt.name}:${kebab}`); lines.push(''); @@ -1129,13 +1220,14 @@ export function generateMultiTargetAgentsDocs( lines.push(''); lines.push('```'); lines.push(`TYPE: ${op.kind}`); - if (op.args.length > 0) { - const flags = op.args.map((a) => `--${a.name} `).join(' '); + if (flat.length > 0) { + const flags = flattenedArgsToFlags(flat); lines.push(`USAGE: ${toolName} ${tgt.name}:${kebab} ${flags}`); lines.push(''); lines.push('INPUT:'); - for (const arg of op.args) { - lines.push(` ${arg.name}: ${formatArgType(arg)}`); + for (const a of flat) { + const reqLabel = a.required ? ' (required)' : ''; + lines.push(` ${a.flag}: ${a.type}${reqLabel}`); } } else { lines.push(`USAGE: ${toolName} ${tgt.name}:${kebab}`); @@ -1233,7 +1325,7 @@ export function generateMultiTargetAgentsDocs( export function getMultiTargetCliMcpTools( input: MultiTargetDocsInput, ): McpTool[] { - const { toolName, builtinNames, targets } = input; + const { toolName, builtinNames, targets, registry } = input; const tools: McpTool[] = []; const contextEndpointProps: Record = { @@ -1322,6 +1414,10 @@ export function getMultiTargetCliMcpTools( const pk = getPrimaryKeyInfo(table)[0]; const scalarFields = getScalarFields(table); const editableFields = getEditableFields(table); + const defaultFields = getFieldsWithDefaults(table, registry); + const requiredCreateFieldNames = editableFields + .filter((f) => !defaultFields.has(f.name)) + .map((f) => f.name); const prefix = `${toolName}_${tgt.name}_${kebab}`; tools.push({ @@ -1348,7 +1444,7 @@ export function getMultiTargetCliMcpTools( const createProps: Record = {}; for (const f of editableFields) { createProps[f.name] = { - type: gqlTypeToJsonSchemaType(f.type.gqlType), + type: gqlTypeToJsonSchemaType(cleanTypeName(f.type.gqlType)), description: `${table.name} ${f.name}`, }; } @@ -1358,7 +1454,7 @@ export function getMultiTargetCliMcpTools( inputSchema: { type: 'object', properties: createProps, - required: editableFields.map((f) => f.name), + ...(requiredCreateFieldNames.length > 0 ? { required: requiredCreateFieldNames } : {}), }, }); @@ -1370,7 +1466,7 @@ export function getMultiTargetCliMcpTools( }; for (const f of editableFields) { updateProps[f.name] = { - type: gqlTypeToJsonSchemaType(f.type.gqlType), + type: gqlTypeToJsonSchemaType(cleanTypeName(f.type.gqlType)), description: `${table.name} ${f.name}`, }; } @@ -1406,7 +1502,7 @@ export function getMultiTargetCliMcpTools( _meta: { fields: scalarFields.map((f) => ({ name: f.name, - type: f.type.gqlType, + type: cleanTypeName(f.type.gqlType), editable: editableFields.some((ef) => ef.name === f.name), primaryKey: f.name === pk.name, })), @@ -1416,18 +1512,17 @@ export function getMultiTargetCliMcpTools( for (const op of tgt.customOperations) { const kebab = toKebabCase(op.name); + const flat = flattenArgs(op.args, registry); const props: Record = {}; const required: string[] = []; - for (const arg of op.args) { - const isRequired = arg.type.kind === 'NON_NULL'; - const baseType = isRequired && arg.type.ofType ? arg.type.ofType : arg.type; - props[arg.name] = { - type: gqlTypeToJsonSchemaType(baseType.name ?? 'String'), - description: arg.description || arg.name, + for (const a of flat) { + props[a.flag] = { + type: gqlTypeToJsonSchemaType(a.type), + description: a.description || a.flag, }; - if (isRequired) { - required.push(arg.name); + if (a.required) { + required.push(a.flag); } } @@ -1456,7 +1551,7 @@ export function getMultiTargetCliMcpTools( export function generateMultiTargetSkills( input: MultiTargetDocsInput, ): GeneratedDocFile[] { - const { toolName, builtinNames, targets } = input; + const { toolName, builtinNames, targets, registry } = input; const files: GeneratedDocFile[] = []; // Generate one skill per target, plus a shared cli-common skill for context/auth @@ -1566,6 +1661,11 @@ export function generateMultiTargetSkills( const kebab = toKebabCase(singularName); const pk = getPrimaryKeyInfo(table)[0]; const editableFields = getEditableFields(table); + const defaultFields = getFieldsWithDefaults(table, registry); + const createFlags = [ + ...editableFields.filter((f) => !defaultFields.has(f.name)).map((f) => `--${f.name} `), + ...editableFields.filter((f) => defaultFields.has(f.name)).map((f) => `[--${f.name} ]`), + ].join(' '); const cmd = `${tgt.name}:${kebab}`; tgtReferenceNames.push(kebab); @@ -1578,7 +1678,7 @@ export function generateMultiTargetSkills( usage: [ `${toolName} ${cmd} list`, `${toolName} ${cmd} get --${pk.name} `, - `${toolName} ${cmd} create ${editableFields.map((f) => `--${f.name} `).join(' ')}`, + `${toolName} ${cmd} create ${createFlags}`, `${toolName} ${cmd} update --${pk.name} ${editableFields.map((f) => `[--${f.name} ]`).join(' ')}`, `${toolName} ${cmd} delete --${pk.name} `, ], @@ -1590,7 +1690,7 @@ export function generateMultiTargetSkills( { description: `Create a ${singularName}`, code: [ - `${toolName} ${cmd} create ${editableFields.map((f) => `--${f.name} "value"`).join(' ')}`, + `${toolName} ${cmd} create ${createFlags}`, ], }, ], @@ -1601,9 +1701,10 @@ export function generateMultiTargetSkills( for (const op of tgt.customOperations) { const kebab = toKebabCase(op.name); const cmd = `${tgt.name}:${kebab}`; + const flat = flattenArgs(op.args, registry); const baseUsage = - op.args.length > 0 - ? `${toolName} ${cmd} ${op.args.map((a) => `--${a.name} `).join(' ')}` + flat.length > 0 + ? `${toolName} ${cmd} ${flattenedArgsToFlags(flat)}` : `${toolName} ${cmd}`; const usageLines = [baseUsage]; if (tgt.isAuthTarget && op.kind === 'mutation') { @@ -1643,12 +1744,21 @@ export function generateMultiTargetSkills( `${toolName} ${tgt.name}:${firstKebab} list`, `${toolName} ${tgt.name}:${firstKebab} get --id `, `${toolName} ${tgt.name}:${firstKebab} create -- `, + '', + `# Non-interactive mode (skip all prompts, use flags only)`, + `${toolName} --no-tty ${tgt.name}:${firstKebab} list`, ], examples: [ { description: `Query ${tgt.name} records`, code: [`${toolName} ${tgt.name}:${firstKebab} list`], }, + { + description: 'Non-interactive mode (for scripts and CI)', + code: [ + `${toolName} --no-tty ${tgt.name}:${firstKebab} create -- `, + ], + }, ], }, tgtReferenceNames, diff --git a/graphql/codegen/src/core/codegen/cli/table-command-generator.ts b/graphql/codegen/src/core/codegen/cli/table-command-generator.ts index e01d47fca..40d1b320b 100644 --- a/graphql/codegen/src/core/codegen/cli/table-command-generator.ts +++ b/graphql/codegen/src/core/codegen/cli/table-command-generator.ts @@ -433,7 +433,7 @@ function buildGetHandler(table: CleanTable, targetName?: string): t.FunctionDecl * The CreateXInput has an inner field (e.g. "database" of type DatabaseInput) * that contains the actual field definitions. */ -function resolveInnerInputType( +export function resolveInnerInputType( inputTypeName: string, typeRegistry: TypeRegistry, ): { name: string; fields: Set } | null { @@ -455,7 +455,7 @@ function resolveInnerInputType( return null; } -function getFieldsWithDefaults( +export function getFieldsWithDefaults( table: CleanTable, typeRegistry?: TypeRegistry, ): Set { diff --git a/graphql/codegen/src/core/codegen/docs-utils.ts b/graphql/codegen/src/core/codegen/docs-utils.ts index c139b3f85..33ecf6ef8 100644 --- a/graphql/codegen/src/core/codegen/docs-utils.ts +++ b/graphql/codegen/src/core/codegen/docs-utils.ts @@ -1,5 +1,5 @@ import type { DocsConfig } from '../../types/config'; -import type { CleanField, CleanOperation, CleanTable } from '../../types/schema'; +import type { CleanArgument, CleanField, CleanOperation, CleanTable, CleanTypeRef, TypeRegistry } from '../../types/schema'; import { getScalarFields, getPrimaryKeyInfo } from './utils'; export interface GeneratedDocFile { @@ -114,6 +114,134 @@ export function getEditableFields(table: CleanTable): CleanField[] { ); } +/** + * Represents a flattened argument for docs/skills generation. + * INPUT_OBJECT args are expanded to dot-notation fields. + */ +export interface FlattenedArg { + /** Flag name for CLI usage, e.g. 'input.email' or 'clientMutationId' */ + flag: string; + /** Human-readable type string */ + type: string; + /** Whether the argument is required */ + required: boolean; + /** Description from schema */ + description?: string; +} + +function unwrapNonNull(typeRef: CleanTypeRef): { inner: CleanTypeRef; required: boolean } { + if (typeRef.kind === 'NON_NULL' && typeRef.ofType) { + return { inner: typeRef.ofType, required: true }; + } + return { inner: typeRef, required: false }; +} + +function resolveBaseType(typeRef: CleanTypeRef): CleanTypeRef { + if ((typeRef.kind === 'NON_NULL' || typeRef.kind === 'LIST') && typeRef.ofType) { + return resolveBaseType(typeRef.ofType); + } + return typeRef; +} + +/** + * Strip internal type prefixes for cleaner docs display. + * e.g. 'ConstructiveInternalTypeEmail' -> 'Email' + */ +export function cleanTypeName(name: string): string { + if (name.startsWith('ConstructiveInternalType')) { + return name.slice('ConstructiveInternalType'.length); + } + return name; +} + +function getScalarTypeName(typeRef: CleanTypeRef): string { + const base = resolveBaseType(typeRef); + return cleanTypeName(base.name ?? 'String'); +} + +/** + * Flatten operation args for docs/skills, expanding INPUT_OBJECT types + * to dot-notation fields (e.g. input.email, input.password). + * Mirrors the logic in arg-mapper.ts buildQuestionsArray. + */ +/** + * Resolve inputFields for an INPUT_OBJECT type. + * Checks the CleanTypeRef first, then falls back to the TypeRegistry. + */ +function resolveInputFields( + typeRef: CleanTypeRef, + registry?: TypeRegistry, +): CleanArgument[] | undefined { + if (typeRef.inputFields && typeRef.inputFields.length > 0) { + return typeRef.inputFields; + } + if (registry && typeRef.name) { + const resolved = registry.get(typeRef.name); + if (resolved?.kind === 'INPUT_OBJECT' && resolved.inputFields && resolved.inputFields.length > 0) { + return resolved.inputFields; + } + } + return undefined; +} + +export function flattenArgs(args: CleanArgument[], registry?: TypeRegistry): FlattenedArg[] { + const result: FlattenedArg[] = []; + for (const arg of args) { + const { inner, required } = unwrapNonNull(arg.type); + const base = resolveBaseType(arg.type); + + // Try to resolve inputFields from the inner type first (unwrapped NON_NULL) + const innerFields = inner.kind === 'INPUT_OBJECT' + ? resolveInputFields(inner, registry) + : undefined; + + if (innerFields) { + for (const field of innerFields) { + const { required: fieldRequired } = unwrapNonNull(field.type); + result.push({ + flag: `${arg.name}.${field.name}`, + type: getScalarTypeName(field.type), + required: required && fieldRequired, + description: field.description, + }); + } + } else { + // Try the base type (unwrapped LIST+NON_NULL) + const baseFields = base.kind === 'INPUT_OBJECT' + ? resolveInputFields(base, registry) + : undefined; + + if (baseFields) { + for (const field of baseFields) { + const { required: fieldRequired } = unwrapNonNull(field.type); + result.push({ + flag: `${arg.name}.${field.name}`, + type: getScalarTypeName(field.type), + required: required && fieldRequired, + description: field.description, + }); + } + } else { + result.push({ + flag: arg.name, + type: getScalarTypeName(arg.type), + required, + description: arg.description, + }); + } + } + } + return result; +} + +/** + * Build CLI flags string from flattened args. + * e.g. '--input.email --input.password ' + */ +export function flattenedArgsToFlags(flatArgs: FlattenedArg[]): string { + return flatArgs.map((a) => `--${a.flag} `).join(' '); +} + export function gqlTypeToJsonSchemaType(gqlType: string): string { switch (gqlType) { case 'Int': diff --git a/graphql/codegen/src/core/generate.ts b/graphql/codegen/src/core/generate.ts index 9d0e8995d..5a707fc13 100644 --- a/graphql/codegen/src/core/generate.ts +++ b/graphql/codegen/src/core/generate.ts @@ -390,18 +390,18 @@ export async function generate( ? config.cli.toolName : 'app'; if (docsConfig.readme) { - const readme = generateCliReadme(tables, allCustomOps, toolName); + const readme = generateCliReadme(tables, allCustomOps, toolName, customOperations.typeRegistry); filesToWrite.push({ path: path.posix.join('cli', readme.fileName), content: readme.content }); } if (docsConfig.agents) { - const agents = generateCliAgentsDocs(tables, allCustomOps, toolName); + const agents = generateCliAgentsDocs(tables, allCustomOps, toolName, customOperations.typeRegistry); filesToWrite.push({ path: path.posix.join('cli', agents.fileName), content: agents.content }); } if (docsConfig.mcp) { - allMcpTools.push(...getCliMcpTools(tables, allCustomOps, toolName)); + allMcpTools.push(...getCliMcpTools(tables, allCustomOps, toolName, customOperations.typeRegistry)); } if (docsConfig.skills) { - for (const skill of generateCliSkills(tables, allCustomOps, toolName, targetName)) { + for (const skill of generateCliSkills(tables, allCustomOps, toolName, targetName, customOperations.typeRegistry)) { skillsToWrite.push({ path: skill.fileName, content: skill.content }); } } @@ -759,9 +759,20 @@ export async function generateMulti( cliConfig.builtinNames, ); + // Merge all target type registries into a combined registry for docs generation + const combinedRegistry = new Map(); + for (const t of cliTargets) { + if (t.typeRegistry) { + for (const [key, value] of t.typeRegistry) { + combinedRegistry.set(key, value); + } + } + } + const docsInput: MultiTargetDocsInput = { toolName, builtinNames, + registry: combinedRegistry.size > 0 ? combinedRegistry : undefined, targets: cliTargets.map((t) => ({ name: t.name, endpoint: t.endpoint, diff --git a/sdk/constructive-cli/src/admin/cli/README.md b/sdk/constructive-cli/src/admin/cli/README.md index aef864597..ba17c8e75 100644 --- a/sdk/constructive-cli/src/admin/cli/README.md +++ b/sdk/constructive-cli/src/admin/cli/README.md @@ -118,7 +118,7 @@ CRUD operations for OrgGetManagersRecord records. | `userId` | UUID | | `depth` | Int | -**Create fields:** `userId`, `depth` +**Required create fields:** `userId`, `depth` ### `org-get-subordinates-record` @@ -139,7 +139,7 @@ CRUD operations for OrgGetSubordinatesRecord records. | `userId` | UUID | | `depth` | Int | -**Create fields:** `userId`, `depth` +**Required create fields:** `userId`, `depth` ### `app-permission` @@ -163,7 +163,7 @@ CRUD operations for AppPermission records. | `bitstr` | BitString | | `description` | String | -**Create fields:** `name`, `bitnum`, `bitstr`, `description` +**Optional create fields (backend defaults):** `name`, `bitnum`, `bitstr`, `description` ### `org-permission` @@ -187,7 +187,7 @@ CRUD operations for OrgPermission records. | `bitstr` | BitString | | `description` | String | -**Create fields:** `name`, `bitnum`, `bitstr`, `description` +**Optional create fields (backend defaults):** `name`, `bitnum`, `bitstr`, `description` ### `app-level-requirement` @@ -214,7 +214,8 @@ CRUD operations for AppLevelRequirement records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `name`, `level`, `description`, `requiredCount`, `priority` +**Required create fields:** `name`, `level` +**Optional create fields (backend defaults):** `description`, `requiredCount`, `priority` ### `org-member` @@ -237,7 +238,8 @@ CRUD operations for OrgMember records. | `actorId` | UUID | | `entityId` | UUID | -**Create fields:** `isAdmin`, `actorId`, `entityId` +**Required create fields:** `actorId`, `entityId` +**Optional create fields (backend defaults):** `isAdmin` ### `app-permission-default` @@ -258,7 +260,7 @@ CRUD operations for AppPermissionDefault records. | `id` | UUID | | `permissions` | BitString | -**Create fields:** `permissions` +**Optional create fields (backend defaults):** `permissions` ### `org-permission-default` @@ -280,7 +282,8 @@ CRUD operations for OrgPermissionDefault records. | `permissions` | BitString | | `entityId` | UUID | -**Create fields:** `permissions`, `entityId` +**Required create fields:** `entityId` +**Optional create fields (backend defaults):** `permissions` ### `app-admin-grant` @@ -305,7 +308,8 @@ CRUD operations for AppAdminGrant records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `isGrant`, `actorId`, `grantorId` +**Required create fields:** `actorId` +**Optional create fields (backend defaults):** `isGrant`, `grantorId` ### `app-owner-grant` @@ -330,7 +334,8 @@ CRUD operations for AppOwnerGrant records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `isGrant`, `actorId`, `grantorId` +**Required create fields:** `actorId` +**Optional create fields (backend defaults):** `isGrant`, `grantorId` ### `org-admin-grant` @@ -356,7 +361,8 @@ CRUD operations for OrgAdminGrant records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `isGrant`, `actorId`, `entityId`, `grantorId` +**Required create fields:** `actorId`, `entityId` +**Optional create fields (backend defaults):** `isGrant`, `grantorId` ### `org-owner-grant` @@ -382,7 +388,8 @@ CRUD operations for OrgOwnerGrant records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `isGrant`, `actorId`, `entityId`, `grantorId` +**Required create fields:** `actorId`, `entityId` +**Optional create fields (backend defaults):** `isGrant`, `grantorId` ### `app-limit-default` @@ -404,7 +411,8 @@ CRUD operations for AppLimitDefault records. | `name` | String | | `max` | Int | -**Create fields:** `name`, `max` +**Required create fields:** `name` +**Optional create fields (backend defaults):** `max` ### `org-limit-default` @@ -426,7 +434,8 @@ CRUD operations for OrgLimitDefault records. | `name` | String | | `max` | Int | -**Create fields:** `name`, `max` +**Required create fields:** `name` +**Optional create fields (backend defaults):** `max` ### `membership-type` @@ -449,7 +458,7 @@ CRUD operations for MembershipType records. | `description` | String | | `prefix` | String | -**Create fields:** `name`, `description`, `prefix` +**Required create fields:** `name`, `description`, `prefix` ### `org-chart-edge-grant` @@ -477,7 +486,8 @@ CRUD operations for OrgChartEdgeGrant records. | `positionLevel` | Int | | `createdAt` | Datetime | -**Create fields:** `entityId`, `childId`, `parentId`, `grantorId`, `isGrant`, `positionTitle`, `positionLevel` +**Required create fields:** `entityId`, `childId`, `grantorId` +**Optional create fields (backend defaults):** `parentId`, `isGrant`, `positionTitle`, `positionLevel` ### `app-limit` @@ -501,7 +511,8 @@ CRUD operations for AppLimit records. | `num` | Int | | `max` | Int | -**Create fields:** `name`, `actorId`, `num`, `max` +**Required create fields:** `actorId` +**Optional create fields (backend defaults):** `name`, `num`, `max` ### `app-achievement` @@ -526,7 +537,8 @@ CRUD operations for AppAchievement records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `actorId`, `name`, `count` +**Required create fields:** `name` +**Optional create fields (backend defaults):** `actorId`, `count` ### `app-step` @@ -551,7 +563,8 @@ CRUD operations for AppStep records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `actorId`, `name`, `count` +**Required create fields:** `name` +**Optional create fields (backend defaults):** `actorId`, `count` ### `claimed-invite` @@ -576,7 +589,7 @@ CRUD operations for ClaimedInvite records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `data`, `senderId`, `receiverId` +**Optional create fields (backend defaults):** `data`, `senderId`, `receiverId` ### `app-grant` @@ -602,7 +615,8 @@ CRUD operations for AppGrant records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `permissions`, `isGrant`, `actorId`, `grantorId` +**Required create fields:** `actorId` +**Optional create fields (backend defaults):** `permissions`, `isGrant`, `grantorId` ### `app-membership-default` @@ -628,7 +642,7 @@ CRUD operations for AppMembershipDefault records. | `isApproved` | Boolean | | `isVerified` | Boolean | -**Create fields:** `createdBy`, `updatedBy`, `isApproved`, `isVerified` +**Optional create fields (backend defaults):** `createdBy`, `updatedBy`, `isApproved`, `isVerified` ### `org-limit` @@ -653,7 +667,8 @@ CRUD operations for OrgLimit records. | `max` | Int | | `entityId` | UUID | -**Create fields:** `name`, `actorId`, `num`, `max`, `entityId` +**Required create fields:** `actorId`, `entityId` +**Optional create fields (backend defaults):** `name`, `num`, `max` ### `org-claimed-invite` @@ -679,7 +694,8 @@ CRUD operations for OrgClaimedInvite records. | `updatedAt` | Datetime | | `entityId` | UUID | -**Create fields:** `data`, `senderId`, `receiverId`, `entityId` +**Required create fields:** `entityId` +**Optional create fields (backend defaults):** `data`, `senderId`, `receiverId` ### `org-grant` @@ -706,7 +722,8 @@ CRUD operations for OrgGrant records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `permissions`, `isGrant`, `actorId`, `entityId`, `grantorId` +**Required create fields:** `actorId`, `entityId` +**Optional create fields (backend defaults):** `permissions`, `isGrant`, `grantorId` ### `org-chart-edge` @@ -733,7 +750,8 @@ CRUD operations for OrgChartEdge records. | `positionTitle` | String | | `positionLevel` | Int | -**Create fields:** `entityId`, `childId`, `parentId`, `positionTitle`, `positionLevel` +**Required create fields:** `entityId`, `childId` +**Optional create fields (backend defaults):** `parentId`, `positionTitle`, `positionLevel` ### `org-membership-default` @@ -761,7 +779,8 @@ CRUD operations for OrgMembershipDefault records. | `deleteMemberCascadeGroups` | Boolean | | `createGroupsCascadeMembers` | Boolean | -**Create fields:** `createdBy`, `updatedBy`, `isApproved`, `entityId`, `deleteMemberCascadeGroups`, `createGroupsCascadeMembers` +**Required create fields:** `entityId` +**Optional create fields (backend defaults):** `createdBy`, `updatedBy`, `isApproved`, `deleteMemberCascadeGroups`, `createGroupsCascadeMembers` ### `invite` @@ -780,7 +799,7 @@ CRUD operations for Invite records. | Field | Type | |-------|------| | `id` | UUID | -| `email` | ConstructiveInternalTypeEmail | +| `email` | Email | | `senderId` | UUID | | `inviteToken` | String | | `inviteValid` | Boolean | @@ -792,7 +811,7 @@ CRUD operations for Invite records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `email`, `senderId`, `inviteToken`, `inviteValid`, `inviteLimit`, `inviteCount`, `multiple`, `data`, `expiresAt` +**Optional create fields (backend defaults):** `email`, `senderId`, `inviteToken`, `inviteValid`, `inviteLimit`, `inviteCount`, `multiple`, `data`, `expiresAt` ### `app-level` @@ -813,12 +832,13 @@ CRUD operations for AppLevel records. | `id` | UUID | | `name` | String | | `description` | String | -| `image` | ConstructiveInternalTypeImage | +| `image` | Image | | `ownerId` | UUID | | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `name`, `description`, `image`, `ownerId` +**Required create fields:** `name` +**Optional create fields (backend defaults):** `description`, `image`, `ownerId` ### `app-membership` @@ -853,7 +873,8 @@ CRUD operations for AppMembership records. | `actorId` | UUID | | `profileId` | UUID | -**Create fields:** `createdBy`, `updatedBy`, `isApproved`, `isBanned`, `isDisabled`, `isVerified`, `isActive`, `isOwner`, `isAdmin`, `permissions`, `granted`, `actorId`, `profileId` +**Required create fields:** `actorId` +**Optional create fields (backend defaults):** `createdBy`, `updatedBy`, `isApproved`, `isBanned`, `isDisabled`, `isVerified`, `isActive`, `isOwner`, `isAdmin`, `permissions`, `granted`, `profileId` ### `org-membership` @@ -888,7 +909,8 @@ CRUD operations for OrgMembership records. | `entityId` | UUID | | `profileId` | UUID | -**Create fields:** `createdBy`, `updatedBy`, `isApproved`, `isBanned`, `isDisabled`, `isActive`, `isOwner`, `isAdmin`, `permissions`, `granted`, `actorId`, `entityId`, `profileId` +**Required create fields:** `actorId`, `entityId` +**Optional create fields (backend defaults):** `createdBy`, `updatedBy`, `isApproved`, `isBanned`, `isDisabled`, `isActive`, `isOwner`, `isAdmin`, `permissions`, `granted`, `profileId` ### `org-invite` @@ -907,7 +929,7 @@ CRUD operations for OrgInvite records. | Field | Type | |-------|------| | `id` | UUID | -| `email` | ConstructiveInternalTypeEmail | +| `email` | Email | | `senderId` | UUID | | `receiverId` | UUID | | `inviteToken` | String | @@ -921,7 +943,8 @@ CRUD operations for OrgInvite records. | `updatedAt` | Datetime | | `entityId` | UUID | -**Create fields:** `email`, `senderId`, `receiverId`, `inviteToken`, `inviteValid`, `inviteLimit`, `inviteCount`, `multiple`, `data`, `expiresAt`, `entityId` +**Required create fields:** `entityId` +**Optional create fields (backend defaults):** `email`, `senderId`, `receiverId`, `inviteToken`, `inviteValid`, `inviteLimit`, `inviteCount`, `multiple`, `data`, `expiresAt` ## Custom Operations @@ -934,7 +957,7 @@ appPermissionsGetPaddedMask | Argument | Type | |----------|------| - | `mask` | BitString | + | `--mask` | BitString | ### `org-permissions-get-padded-mask` @@ -945,7 +968,7 @@ orgPermissionsGetPaddedMask | Argument | Type | |----------|------| - | `mask` | BitString | + | `--mask` | BitString | ### `org-is-manager-of` @@ -956,10 +979,10 @@ orgIsManagerOf | Argument | Type | |----------|------| - | `pEntityId` | UUID | - | `pManagerId` | UUID | - | `pUserId` | UUID | - | `pMaxDepth` | Int | + | `--pEntityId` | UUID | + | `--pManagerId` | UUID | + | `--pUserId` | UUID | + | `--pMaxDepth` | Int | ### `steps-achieved` @@ -970,8 +993,8 @@ stepsAchieved | Argument | Type | |----------|------| - | `vlevel` | String | - | `vroleId` | UUID | + | `--vlevel` | String | + | `--vroleId` | UUID | ### `app-permissions-get-mask` @@ -982,7 +1005,7 @@ appPermissionsGetMask | Argument | Type | |----------|------| - | `ids` | [UUID] | + | `--ids` | UUID | ### `org-permissions-get-mask` @@ -993,7 +1016,7 @@ orgPermissionsGetMask | Argument | Type | |----------|------| - | `ids` | [UUID] | + | `--ids` | UUID | ### `app-permissions-get-mask-by-names` @@ -1004,7 +1027,7 @@ appPermissionsGetMaskByNames | Argument | Type | |----------|------| - | `names` | [String] | + | `--names` | String | ### `org-permissions-get-mask-by-names` @@ -1015,7 +1038,7 @@ orgPermissionsGetMaskByNames | Argument | Type | |----------|------| - | `names` | [String] | + | `--names` | String | ### `app-permissions-get-by-mask` @@ -1026,10 +1049,10 @@ Reads and enables pagination through a set of `AppPermission`. | Argument | Type | |----------|------| - | `mask` | BitString | - | `first` | Int | - | `offset` | Int | - | `after` | Cursor | + | `--mask` | BitString | + | `--first` | Int | + | `--offset` | Int | + | `--after` | Cursor | ### `org-permissions-get-by-mask` @@ -1040,10 +1063,10 @@ Reads and enables pagination through a set of `OrgPermission`. | Argument | Type | |----------|------| - | `mask` | BitString | - | `first` | Int | - | `offset` | Int | - | `after` | Cursor | + | `--mask` | BitString | + | `--first` | Int | + | `--offset` | Int | + | `--after` | Cursor | ### `steps-required` @@ -1054,11 +1077,11 @@ Reads and enables pagination through a set of `AppLevelRequirement`. | Argument | Type | |----------|------| - | `vlevel` | String | - | `vroleId` | UUID | - | `first` | Int | - | `offset` | Int | - | `after` | Cursor | + | `--vlevel` | String | + | `--vroleId` | UUID | + | `--first` | Int | + | `--offset` | Int | + | `--after` | Cursor | ### `submit-invite-code` @@ -1069,7 +1092,8 @@ submitInviteCode | Argument | Type | |----------|------| - | `input` | SubmitInviteCodeInput (required) | + | `--input.clientMutationId` | String | + | `--input.token` | String | ### `submit-org-invite-code` @@ -1080,7 +1104,8 @@ submitOrgInviteCode | Argument | Type | |----------|------| - | `input` | SubmitOrgInviteCodeInput (required) | + | `--input.clientMutationId` | String | + | `--input.token` | String | ## Output @@ -1091,6 +1116,14 @@ csdk car list | jq '.[]' csdk car get --id | jq '.' ``` +## Non-Interactive Mode + +Use `--no-tty` to skip all interactive prompts (useful for scripts and CI): + +```bash +csdk --no-tty car create --name "Sedan" --year 2024 +``` + --- Built by the [Constructive](https://constructive.io) team. diff --git a/sdk/constructive-cli/src/auth/cli/README.md b/sdk/constructive-cli/src/auth/cli/README.md index 3d929bbdf..f52370249 100644 --- a/sdk/constructive-cli/src/auth/cli/README.md +++ b/sdk/constructive-cli/src/auth/cli/README.md @@ -100,7 +100,7 @@ CRUD operations for RoleType records. | `id` | Int | | `name` | String | -**Create fields:** `name` +**Required create fields:** `name` ### `crypto-address` @@ -126,7 +126,8 @@ CRUD operations for CryptoAddress records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `ownerId`, `address`, `isVerified`, `isPrimary` +**Required create fields:** `address` +**Optional create fields (backend defaults):** `ownerId`, `isVerified`, `isPrimary` ### `phone-number` @@ -153,7 +154,8 @@ CRUD operations for PhoneNumber records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `ownerId`, `cc`, `number`, `isVerified`, `isPrimary` +**Required create fields:** `cc`, `number` +**Optional create fields (backend defaults):** `ownerId`, `isVerified`, `isPrimary` ### `connected-account` @@ -180,7 +182,8 @@ CRUD operations for ConnectedAccount records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `ownerId`, `service`, `identifier`, `details`, `isVerified` +**Required create fields:** `service`, `identifier`, `details` +**Optional create fields (backend defaults):** `ownerId`, `isVerified` ### `audit-log` @@ -201,13 +204,14 @@ CRUD operations for AuditLog records. | `id` | UUID | | `event` | String | | `actorId` | UUID | -| `origin` | ConstructiveInternalTypeOrigin | +| `origin` | Origin | | `userAgent` | String | | `ipAddress` | InternetAddress | | `success` | Boolean | | `createdAt` | Datetime | -**Create fields:** `event`, `actorId`, `origin`, `userAgent`, `ipAddress`, `success` +**Required create fields:** `event`, `success` +**Optional create fields (backend defaults):** `actorId`, `origin`, `userAgent`, `ipAddress` ### `email` @@ -227,13 +231,14 @@ CRUD operations for Email records. |-------|------| | `id` | UUID | | `ownerId` | UUID | -| `email` | ConstructiveInternalTypeEmail | +| `email` | Email | | `isVerified` | Boolean | | `isPrimary` | Boolean | | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `ownerId`, `email`, `isVerified`, `isPrimary` +**Required create fields:** `email` +**Optional create fields (backend defaults):** `ownerId`, `isVerified`, `isPrimary` ### `user` @@ -254,14 +259,15 @@ CRUD operations for User records. | `id` | UUID | | `username` | String | | `displayName` | String | -| `profilePicture` | ConstructiveInternalTypeImage | +| `profilePicture` | Image | | `searchTsv` | FullText | | `type` | Int | | `createdAt` | Datetime | | `updatedAt` | Datetime | | `searchTsvRank` | Float | -**Create fields:** `username`, `displayName`, `profilePicture`, `searchTsv`, `type`, `searchTsvRank` +**Required create fields:** `searchTsvRank` +**Optional create fields (backend defaults):** `username`, `displayName`, `profilePicture`, `searchTsv`, `type` ## Custom Operations @@ -302,7 +308,7 @@ signOut | Argument | Type | |----------|------| - | `input` | SignOutInput (required) | + | `--input.clientMutationId` | String | ### `send-account-deletion-email` @@ -313,7 +319,7 @@ sendAccountDeletionEmail | Argument | Type | |----------|------| - | `input` | SendAccountDeletionEmailInput (required) | + | `--input.clientMutationId` | String | ### `check-password` @@ -324,7 +330,8 @@ checkPassword | Argument | Type | |----------|------| - | `input` | CheckPasswordInput (required) | + | `--input.clientMutationId` | String | + | `--input.password` | String | ### `confirm-delete-account` @@ -335,7 +342,9 @@ confirmDeleteAccount | Argument | Type | |----------|------| - | `input` | ConfirmDeleteAccountInput (required) | + | `--input.clientMutationId` | String | + | `--input.userId` | UUID | + | `--input.token` | String | ### `set-password` @@ -346,7 +355,9 @@ setPassword | Argument | Type | |----------|------| - | `input` | SetPasswordInput (required) | + | `--input.clientMutationId` | String | + | `--input.currentPassword` | String | + | `--input.newPassword` | String | ### `verify-email` @@ -357,7 +368,9 @@ verifyEmail | Argument | Type | |----------|------| - | `input` | VerifyEmailInput (required) | + | `--input.clientMutationId` | String | + | `--input.emailId` | UUID | + | `--input.token` | String | ### `reset-password` @@ -368,7 +381,10 @@ resetPassword | Argument | Type | |----------|------| - | `input` | ResetPasswordInput (required) | + | `--input.clientMutationId` | String | + | `--input.roleId` | UUID | + | `--input.resetToken` | String | + | `--input.newPassword` | String | ### `sign-in-one-time-token` @@ -379,7 +395,9 @@ signInOneTimeToken | Argument | Type | |----------|------| - | `input` | SignInOneTimeTokenInput (required) | + | `--input.clientMutationId` | String | + | `--input.token` | String | + | `--input.credentialKind` | String | ### `sign-in` @@ -390,7 +408,12 @@ signIn | Argument | Type | |----------|------| - | `input` | SignInInput (required) | + | `--input.clientMutationId` | String | + | `--input.email` | String | + | `--input.password` | String | + | `--input.rememberMe` | Boolean | + | `--input.credentialKind` | String | + | `--input.csrfToken` | String | ### `sign-up` @@ -401,7 +424,12 @@ signUp | Argument | Type | |----------|------| - | `input` | SignUpInput (required) | + | `--input.clientMutationId` | String | + | `--input.email` | String | + | `--input.password` | String | + | `--input.rememberMe` | Boolean | + | `--input.credentialKind` | String | + | `--input.csrfToken` | String | ### `one-time-token` @@ -412,7 +440,11 @@ oneTimeToken | Argument | Type | |----------|------| - | `input` | OneTimeTokenInput (required) | + | `--input.clientMutationId` | String | + | `--input.email` | String | + | `--input.password` | String | + | `--input.origin` | Origin | + | `--input.rememberMe` | Boolean | ### `extend-token-expires` @@ -423,7 +455,8 @@ extendTokenExpires | Argument | Type | |----------|------| - | `input` | ExtendTokenExpiresInput (required) | + | `--input.clientMutationId` | String | + | `--input.amount` | IntervalInput | ### `forgot-password` @@ -434,7 +467,8 @@ forgotPassword | Argument | Type | |----------|------| - | `input` | ForgotPasswordInput (required) | + | `--input.clientMutationId` | String | + | `--input.email` | Email | ### `send-verification-email` @@ -445,7 +479,8 @@ sendVerificationEmail | Argument | Type | |----------|------| - | `input` | SendVerificationEmailInput (required) | + | `--input.clientMutationId` | String | + | `--input.email` | Email | ### `verify-password` @@ -456,7 +491,8 @@ verifyPassword | Argument | Type | |----------|------| - | `input` | VerifyPasswordInput (required) | + | `--input.clientMutationId` | String | + | `--input.password` | String (required) | ### `verify-totp` @@ -467,7 +503,8 @@ verifyTotp | Argument | Type | |----------|------| - | `input` | VerifyTotpInput (required) | + | `--input.clientMutationId` | String | + | `--input.totpValue` | String (required) | ## Output @@ -478,6 +515,14 @@ csdk car list | jq '.[]' csdk car get --id | jq '.' ``` +## Non-Interactive Mode + +Use `--no-tty` to skip all interactive prompts (useful for scripts and CI): + +```bash +csdk --no-tty car create --name "Sedan" --year 2024 +``` + --- Built by the [Constructive](https://constructive.io) team. diff --git a/sdk/constructive-cli/src/objects/cli/README.md b/sdk/constructive-cli/src/objects/cli/README.md index 2a252a6cb..96810c452 100644 --- a/sdk/constructive-cli/src/objects/cli/README.md +++ b/sdk/constructive-cli/src/objects/cli/README.md @@ -90,7 +90,7 @@ CRUD operations for GetAllRecord records. | `path` | String | | `data` | JSON | -**Create fields:** `path`, `data` +**Required create fields:** `path`, `data` ### `object` @@ -117,7 +117,8 @@ CRUD operations for Object records. | `frzn` | Boolean | | `createdAt` | Datetime | -**Create fields:** `hashUuid`, `databaseId`, `kids`, `ktree`, `data`, `frzn` +**Required create fields:** `hashUuid`, `databaseId` +**Optional create fields (backend defaults):** `kids`, `ktree`, `data`, `frzn` ### `ref` @@ -141,7 +142,8 @@ CRUD operations for Ref records. | `storeId` | UUID | | `commitId` | UUID | -**Create fields:** `name`, `databaseId`, `storeId`, `commitId` +**Required create fields:** `name`, `databaseId`, `storeId` +**Optional create fields (backend defaults):** `commitId` ### `store` @@ -165,7 +167,8 @@ CRUD operations for Store records. | `hash` | UUID | | `createdAt` | Datetime | -**Create fields:** `name`, `databaseId`, `hash` +**Required create fields:** `name`, `databaseId` +**Optional create fields (backend defaults):** `hash` ### `commit` @@ -193,7 +196,8 @@ CRUD operations for Commit records. | `treeId` | UUID | | `date` | Datetime | -**Create fields:** `message`, `databaseId`, `storeId`, `parentIds`, `authorId`, `committerId`, `treeId`, `date` +**Required create fields:** `databaseId`, `storeId` +**Optional create fields (backend defaults):** `message`, `parentIds`, `authorId`, `committerId`, `treeId`, `date` ## Custom Operations @@ -206,9 +210,9 @@ revParse | Argument | Type | |----------|------| - | `dbId` | UUID | - | `storeId` | UUID | - | `refname` | String | + | `--dbId` | UUID | + | `--storeId` | UUID | + | `--refname` | String | ### `get-all-objects-from-root` @@ -219,11 +223,11 @@ Reads and enables pagination through a set of `Object`. | Argument | Type | |----------|------| - | `databaseId` | UUID | - | `id` | UUID | - | `first` | Int | - | `offset` | Int | - | `after` | Cursor | + | `--databaseId` | UUID | + | `--id` | UUID | + | `--first` | Int | + | `--offset` | Int | + | `--after` | Cursor | ### `get-path-objects-from-root` @@ -234,12 +238,12 @@ Reads and enables pagination through a set of `Object`. | Argument | Type | |----------|------| - | `databaseId` | UUID | - | `id` | UUID | - | `path` | [String] | - | `first` | Int | - | `offset` | Int | - | `after` | Cursor | + | `--databaseId` | UUID | + | `--id` | UUID | + | `--path` | String | + | `--first` | Int | + | `--offset` | Int | + | `--after` | Cursor | ### `get-object-at-path` @@ -250,10 +254,10 @@ getObjectAtPath | Argument | Type | |----------|------| - | `dbId` | UUID | - | `storeId` | UUID | - | `path` | [String] | - | `refname` | String | + | `--dbId` | UUID | + | `--storeId` | UUID | + | `--path` | String | + | `--refname` | String | ### `freeze-objects` @@ -264,7 +268,9 @@ freezeObjects | Argument | Type | |----------|------| - | `input` | FreezeObjectsInput (required) | + | `--input.clientMutationId` | String | + | `--input.databaseId` | UUID | + | `--input.id` | UUID | ### `init-empty-repo` @@ -275,7 +281,9 @@ initEmptyRepo | Argument | Type | |----------|------| - | `input` | InitEmptyRepoInput (required) | + | `--input.clientMutationId` | String | + | `--input.dbId` | UUID | + | `--input.storeId` | UUID | ### `remove-node-at-path` @@ -286,7 +294,10 @@ removeNodeAtPath | Argument | Type | |----------|------| - | `input` | RemoveNodeAtPathInput (required) | + | `--input.clientMutationId` | String | + | `--input.dbId` | UUID | + | `--input.root` | UUID | + | `--input.path` | String | ### `set-data-at-path` @@ -297,7 +308,11 @@ setDataAtPath | Argument | Type | |----------|------| - | `input` | SetDataAtPathInput (required) | + | `--input.clientMutationId` | String | + | `--input.dbId` | UUID | + | `--input.root` | UUID | + | `--input.path` | String | + | `--input.data` | JSON | ### `set-props-and-commit` @@ -308,7 +323,12 @@ setPropsAndCommit | Argument | Type | |----------|------| - | `input` | SetPropsAndCommitInput (required) | + | `--input.clientMutationId` | String | + | `--input.dbId` | UUID | + | `--input.storeId` | UUID | + | `--input.refname` | String | + | `--input.path` | String | + | `--input.data` | JSON | ### `insert-node-at-path` @@ -319,7 +339,13 @@ insertNodeAtPath | Argument | Type | |----------|------| - | `input` | InsertNodeAtPathInput (required) | + | `--input.clientMutationId` | String | + | `--input.dbId` | UUID | + | `--input.root` | UUID | + | `--input.path` | String | + | `--input.data` | JSON | + | `--input.kids` | UUID | + | `--input.ktree` | String | ### `update-node-at-path` @@ -330,7 +356,13 @@ updateNodeAtPath | Argument | Type | |----------|------| - | `input` | UpdateNodeAtPathInput (required) | + | `--input.clientMutationId` | String | + | `--input.dbId` | UUID | + | `--input.root` | UUID | + | `--input.path` | String | + | `--input.data` | JSON | + | `--input.kids` | UUID | + | `--input.ktree` | String | ### `set-and-commit` @@ -341,7 +373,14 @@ setAndCommit | Argument | Type | |----------|------| - | `input` | SetAndCommitInput (required) | + | `--input.clientMutationId` | String | + | `--input.dbId` | UUID | + | `--input.storeId` | UUID | + | `--input.refname` | String | + | `--input.path` | String | + | `--input.data` | JSON | + | `--input.kids` | UUID | + | `--input.ktree` | String | ## Output @@ -352,6 +391,14 @@ csdk car list | jq '.[]' csdk car get --id | jq '.' ``` +## Non-Interactive Mode + +Use `--no-tty` to skip all interactive prompts (useful for scripts and CI): + +```bash +csdk --no-tty car create --name "Sedan" --year 2024 +``` + --- Built by the [Constructive](https://constructive.io) team. diff --git a/sdk/constructive-cli/src/public/cli/README.md b/sdk/constructive-cli/src/public/cli/README.md index 1fb36399b..afa7a1b14 100644 --- a/sdk/constructive-cli/src/public/cli/README.md +++ b/sdk/constructive-cli/src/public/cli/README.md @@ -243,7 +243,7 @@ CRUD operations for OrgGetManagersRecord records. | `userId` | UUID | | `depth` | Int | -**Create fields:** `userId`, `depth` +**Required create fields:** `userId`, `depth` ### `org-get-subordinates-record` @@ -264,7 +264,7 @@ CRUD operations for OrgGetSubordinatesRecord records. | `userId` | UUID | | `depth` | Int | -**Create fields:** `userId`, `depth` +**Required create fields:** `userId`, `depth` ### `get-all-record` @@ -285,7 +285,7 @@ CRUD operations for GetAllRecord records. | `path` | String | | `data` | JSON | -**Create fields:** `path`, `data` +**Required create fields:** `path`, `data` ### `app-permission` @@ -309,7 +309,7 @@ CRUD operations for AppPermission records. | `bitstr` | BitString | | `description` | String | -**Create fields:** `name`, `bitnum`, `bitstr`, `description` +**Optional create fields (backend defaults):** `name`, `bitnum`, `bitstr`, `description` ### `org-permission` @@ -333,7 +333,7 @@ CRUD operations for OrgPermission records. | `bitstr` | BitString | | `description` | String | -**Create fields:** `name`, `bitnum`, `bitstr`, `description` +**Optional create fields (backend defaults):** `name`, `bitnum`, `bitstr`, `description` ### `object` @@ -360,7 +360,8 @@ CRUD operations for Object records. | `frzn` | Boolean | | `createdAt` | Datetime | -**Create fields:** `hashUuid`, `databaseId`, `kids`, `ktree`, `data`, `frzn` +**Required create fields:** `hashUuid`, `databaseId` +**Optional create fields (backend defaults):** `kids`, `ktree`, `data`, `frzn` ### `app-level-requirement` @@ -387,7 +388,8 @@ CRUD operations for AppLevelRequirement records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `name`, `level`, `description`, `requiredCount`, `priority` +**Required create fields:** `name`, `level` +**Optional create fields (backend defaults):** `description`, `requiredCount`, `priority` ### `database` @@ -414,7 +416,7 @@ CRUD operations for Database records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `ownerId`, `schemaHash`, `name`, `label`, `hash` +**Optional create fields (backend defaults):** `ownerId`, `schemaHash`, `name`, `label`, `hash` ### `schema` @@ -447,7 +449,8 @@ CRUD operations for Schema records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `databaseId`, `name`, `schemaName`, `label`, `description`, `smartTags`, `category`, `module`, `scope`, `tags`, `isPublic` +**Required create fields:** `databaseId`, `name`, `schemaName` +**Optional create fields (backend defaults):** `label`, `description`, `smartTags`, `category`, `module`, `scope`, `tags`, `isPublic` ### `table` @@ -485,7 +488,8 @@ CRUD operations for Table records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `databaseId`, `schemaId`, `name`, `label`, `description`, `smartTags`, `category`, `module`, `scope`, `useRls`, `timestamps`, `peoplestamps`, `pluralName`, `singularName`, `tags`, `inheritsId` +**Required create fields:** `schemaId`, `name` +**Optional create fields (backend defaults):** `databaseId`, `label`, `description`, `smartTags`, `category`, `module`, `scope`, `useRls`, `timestamps`, `peoplestamps`, `pluralName`, `singularName`, `tags`, `inheritsId` ### `check-constraint` @@ -518,7 +522,8 @@ CRUD operations for CheckConstraint records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `databaseId`, `tableId`, `name`, `type`, `fieldIds`, `expr`, `smartTags`, `category`, `module`, `scope`, `tags` +**Required create fields:** `tableId`, `fieldIds` +**Optional create fields (backend defaults):** `databaseId`, `name`, `type`, `expr`, `smartTags`, `category`, `module`, `scope`, `tags` ### `field` @@ -561,7 +566,8 @@ CRUD operations for Field records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `databaseId`, `tableId`, `name`, `label`, `description`, `smartTags`, `isRequired`, `defaultValue`, `defaultValueAst`, `isHidden`, `type`, `fieldOrder`, `regexp`, `chk`, `chkExpr`, `min`, `max`, `tags`, `category`, `module`, `scope` +**Required create fields:** `tableId`, `name`, `type` +**Optional create fields (backend defaults):** `databaseId`, `label`, `description`, `smartTags`, `isRequired`, `defaultValue`, `defaultValueAst`, `isHidden`, `fieldOrder`, `regexp`, `chk`, `chkExpr`, `min`, `max`, `tags`, `category`, `module`, `scope` ### `foreign-key-constraint` @@ -598,7 +604,8 @@ CRUD operations for ForeignKeyConstraint records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `databaseId`, `tableId`, `name`, `description`, `smartTags`, `type`, `fieldIds`, `refTableId`, `refFieldIds`, `deleteAction`, `updateAction`, `category`, `module`, `scope`, `tags` +**Required create fields:** `tableId`, `fieldIds`, `refTableId`, `refFieldIds` +**Optional create fields (backend defaults):** `databaseId`, `name`, `description`, `smartTags`, `type`, `deleteAction`, `updateAction`, `category`, `module`, `scope`, `tags` ### `full-text-search` @@ -626,7 +633,8 @@ CRUD operations for FullTextSearch records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `databaseId`, `tableId`, `fieldId`, `fieldIds`, `weights`, `langs` +**Required create fields:** `tableId`, `fieldId`, `fieldIds`, `weights`, `langs` +**Optional create fields (backend defaults):** `databaseId` ### `index` @@ -662,7 +670,8 @@ CRUD operations for Index records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `databaseId`, `tableId`, `name`, `fieldIds`, `includeFieldIds`, `accessMethod`, `indexParams`, `whereClause`, `isUnique`, `smartTags`, `category`, `module`, `scope`, `tags` +**Required create fields:** `databaseId`, `tableId` +**Optional create fields (backend defaults):** `name`, `fieldIds`, `includeFieldIds`, `accessMethod`, `indexParams`, `whereClause`, `isUnique`, `smartTags`, `category`, `module`, `scope`, `tags` ### `policy` @@ -698,7 +707,8 @@ CRUD operations for Policy records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `databaseId`, `tableId`, `name`, `granteeName`, `privilege`, `permissive`, `disabled`, `policyType`, `data`, `smartTags`, `category`, `module`, `scope`, `tags` +**Required create fields:** `tableId` +**Optional create fields (backend defaults):** `databaseId`, `name`, `granteeName`, `privilege`, `permissive`, `disabled`, `policyType`, `data`, `smartTags`, `category`, `module`, `scope`, `tags` ### `primary-key-constraint` @@ -730,7 +740,8 @@ CRUD operations for PrimaryKeyConstraint records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `databaseId`, `tableId`, `name`, `type`, `fieldIds`, `smartTags`, `category`, `module`, `scope`, `tags` +**Required create fields:** `tableId`, `fieldIds` +**Optional create fields (backend defaults):** `databaseId`, `name`, `type`, `smartTags`, `category`, `module`, `scope`, `tags` ### `table-grant` @@ -758,7 +769,8 @@ CRUD operations for TableGrant records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `databaseId`, `tableId`, `privilege`, `granteeName`, `fieldIds`, `isGrant` +**Required create fields:** `tableId`, `privilege`, `granteeName` +**Optional create fields (backend defaults):** `databaseId`, `fieldIds`, `isGrant` ### `trigger` @@ -790,7 +802,8 @@ CRUD operations for Trigger records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `databaseId`, `tableId`, `name`, `event`, `functionName`, `smartTags`, `category`, `module`, `scope`, `tags` +**Required create fields:** `tableId`, `name` +**Optional create fields (backend defaults):** `databaseId`, `event`, `functionName`, `smartTags`, `category`, `module`, `scope`, `tags` ### `unique-constraint` @@ -823,7 +836,8 @@ CRUD operations for UniqueConstraint records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `databaseId`, `tableId`, `name`, `description`, `smartTags`, `type`, `fieldIds`, `category`, `module`, `scope`, `tags` +**Required create fields:** `tableId`, `fieldIds` +**Optional create fields (backend defaults):** `databaseId`, `name`, `description`, `smartTags`, `type`, `category`, `module`, `scope`, `tags` ### `view` @@ -858,7 +872,8 @@ CRUD operations for View records. | `scope` | Int | | `tags` | String | -**Create fields:** `databaseId`, `schemaId`, `name`, `tableId`, `viewType`, `data`, `filterType`, `filterData`, `securityInvoker`, `isReadOnly`, `smartTags`, `category`, `module`, `scope`, `tags` +**Required create fields:** `schemaId`, `name`, `viewType` +**Optional create fields (backend defaults):** `databaseId`, `tableId`, `data`, `filterType`, `filterData`, `securityInvoker`, `isReadOnly`, `smartTags`, `category`, `module`, `scope`, `tags` ### `view-table` @@ -881,7 +896,8 @@ CRUD operations for ViewTable records. | `tableId` | UUID | | `joinOrder` | Int | -**Create fields:** `viewId`, `tableId`, `joinOrder` +**Required create fields:** `viewId`, `tableId` +**Optional create fields (backend defaults):** `joinOrder` ### `view-grant` @@ -907,7 +923,8 @@ CRUD operations for ViewGrant records. | `withGrantOption` | Boolean | | `isGrant` | Boolean | -**Create fields:** `databaseId`, `viewId`, `granteeName`, `privilege`, `withGrantOption`, `isGrant` +**Required create fields:** `viewId`, `granteeName`, `privilege` +**Optional create fields (backend defaults):** `databaseId`, `withGrantOption`, `isGrant` ### `view-rule` @@ -932,7 +949,8 @@ CRUD operations for ViewRule records. | `event` | String | | `action` | String | -**Create fields:** `databaseId`, `viewId`, `name`, `event`, `action` +**Required create fields:** `viewId`, `name`, `event` +**Optional create fields (backend defaults):** `databaseId`, `action` ### `table-module` @@ -960,7 +978,8 @@ CRUD operations for TableModule records. | `data` | JSON | | `fields` | UUID | -**Create fields:** `databaseId`, `schemaId`, `tableId`, `tableName`, `nodeType`, `useRls`, `data`, `fields` +**Required create fields:** `databaseId`, `nodeType` +**Optional create fields (backend defaults):** `schemaId`, `tableId`, `tableName`, `useRls`, `data`, `fields` ### `table-template-module` @@ -988,7 +1007,8 @@ CRUD operations for TableTemplateModule records. | `nodeType` | String | | `data` | JSON | -**Create fields:** `databaseId`, `schemaId`, `privateSchemaId`, `tableId`, `ownerTableId`, `tableName`, `nodeType`, `data` +**Required create fields:** `databaseId`, `tableName`, `nodeType` +**Optional create fields (backend defaults):** `schemaId`, `privateSchemaId`, `tableId`, `ownerTableId`, `data` ### `secure-table-provision` @@ -1024,7 +1044,8 @@ CRUD operations for SecureTableProvision records. | `policyData` | JSON | | `outFields` | UUID | -**Create fields:** `databaseId`, `schemaId`, `tableId`, `tableName`, `nodeType`, `useRls`, `nodeData`, `grantRoles`, `grantPrivileges`, `policyType`, `policyPrivileges`, `policyRole`, `policyPermissive`, `policyName`, `policyData`, `outFields` +**Required create fields:** `databaseId` +**Optional create fields (backend defaults):** `schemaId`, `tableId`, `tableName`, `nodeType`, `useRls`, `nodeData`, `grantRoles`, `grantPrivileges`, `policyType`, `policyPrivileges`, `policyRole`, `policyPermissive`, `policyName`, `policyData`, `outFields` ### `relation-provision` @@ -1071,7 +1092,8 @@ CRUD operations for RelationProvision records. | `outSourceFieldId` | UUID | | `outTargetFieldId` | UUID | -**Create fields:** `databaseId`, `relationType`, `sourceTableId`, `targetTableId`, `fieldName`, `deleteAction`, `isRequired`, `junctionTableId`, `junctionTableName`, `junctionSchemaId`, `sourceFieldName`, `targetFieldName`, `useCompositeKey`, `nodeType`, `nodeData`, `grantRoles`, `grantPrivileges`, `policyType`, `policyPrivileges`, `policyRole`, `policyPermissive`, `policyName`, `policyData`, `outFieldId`, `outJunctionTableId`, `outSourceFieldId`, `outTargetFieldId` +**Required create fields:** `databaseId`, `relationType`, `sourceTableId`, `targetTableId` +**Optional create fields (backend defaults):** `fieldName`, `deleteAction`, `isRequired`, `junctionTableId`, `junctionTableName`, `junctionSchemaId`, `sourceFieldName`, `targetFieldName`, `useCompositeKey`, `nodeType`, `nodeData`, `grantRoles`, `grantPrivileges`, `policyType`, `policyPrivileges`, `policyRole`, `policyPermissive`, `policyName`, `policyData`, `outFieldId`, `outJunctionTableId`, `outSourceFieldId`, `outTargetFieldId` ### `schema-grant` @@ -1096,7 +1118,8 @@ CRUD operations for SchemaGrant records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `databaseId`, `schemaId`, `granteeName` +**Required create fields:** `schemaId`, `granteeName` +**Optional create fields (backend defaults):** `databaseId` ### `default-privilege` @@ -1122,7 +1145,8 @@ CRUD operations for DefaultPrivilege records. | `granteeName` | String | | `isGrant` | Boolean | -**Create fields:** `databaseId`, `schemaId`, `objectType`, `privilege`, `granteeName`, `isGrant` +**Required create fields:** `schemaId`, `objectType`, `privilege`, `granteeName` +**Optional create fields (backend defaults):** `databaseId`, `isGrant` ### `api-schema` @@ -1145,7 +1169,7 @@ CRUD operations for ApiSchema records. | `schemaId` | UUID | | `apiId` | UUID | -**Create fields:** `databaseId`, `schemaId`, `apiId` +**Required create fields:** `databaseId`, `schemaId`, `apiId` ### `api-module` @@ -1169,7 +1193,7 @@ CRUD operations for ApiModule records. | `name` | String | | `data` | JSON | -**Create fields:** `databaseId`, `apiId`, `name`, `data` +**Required create fields:** `databaseId`, `apiId`, `name`, `data` ### `domain` @@ -1191,10 +1215,11 @@ CRUD operations for Domain records. | `databaseId` | UUID | | `apiId` | UUID | | `siteId` | UUID | -| `subdomain` | ConstructiveInternalTypeHostname | -| `domain` | ConstructiveInternalTypeHostname | +| `subdomain` | Hostname | +| `domain` | Hostname | -**Create fields:** `databaseId`, `apiId`, `siteId`, `subdomain`, `domain` +**Required create fields:** `databaseId` +**Optional create fields (backend defaults):** `apiId`, `siteId`, `subdomain`, `domain` ### `site-metadatum` @@ -1217,9 +1242,10 @@ CRUD operations for SiteMetadatum records. | `siteId` | UUID | | `title` | String | | `description` | String | -| `ogImage` | ConstructiveInternalTypeImage | +| `ogImage` | Image | -**Create fields:** `databaseId`, `siteId`, `title`, `description`, `ogImage` +**Required create fields:** `databaseId`, `siteId` +**Optional create fields (backend defaults):** `title`, `description`, `ogImage` ### `site-module` @@ -1243,7 +1269,7 @@ CRUD operations for SiteModule records. | `name` | String | | `data` | JSON | -**Create fields:** `databaseId`, `siteId`, `name`, `data` +**Required create fields:** `databaseId`, `siteId`, `name`, `data` ### `site-theme` @@ -1266,7 +1292,7 @@ CRUD operations for SiteTheme records. | `siteId` | UUID | | `theme` | JSON | -**Create fields:** `databaseId`, `siteId`, `theme` +**Required create fields:** `databaseId`, `siteId`, `theme` ### `trigger-function` @@ -1291,7 +1317,8 @@ CRUD operations for TriggerFunction records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `databaseId`, `name`, `code` +**Required create fields:** `databaseId`, `name` +**Optional create fields (backend defaults):** `code` ### `api` @@ -1317,7 +1344,8 @@ CRUD operations for Api records. | `anonRole` | String | | `isPublic` | Boolean | -**Create fields:** `databaseId`, `name`, `dbname`, `roleName`, `anonRole`, `isPublic` +**Required create fields:** `databaseId`, `name` +**Optional create fields (backend defaults):** `dbname`, `roleName`, `anonRole`, `isPublic` ### `site` @@ -1339,13 +1367,14 @@ CRUD operations for Site records. | `databaseId` | UUID | | `title` | String | | `description` | String | -| `ogImage` | ConstructiveInternalTypeImage | -| `favicon` | ConstructiveInternalTypeAttachment | -| `appleTouchIcon` | ConstructiveInternalTypeImage | -| `logo` | ConstructiveInternalTypeImage | +| `ogImage` | Image | +| `favicon` | Attachment | +| `appleTouchIcon` | Image | +| `logo` | Image | | `dbname` | String | -**Create fields:** `databaseId`, `title`, `description`, `ogImage`, `favicon`, `appleTouchIcon`, `logo`, `dbname` +**Required create fields:** `databaseId` +**Optional create fields (backend defaults):** `title`, `description`, `ogImage`, `favicon`, `appleTouchIcon`, `logo`, `dbname` ### `app` @@ -1367,13 +1396,14 @@ CRUD operations for App records. | `databaseId` | UUID | | `siteId` | UUID | | `name` | String | -| `appImage` | ConstructiveInternalTypeImage | -| `appStoreLink` | ConstructiveInternalTypeUrl | +| `appImage` | Image | +| `appStoreLink` | Url | | `appStoreId` | String | | `appIdPrefix` | String | -| `playStoreLink` | ConstructiveInternalTypeUrl | +| `playStoreLink` | Url | -**Create fields:** `databaseId`, `siteId`, `name`, `appImage`, `appStoreLink`, `appStoreId`, `appIdPrefix`, `playStoreLink` +**Required create fields:** `databaseId`, `siteId` +**Optional create fields (backend defaults):** `name`, `appImage`, `appStoreLink`, `appStoreId`, `appIdPrefix`, `playStoreLink` ### `connected-accounts-module` @@ -1399,7 +1429,8 @@ CRUD operations for ConnectedAccountsModule records. | `ownerTableId` | UUID | | `tableName` | String | -**Create fields:** `databaseId`, `schemaId`, `privateSchemaId`, `tableId`, `ownerTableId`, `tableName` +**Required create fields:** `databaseId`, `tableName` +**Optional create fields (backend defaults):** `schemaId`, `privateSchemaId`, `tableId`, `ownerTableId` ### `crypto-addresses-module` @@ -1426,7 +1457,8 @@ CRUD operations for CryptoAddressesModule records. | `tableName` | String | | `cryptoNetwork` | String | -**Create fields:** `databaseId`, `schemaId`, `privateSchemaId`, `tableId`, `ownerTableId`, `tableName`, `cryptoNetwork` +**Required create fields:** `databaseId`, `tableName` +**Optional create fields (backend defaults):** `schemaId`, `privateSchemaId`, `tableId`, `ownerTableId`, `cryptoNetwork` ### `crypto-auth-module` @@ -1459,7 +1491,8 @@ CRUD operations for CryptoAuthModule records. | `signUpWithKey` | String | | `signInWithChallenge` | String | -**Create fields:** `databaseId`, `schemaId`, `usersTableId`, `secretsTableId`, `sessionsTableId`, `sessionCredentialsTableId`, `addressesTableId`, `userField`, `cryptoNetwork`, `signInRequestChallenge`, `signInRecordFailure`, `signUpWithKey`, `signInWithChallenge` +**Required create fields:** `databaseId`, `userField` +**Optional create fields (backend defaults):** `schemaId`, `usersTableId`, `secretsTableId`, `sessionsTableId`, `sessionCredentialsTableId`, `addressesTableId`, `cryptoNetwork`, `signInRequestChallenge`, `signInRecordFailure`, `signUpWithKey`, `signInWithChallenge` ### `default-ids-module` @@ -1480,7 +1513,7 @@ CRUD operations for DefaultIdsModule records. | `id` | UUID | | `databaseId` | UUID | -**Create fields:** `databaseId` +**Required create fields:** `databaseId` ### `denormalized-table-field` @@ -1511,7 +1544,8 @@ CRUD operations for DenormalizedTableField records. | `funcName` | String | | `funcOrder` | Int | -**Create fields:** `databaseId`, `tableId`, `fieldId`, `setIds`, `refTableId`, `refFieldId`, `refIds`, `useUpdates`, `updateDefaults`, `funcName`, `funcOrder` +**Required create fields:** `databaseId`, `tableId`, `fieldId`, `refTableId`, `refFieldId` +**Optional create fields (backend defaults):** `setIds`, `refIds`, `useUpdates`, `updateDefaults`, `funcName`, `funcOrder` ### `emails-module` @@ -1537,7 +1571,8 @@ CRUD operations for EmailsModule records. | `ownerTableId` | UUID | | `tableName` | String | -**Create fields:** `databaseId`, `schemaId`, `privateSchemaId`, `tableId`, `ownerTableId`, `tableName` +**Required create fields:** `databaseId`, `tableName` +**Optional create fields (backend defaults):** `schemaId`, `privateSchemaId`, `tableId`, `ownerTableId` ### `encrypted-secrets-module` @@ -1561,7 +1596,8 @@ CRUD operations for EncryptedSecretsModule records. | `tableId` | UUID | | `tableName` | String | -**Create fields:** `databaseId`, `schemaId`, `tableId`, `tableName` +**Required create fields:** `databaseId` +**Optional create fields (backend defaults):** `schemaId`, `tableId`, `tableName` ### `field-module` @@ -1589,7 +1625,8 @@ CRUD operations for FieldModule records. | `triggers` | String | | `functions` | String | -**Create fields:** `databaseId`, `privateSchemaId`, `tableId`, `fieldId`, `nodeType`, `data`, `triggers`, `functions` +**Required create fields:** `databaseId`, `nodeType` +**Optional create fields (backend defaults):** `privateSchemaId`, `tableId`, `fieldId`, `data`, `triggers`, `functions` ### `invites-module` @@ -1622,7 +1659,8 @@ CRUD operations for InvitesModule records. | `membershipType` | Int | | `entityTableId` | UUID | -**Create fields:** `databaseId`, `schemaId`, `privateSchemaId`, `emailsTableId`, `usersTableId`, `invitesTableId`, `claimedInvitesTableId`, `invitesTableName`, `claimedInvitesTableName`, `submitInviteCodeFunction`, `prefix`, `membershipType`, `entityTableId` +**Required create fields:** `databaseId`, `membershipType` +**Optional create fields (backend defaults):** `schemaId`, `privateSchemaId`, `emailsTableId`, `usersTableId`, `invitesTableId`, `claimedInvitesTableId`, `invitesTableName`, `claimedInvitesTableName`, `submitInviteCodeFunction`, `prefix`, `entityTableId` ### `levels-module` @@ -1667,7 +1705,8 @@ CRUD operations for LevelsModule records. | `entityTableId` | UUID | | `actorTableId` | UUID | -**Create fields:** `databaseId`, `schemaId`, `privateSchemaId`, `stepsTableId`, `stepsTableName`, `achievementsTableId`, `achievementsTableName`, `levelsTableId`, `levelsTableName`, `levelRequirementsTableId`, `levelRequirementsTableName`, `completedStep`, `incompletedStep`, `tgAchievement`, `tgAchievementToggle`, `tgAchievementToggleBoolean`, `tgAchievementBoolean`, `upsertAchievement`, `tgUpdateAchievements`, `stepsRequired`, `levelAchieved`, `prefix`, `membershipType`, `entityTableId`, `actorTableId` +**Required create fields:** `databaseId`, `membershipType` +**Optional create fields (backend defaults):** `schemaId`, `privateSchemaId`, `stepsTableId`, `stepsTableName`, `achievementsTableId`, `achievementsTableName`, `levelsTableId`, `levelsTableName`, `levelRequirementsTableId`, `levelRequirementsTableName`, `completedStep`, `incompletedStep`, `tgAchievement`, `tgAchievementToggle`, `tgAchievementToggleBoolean`, `tgAchievementBoolean`, `upsertAchievement`, `tgUpdateAchievements`, `stepsRequired`, `levelAchieved`, `prefix`, `entityTableId`, `actorTableId` ### `limits-module` @@ -1704,7 +1743,8 @@ CRUD operations for LimitsModule records. | `entityTableId` | UUID | | `actorTableId` | UUID | -**Create fields:** `databaseId`, `schemaId`, `privateSchemaId`, `tableId`, `tableName`, `defaultTableId`, `defaultTableName`, `limitIncrementFunction`, `limitDecrementFunction`, `limitIncrementTrigger`, `limitDecrementTrigger`, `limitUpdateTrigger`, `limitCheckFunction`, `prefix`, `membershipType`, `entityTableId`, `actorTableId` +**Required create fields:** `databaseId`, `membershipType` +**Optional create fields (backend defaults):** `schemaId`, `privateSchemaId`, `tableId`, `tableName`, `defaultTableId`, `defaultTableName`, `limitIncrementFunction`, `limitDecrementFunction`, `limitIncrementTrigger`, `limitDecrementTrigger`, `limitUpdateTrigger`, `limitCheckFunction`, `prefix`, `entityTableId`, `actorTableId` ### `membership-types-module` @@ -1728,7 +1768,8 @@ CRUD operations for MembershipTypesModule records. | `tableId` | UUID | | `tableName` | String | -**Create fields:** `databaseId`, `schemaId`, `tableId`, `tableName` +**Required create fields:** `databaseId` +**Optional create fields (backend defaults):** `schemaId`, `tableId`, `tableName` ### `memberships-module` @@ -1778,7 +1819,8 @@ CRUD operations for MembershipsModule records. | `entityIdsByPerm` | String | | `entityIdsFunction` | String | -**Create fields:** `databaseId`, `schemaId`, `privateSchemaId`, `membershipsTableId`, `membershipsTableName`, `membersTableId`, `membersTableName`, `membershipDefaultsTableId`, `membershipDefaultsTableName`, `grantsTableId`, `grantsTableName`, `actorTableId`, `limitsTableId`, `defaultLimitsTableId`, `permissionsTableId`, `defaultPermissionsTableId`, `sprtTableId`, `adminGrantsTableId`, `adminGrantsTableName`, `ownerGrantsTableId`, `ownerGrantsTableName`, `membershipType`, `entityTableId`, `entityTableOwnerId`, `prefix`, `actorMaskCheck`, `actorPermCheck`, `entityIdsByMask`, `entityIdsByPerm`, `entityIdsFunction` +**Required create fields:** `databaseId`, `membershipType` +**Optional create fields (backend defaults):** `schemaId`, `privateSchemaId`, `membershipsTableId`, `membershipsTableName`, `membersTableId`, `membersTableName`, `membershipDefaultsTableId`, `membershipDefaultsTableName`, `grantsTableId`, `grantsTableName`, `actorTableId`, `limitsTableId`, `defaultLimitsTableId`, `permissionsTableId`, `defaultPermissionsTableId`, `sprtTableId`, `adminGrantsTableId`, `adminGrantsTableName`, `ownerGrantsTableId`, `ownerGrantsTableName`, `entityTableId`, `entityTableOwnerId`, `prefix`, `actorMaskCheck`, `actorPermCheck`, `entityIdsByMask`, `entityIdsByPerm`, `entityIdsFunction` ### `permissions-module` @@ -1814,7 +1856,8 @@ CRUD operations for PermissionsModule records. | `getByMask` | String | | `getMaskByName` | String | -**Create fields:** `databaseId`, `schemaId`, `privateSchemaId`, `tableId`, `tableName`, `defaultTableId`, `defaultTableName`, `bitlen`, `membershipType`, `entityTableId`, `actorTableId`, `prefix`, `getPaddedMask`, `getMask`, `getByMask`, `getMaskByName` +**Required create fields:** `databaseId`, `membershipType` +**Optional create fields (backend defaults):** `schemaId`, `privateSchemaId`, `tableId`, `tableName`, `defaultTableId`, `defaultTableName`, `bitlen`, `entityTableId`, `actorTableId`, `prefix`, `getPaddedMask`, `getMask`, `getByMask`, `getMaskByName` ### `phone-numbers-module` @@ -1840,7 +1883,8 @@ CRUD operations for PhoneNumbersModule records. | `ownerTableId` | UUID | | `tableName` | String | -**Create fields:** `databaseId`, `schemaId`, `privateSchemaId`, `tableId`, `ownerTableId`, `tableName` +**Required create fields:** `databaseId`, `tableName` +**Optional create fields (backend defaults):** `schemaId`, `privateSchemaId`, `tableId`, `ownerTableId` ### `profiles-module` @@ -1877,7 +1921,8 @@ CRUD operations for ProfilesModule records. | `membershipsTableId` | UUID | | `prefix` | String | -**Create fields:** `databaseId`, `schemaId`, `privateSchemaId`, `tableId`, `tableName`, `profilePermissionsTableId`, `profilePermissionsTableName`, `profileGrantsTableId`, `profileGrantsTableName`, `profileDefinitionGrantsTableId`, `profileDefinitionGrantsTableName`, `membershipType`, `entityTableId`, `actorTableId`, `permissionsTableId`, `membershipsTableId`, `prefix` +**Required create fields:** `databaseId`, `membershipType` +**Optional create fields (backend defaults):** `schemaId`, `privateSchemaId`, `tableId`, `tableName`, `profilePermissionsTableId`, `profilePermissionsTableName`, `profileGrantsTableId`, `profileGrantsTableName`, `profileDefinitionGrantsTableId`, `profileDefinitionGrantsTableName`, `entityTableId`, `actorTableId`, `permissionsTableId`, `membershipsTableId`, `prefix` ### `rls-module` @@ -1908,7 +1953,8 @@ CRUD operations for RlsModule records. | `currentRole` | String | | `currentRoleId` | String | -**Create fields:** `databaseId`, `apiId`, `schemaId`, `privateSchemaId`, `sessionCredentialsTableId`, `sessionsTableId`, `usersTableId`, `authenticate`, `authenticateStrict`, `currentRole`, `currentRoleId` +**Required create fields:** `databaseId` +**Optional create fields (backend defaults):** `apiId`, `schemaId`, `privateSchemaId`, `sessionCredentialsTableId`, `sessionsTableId`, `usersTableId`, `authenticate`, `authenticateStrict`, `currentRole`, `currentRoleId` ### `secrets-module` @@ -1932,7 +1978,8 @@ CRUD operations for SecretsModule records. | `tableId` | UUID | | `tableName` | String | -**Create fields:** `databaseId`, `schemaId`, `tableId`, `tableName` +**Required create fields:** `databaseId` +**Optional create fields (backend defaults):** `schemaId`, `tableId`, `tableName` ### `sessions-module` @@ -1962,7 +2009,8 @@ CRUD operations for SessionsModule records. | `sessionCredentialsTable` | String | | `authSettingsTable` | String | -**Create fields:** `databaseId`, `schemaId`, `sessionsTableId`, `sessionCredentialsTableId`, `authSettingsTableId`, `usersTableId`, `sessionsDefaultExpiration`, `sessionsTable`, `sessionCredentialsTable`, `authSettingsTable` +**Required create fields:** `databaseId` +**Optional create fields (backend defaults):** `schemaId`, `sessionsTableId`, `sessionCredentialsTableId`, `authSettingsTableId`, `usersTableId`, `sessionsDefaultExpiration`, `sessionsTable`, `sessionCredentialsTable`, `authSettingsTable` ### `user-auth-module` @@ -2007,7 +2055,8 @@ CRUD operations for UserAuthModule records. | `oneTimeTokenFunction` | String | | `extendTokenExpires` | String | -**Create fields:** `databaseId`, `schemaId`, `emailsTableId`, `usersTableId`, `secretsTableId`, `encryptedTableId`, `sessionsTableId`, `sessionCredentialsTableId`, `auditsTableId`, `auditsTableName`, `signInFunction`, `signUpFunction`, `signOutFunction`, `setPasswordFunction`, `resetPasswordFunction`, `forgotPasswordFunction`, `sendVerificationEmailFunction`, `verifyEmailFunction`, `verifyPasswordFunction`, `checkPasswordFunction`, `sendAccountDeletionEmailFunction`, `deleteAccountFunction`, `signInOneTimeTokenFunction`, `oneTimeTokenFunction`, `extendTokenExpires` +**Required create fields:** `databaseId` +**Optional create fields (backend defaults):** `schemaId`, `emailsTableId`, `usersTableId`, `secretsTableId`, `encryptedTableId`, `sessionsTableId`, `sessionCredentialsTableId`, `auditsTableId`, `auditsTableName`, `signInFunction`, `signUpFunction`, `signOutFunction`, `setPasswordFunction`, `resetPasswordFunction`, `forgotPasswordFunction`, `sendVerificationEmailFunction`, `verifyEmailFunction`, `verifyPasswordFunction`, `checkPasswordFunction`, `sendAccountDeletionEmailFunction`, `deleteAccountFunction`, `signInOneTimeTokenFunction`, `oneTimeTokenFunction`, `extendTokenExpires` ### `users-module` @@ -2033,7 +2082,8 @@ CRUD operations for UsersModule records. | `typeTableId` | UUID | | `typeTableName` | String | -**Create fields:** `databaseId`, `schemaId`, `tableId`, `tableName`, `typeTableId`, `typeTableName` +**Required create fields:** `databaseId` +**Optional create fields (backend defaults):** `schemaId`, `tableId`, `tableName`, `typeTableId`, `typeTableName` ### `uuid-module` @@ -2057,7 +2107,8 @@ CRUD operations for UuidModule records. | `uuidFunction` | String | | `uuidSeed` | String | -**Create fields:** `databaseId`, `schemaId`, `uuidFunction`, `uuidSeed` +**Required create fields:** `databaseId`, `uuidSeed` +**Optional create fields (backend defaults):** `schemaId`, `uuidFunction` ### `database-provision-module` @@ -2090,7 +2141,8 @@ CRUD operations for DatabaseProvisionModule records. | `updatedAt` | Datetime | | `completedAt` | Datetime | -**Create fields:** `databaseName`, `ownerId`, `subdomain`, `domain`, `modules`, `options`, `bootstrapUser`, `status`, `errorMessage`, `databaseId`, `completedAt` +**Required create fields:** `databaseName`, `ownerId`, `domain` +**Optional create fields (backend defaults):** `subdomain`, `modules`, `options`, `bootstrapUser`, `status`, `errorMessage`, `databaseId`, `completedAt` ### `app-admin-grant` @@ -2115,7 +2167,8 @@ CRUD operations for AppAdminGrant records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `isGrant`, `actorId`, `grantorId` +**Required create fields:** `actorId` +**Optional create fields (backend defaults):** `isGrant`, `grantorId` ### `app-owner-grant` @@ -2140,7 +2193,8 @@ CRUD operations for AppOwnerGrant records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `isGrant`, `actorId`, `grantorId` +**Required create fields:** `actorId` +**Optional create fields (backend defaults):** `isGrant`, `grantorId` ### `app-grant` @@ -2166,7 +2220,8 @@ CRUD operations for AppGrant records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `permissions`, `isGrant`, `actorId`, `grantorId` +**Required create fields:** `actorId` +**Optional create fields (backend defaults):** `permissions`, `isGrant`, `grantorId` ### `org-membership` @@ -2201,7 +2256,8 @@ CRUD operations for OrgMembership records. | `entityId` | UUID | | `profileId` | UUID | -**Create fields:** `createdBy`, `updatedBy`, `isApproved`, `isBanned`, `isDisabled`, `isActive`, `isOwner`, `isAdmin`, `permissions`, `granted`, `actorId`, `entityId`, `profileId` +**Required create fields:** `actorId`, `entityId` +**Optional create fields (backend defaults):** `createdBy`, `updatedBy`, `isApproved`, `isBanned`, `isDisabled`, `isActive`, `isOwner`, `isAdmin`, `permissions`, `granted`, `profileId` ### `org-member` @@ -2224,7 +2280,8 @@ CRUD operations for OrgMember records. | `actorId` | UUID | | `entityId` | UUID | -**Create fields:** `isAdmin`, `actorId`, `entityId` +**Required create fields:** `actorId`, `entityId` +**Optional create fields (backend defaults):** `isAdmin` ### `org-admin-grant` @@ -2250,7 +2307,8 @@ CRUD operations for OrgAdminGrant records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `isGrant`, `actorId`, `entityId`, `grantorId` +**Required create fields:** `actorId`, `entityId` +**Optional create fields (backend defaults):** `isGrant`, `grantorId` ### `org-owner-grant` @@ -2276,7 +2334,8 @@ CRUD operations for OrgOwnerGrant records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `isGrant`, `actorId`, `entityId`, `grantorId` +**Required create fields:** `actorId`, `entityId` +**Optional create fields (backend defaults):** `isGrant`, `grantorId` ### `org-grant` @@ -2303,7 +2362,8 @@ CRUD operations for OrgGrant records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `permissions`, `isGrant`, `actorId`, `entityId`, `grantorId` +**Required create fields:** `actorId`, `entityId` +**Optional create fields (backend defaults):** `permissions`, `isGrant`, `grantorId` ### `org-chart-edge` @@ -2330,7 +2390,8 @@ CRUD operations for OrgChartEdge records. | `positionTitle` | String | | `positionLevel` | Int | -**Create fields:** `entityId`, `childId`, `parentId`, `positionTitle`, `positionLevel` +**Required create fields:** `entityId`, `childId` +**Optional create fields (backend defaults):** `parentId`, `positionTitle`, `positionLevel` ### `org-chart-edge-grant` @@ -2358,7 +2419,8 @@ CRUD operations for OrgChartEdgeGrant records. | `positionLevel` | Int | | `createdAt` | Datetime | -**Create fields:** `entityId`, `childId`, `parentId`, `grantorId`, `isGrant`, `positionTitle`, `positionLevel` +**Required create fields:** `entityId`, `childId`, `grantorId` +**Optional create fields (backend defaults):** `parentId`, `isGrant`, `positionTitle`, `positionLevel` ### `app-limit` @@ -2382,7 +2444,8 @@ CRUD operations for AppLimit records. | `num` | Int | | `max` | Int | -**Create fields:** `name`, `actorId`, `num`, `max` +**Required create fields:** `actorId` +**Optional create fields (backend defaults):** `name`, `num`, `max` ### `org-limit` @@ -2407,7 +2470,8 @@ CRUD operations for OrgLimit records. | `max` | Int | | `entityId` | UUID | -**Create fields:** `name`, `actorId`, `num`, `max`, `entityId` +**Required create fields:** `actorId`, `entityId` +**Optional create fields (backend defaults):** `name`, `num`, `max` ### `app-step` @@ -2432,7 +2496,8 @@ CRUD operations for AppStep records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `actorId`, `name`, `count` +**Required create fields:** `name` +**Optional create fields (backend defaults):** `actorId`, `count` ### `app-achievement` @@ -2457,7 +2522,8 @@ CRUD operations for AppAchievement records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `actorId`, `name`, `count` +**Required create fields:** `name` +**Optional create fields (backend defaults):** `actorId`, `count` ### `invite` @@ -2476,7 +2542,7 @@ CRUD operations for Invite records. | Field | Type | |-------|------| | `id` | UUID | -| `email` | ConstructiveInternalTypeEmail | +| `email` | Email | | `senderId` | UUID | | `inviteToken` | String | | `inviteValid` | Boolean | @@ -2488,7 +2554,7 @@ CRUD operations for Invite records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `email`, `senderId`, `inviteToken`, `inviteValid`, `inviteLimit`, `inviteCount`, `multiple`, `data`, `expiresAt` +**Optional create fields (backend defaults):** `email`, `senderId`, `inviteToken`, `inviteValid`, `inviteLimit`, `inviteCount`, `multiple`, `data`, `expiresAt` ### `claimed-invite` @@ -2513,7 +2579,7 @@ CRUD operations for ClaimedInvite records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `data`, `senderId`, `receiverId` +**Optional create fields (backend defaults):** `data`, `senderId`, `receiverId` ### `org-invite` @@ -2532,7 +2598,7 @@ CRUD operations for OrgInvite records. | Field | Type | |-------|------| | `id` | UUID | -| `email` | ConstructiveInternalTypeEmail | +| `email` | Email | | `senderId` | UUID | | `receiverId` | UUID | | `inviteToken` | String | @@ -2546,7 +2612,8 @@ CRUD operations for OrgInvite records. | `updatedAt` | Datetime | | `entityId` | UUID | -**Create fields:** `email`, `senderId`, `receiverId`, `inviteToken`, `inviteValid`, `inviteLimit`, `inviteCount`, `multiple`, `data`, `expiresAt`, `entityId` +**Required create fields:** `entityId` +**Optional create fields (backend defaults):** `email`, `senderId`, `receiverId`, `inviteToken`, `inviteValid`, `inviteLimit`, `inviteCount`, `multiple`, `data`, `expiresAt` ### `org-claimed-invite` @@ -2572,7 +2639,8 @@ CRUD operations for OrgClaimedInvite records. | `updatedAt` | Datetime | | `entityId` | UUID | -**Create fields:** `data`, `senderId`, `receiverId`, `entityId` +**Required create fields:** `entityId` +**Optional create fields (backend defaults):** `data`, `senderId`, `receiverId` ### `ref` @@ -2596,7 +2664,8 @@ CRUD operations for Ref records. | `storeId` | UUID | | `commitId` | UUID | -**Create fields:** `name`, `databaseId`, `storeId`, `commitId` +**Required create fields:** `name`, `databaseId`, `storeId` +**Optional create fields (backend defaults):** `commitId` ### `store` @@ -2620,7 +2689,8 @@ CRUD operations for Store records. | `hash` | UUID | | `createdAt` | Datetime | -**Create fields:** `name`, `databaseId`, `hash` +**Required create fields:** `name`, `databaseId` +**Optional create fields (backend defaults):** `hash` ### `app-permission-default` @@ -2641,7 +2711,7 @@ CRUD operations for AppPermissionDefault records. | `id` | UUID | | `permissions` | BitString | -**Create fields:** `permissions` +**Optional create fields (backend defaults):** `permissions` ### `role-type` @@ -2662,7 +2732,7 @@ CRUD operations for RoleType records. | `id` | Int | | `name` | String | -**Create fields:** `name` +**Required create fields:** `name` ### `org-permission-default` @@ -2684,7 +2754,8 @@ CRUD operations for OrgPermissionDefault records. | `permissions` | BitString | | `entityId` | UUID | -**Create fields:** `permissions`, `entityId` +**Required create fields:** `entityId` +**Optional create fields (backend defaults):** `permissions` ### `crypto-address` @@ -2710,7 +2781,8 @@ CRUD operations for CryptoAddress records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `ownerId`, `address`, `isVerified`, `isPrimary` +**Required create fields:** `address` +**Optional create fields (backend defaults):** `ownerId`, `isVerified`, `isPrimary` ### `app-limit-default` @@ -2732,7 +2804,8 @@ CRUD operations for AppLimitDefault records. | `name` | String | | `max` | Int | -**Create fields:** `name`, `max` +**Required create fields:** `name` +**Optional create fields (backend defaults):** `max` ### `org-limit-default` @@ -2754,7 +2827,8 @@ CRUD operations for OrgLimitDefault records. | `name` | String | | `max` | Int | -**Create fields:** `name`, `max` +**Required create fields:** `name` +**Optional create fields (backend defaults):** `max` ### `connected-account` @@ -2781,7 +2855,8 @@ CRUD operations for ConnectedAccount records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `ownerId`, `service`, `identifier`, `details`, `isVerified` +**Required create fields:** `service`, `identifier`, `details` +**Optional create fields (backend defaults):** `ownerId`, `isVerified` ### `phone-number` @@ -2808,7 +2883,8 @@ CRUD operations for PhoneNumber records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `ownerId`, `cc`, `number`, `isVerified`, `isPrimary` +**Required create fields:** `cc`, `number` +**Optional create fields (backend defaults):** `ownerId`, `isVerified`, `isPrimary` ### `membership-type` @@ -2831,7 +2907,7 @@ CRUD operations for MembershipType records. | `description` | String | | `prefix` | String | -**Create fields:** `name`, `description`, `prefix` +**Required create fields:** `name`, `description`, `prefix` ### `node-type-registry` @@ -2859,7 +2935,8 @@ CRUD operations for NodeTypeRegistry records. | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `slug`, `category`, `displayName`, `description`, `parameterSchema`, `tags` +**Required create fields:** `slug`, `category` +**Optional create fields (backend defaults):** `displayName`, `description`, `parameterSchema`, `tags` ### `app-membership-default` @@ -2885,7 +2962,7 @@ CRUD operations for AppMembershipDefault records. | `isApproved` | Boolean | | `isVerified` | Boolean | -**Create fields:** `createdBy`, `updatedBy`, `isApproved`, `isVerified` +**Optional create fields (backend defaults):** `createdBy`, `updatedBy`, `isApproved`, `isVerified` ### `commit` @@ -2913,7 +2990,8 @@ CRUD operations for Commit records. | `treeId` | UUID | | `date` | Datetime | -**Create fields:** `message`, `databaseId`, `storeId`, `parentIds`, `authorId`, `committerId`, `treeId`, `date` +**Required create fields:** `databaseId`, `storeId` +**Optional create fields (backend defaults):** `message`, `parentIds`, `authorId`, `committerId`, `treeId`, `date` ### `org-membership-default` @@ -2941,7 +3019,8 @@ CRUD operations for OrgMembershipDefault records. | `deleteMemberCascadeGroups` | Boolean | | `createGroupsCascadeMembers` | Boolean | -**Create fields:** `createdBy`, `updatedBy`, `isApproved`, `entityId`, `deleteMemberCascadeGroups`, `createGroupsCascadeMembers` +**Required create fields:** `entityId` +**Optional create fields (backend defaults):** `createdBy`, `updatedBy`, `isApproved`, `deleteMemberCascadeGroups`, `createGroupsCascadeMembers` ### `audit-log` @@ -2962,13 +3041,14 @@ CRUD operations for AuditLog records. | `id` | UUID | | `event` | String | | `actorId` | UUID | -| `origin` | ConstructiveInternalTypeOrigin | +| `origin` | Origin | | `userAgent` | String | | `ipAddress` | InternetAddress | | `success` | Boolean | | `createdAt` | Datetime | -**Create fields:** `event`, `actorId`, `origin`, `userAgent`, `ipAddress`, `success` +**Required create fields:** `event`, `success` +**Optional create fields (backend defaults):** `actorId`, `origin`, `userAgent`, `ipAddress` ### `app-level` @@ -2989,12 +3069,13 @@ CRUD operations for AppLevel records. | `id` | UUID | | `name` | String | | `description` | String | -| `image` | ConstructiveInternalTypeImage | +| `image` | Image | | `ownerId` | UUID | | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `name`, `description`, `image`, `ownerId` +**Required create fields:** `name` +**Optional create fields (backend defaults):** `description`, `image`, `ownerId` ### `email` @@ -3014,13 +3095,14 @@ CRUD operations for Email records. |-------|------| | `id` | UUID | | `ownerId` | UUID | -| `email` | ConstructiveInternalTypeEmail | +| `email` | Email | | `isVerified` | Boolean | | `isPrimary` | Boolean | | `createdAt` | Datetime | | `updatedAt` | Datetime | -**Create fields:** `ownerId`, `email`, `isVerified`, `isPrimary` +**Required create fields:** `email` +**Optional create fields (backend defaults):** `ownerId`, `isVerified`, `isPrimary` ### `sql-migration` @@ -3052,7 +3134,7 @@ CRUD operations for SqlMigration records. | `actionId` | UUID | | `actorId` | UUID | -**Create fields:** `name`, `databaseId`, `deploy`, `deps`, `payload`, `content`, `revert`, `verify`, `action`, `actionId`, `actorId` +**Optional create fields (backend defaults):** `name`, `databaseId`, `deploy`, `deps`, `payload`, `content`, `revert`, `verify`, `action`, `actionId`, `actorId` ### `ast-migration` @@ -3084,7 +3166,7 @@ CRUD operations for AstMigration records. | `actionId` | UUID | | `actorId` | UUID | -**Create fields:** `databaseId`, `name`, `requires`, `payload`, `deploys`, `deploy`, `revert`, `verify`, `action`, `actionId`, `actorId` +**Optional create fields (backend defaults):** `databaseId`, `name`, `requires`, `payload`, `deploys`, `deploy`, `revert`, `verify`, `action`, `actionId`, `actorId` ### `user` @@ -3105,14 +3187,15 @@ CRUD operations for User records. | `id` | UUID | | `username` | String | | `displayName` | String | -| `profilePicture` | ConstructiveInternalTypeImage | +| `profilePicture` | Image | | `searchTsv` | FullText | | `type` | Int | | `createdAt` | Datetime | | `updatedAt` | Datetime | | `searchTsvRank` | Float | -**Create fields:** `username`, `displayName`, `profilePicture`, `searchTsv`, `type`, `searchTsvRank` +**Required create fields:** `searchTsvRank` +**Optional create fields (backend defaults):** `username`, `displayName`, `profilePicture`, `searchTsv`, `type` ### `app-membership` @@ -3147,7 +3230,8 @@ CRUD operations for AppMembership records. | `actorId` | UUID | | `profileId` | UUID | -**Create fields:** `createdBy`, `updatedBy`, `isApproved`, `isBanned`, `isDisabled`, `isVerified`, `isActive`, `isOwner`, `isAdmin`, `permissions`, `granted`, `actorId`, `profileId` +**Required create fields:** `actorId` +**Optional create fields (backend defaults):** `createdBy`, `updatedBy`, `isApproved`, `isBanned`, `isDisabled`, `isVerified`, `isActive`, `isOwner`, `isAdmin`, `permissions`, `granted`, `profileId` ### `hierarchy-module` @@ -3186,7 +3270,8 @@ CRUD operations for HierarchyModule records. | `isManagerOfFunction` | String | | `createdAt` | Datetime | -**Create fields:** `databaseId`, `schemaId`, `privateSchemaId`, `chartEdgesTableId`, `chartEdgesTableName`, `hierarchySprtTableId`, `hierarchySprtTableName`, `chartEdgeGrantsTableId`, `chartEdgeGrantsTableName`, `entityTableId`, `usersTableId`, `prefix`, `privateSchemaName`, `sprtTableName`, `rebuildHierarchyFunction`, `getSubordinatesFunction`, `getManagersFunction`, `isManagerOfFunction` +**Required create fields:** `databaseId`, `entityTableId`, `usersTableId` +**Optional create fields (backend defaults):** `schemaId`, `privateSchemaId`, `chartEdgesTableId`, `chartEdgesTableName`, `hierarchySprtTableId`, `hierarchySprtTableName`, `chartEdgeGrantsTableId`, `chartEdgeGrantsTableName`, `prefix`, `privateSchemaName`, `sprtTableName`, `rebuildHierarchyFunction`, `getSubordinatesFunction`, `getManagersFunction`, `isManagerOfFunction` ## Custom Operations @@ -3220,7 +3305,7 @@ appPermissionsGetPaddedMask | Argument | Type | |----------|------| - | `mask` | BitString | + | `--mask` | BitString | ### `org-permissions-get-padded-mask` @@ -3231,7 +3316,7 @@ orgPermissionsGetPaddedMask | Argument | Type | |----------|------| - | `mask` | BitString | + | `--mask` | BitString | ### `steps-achieved` @@ -3242,8 +3327,8 @@ stepsAchieved | Argument | Type | |----------|------| - | `vlevel` | String | - | `vroleId` | UUID | + | `--vlevel` | String | + | `--vroleId` | UUID | ### `rev-parse` @@ -3254,9 +3339,9 @@ revParse | Argument | Type | |----------|------| - | `dbId` | UUID | - | `storeId` | UUID | - | `refname` | String | + | `--dbId` | UUID | + | `--storeId` | UUID | + | `--refname` | String | ### `org-is-manager-of` @@ -3267,10 +3352,10 @@ orgIsManagerOf | Argument | Type | |----------|------| - | `pEntityId` | UUID | - | `pManagerId` | UUID | - | `pUserId` | UUID | - | `pMaxDepth` | Int | + | `--pEntityId` | UUID | + | `--pManagerId` | UUID | + | `--pUserId` | UUID | + | `--pMaxDepth` | Int | ### `app-permissions-get-mask` @@ -3281,7 +3366,7 @@ appPermissionsGetMask | Argument | Type | |----------|------| - | `ids` | [UUID] | + | `--ids` | UUID | ### `org-permissions-get-mask` @@ -3292,7 +3377,7 @@ orgPermissionsGetMask | Argument | Type | |----------|------| - | `ids` | [UUID] | + | `--ids` | UUID | ### `app-permissions-get-mask-by-names` @@ -3303,7 +3388,7 @@ appPermissionsGetMaskByNames | Argument | Type | |----------|------| - | `names` | [String] | + | `--names` | String | ### `org-permissions-get-mask-by-names` @@ -3314,7 +3399,7 @@ orgPermissionsGetMaskByNames | Argument | Type | |----------|------| - | `names` | [String] | + | `--names` | String | ### `app-permissions-get-by-mask` @@ -3325,10 +3410,10 @@ Reads and enables pagination through a set of `AppPermission`. | Argument | Type | |----------|------| - | `mask` | BitString | - | `first` | Int | - | `offset` | Int | - | `after` | Cursor | + | `--mask` | BitString | + | `--first` | Int | + | `--offset` | Int | + | `--after` | Cursor | ### `org-permissions-get-by-mask` @@ -3339,10 +3424,10 @@ Reads and enables pagination through a set of `OrgPermission`. | Argument | Type | |----------|------| - | `mask` | BitString | - | `first` | Int | - | `offset` | Int | - | `after` | Cursor | + | `--mask` | BitString | + | `--first` | Int | + | `--offset` | Int | + | `--after` | Cursor | ### `get-all-objects-from-root` @@ -3353,11 +3438,11 @@ Reads and enables pagination through a set of `Object`. | Argument | Type | |----------|------| - | `databaseId` | UUID | - | `id` | UUID | - | `first` | Int | - | `offset` | Int | - | `after` | Cursor | + | `--databaseId` | UUID | + | `--id` | UUID | + | `--first` | Int | + | `--offset` | Int | + | `--after` | Cursor | ### `get-path-objects-from-root` @@ -3368,12 +3453,12 @@ Reads and enables pagination through a set of `Object`. | Argument | Type | |----------|------| - | `databaseId` | UUID | - | `id` | UUID | - | `path` | [String] | - | `first` | Int | - | `offset` | Int | - | `after` | Cursor | + | `--databaseId` | UUID | + | `--id` | UUID | + | `--path` | String | + | `--first` | Int | + | `--offset` | Int | + | `--after` | Cursor | ### `get-object-at-path` @@ -3384,10 +3469,10 @@ getObjectAtPath | Argument | Type | |----------|------| - | `dbId` | UUID | - | `storeId` | UUID | - | `path` | [String] | - | `refname` | String | + | `--dbId` | UUID | + | `--storeId` | UUID | + | `--path` | String | + | `--refname` | String | ### `steps-required` @@ -3398,11 +3483,11 @@ Reads and enables pagination through a set of `AppLevelRequirement`. | Argument | Type | |----------|------| - | `vlevel` | String | - | `vroleId` | UUID | - | `first` | Int | - | `offset` | Int | - | `after` | Cursor | + | `--vlevel` | String | + | `--vroleId` | UUID | + | `--first` | Int | + | `--offset` | Int | + | `--after` | Cursor | ### `current-user` @@ -3420,7 +3505,7 @@ signOut | Argument | Type | |----------|------| - | `input` | SignOutInput (required) | + | `--input.clientMutationId` | String | ### `send-account-deletion-email` @@ -3431,7 +3516,7 @@ sendAccountDeletionEmail | Argument | Type | |----------|------| - | `input` | SendAccountDeletionEmailInput (required) | + | `--input.clientMutationId` | String | ### `check-password` @@ -3442,7 +3527,8 @@ checkPassword | Argument | Type | |----------|------| - | `input` | CheckPasswordInput (required) | + | `--input.clientMutationId` | String | + | `--input.password` | String | ### `submit-invite-code` @@ -3453,7 +3539,8 @@ submitInviteCode | Argument | Type | |----------|------| - | `input` | SubmitInviteCodeInput (required) | + | `--input.clientMutationId` | String | + | `--input.token` | String | ### `submit-org-invite-code` @@ -3464,7 +3551,8 @@ submitOrgInviteCode | Argument | Type | |----------|------| - | `input` | SubmitOrgInviteCodeInput (required) | + | `--input.clientMutationId` | String | + | `--input.token` | String | ### `freeze-objects` @@ -3475,7 +3563,9 @@ freezeObjects | Argument | Type | |----------|------| - | `input` | FreezeObjectsInput (required) | + | `--input.clientMutationId` | String | + | `--input.databaseId` | UUID | + | `--input.id` | UUID | ### `init-empty-repo` @@ -3486,7 +3576,9 @@ initEmptyRepo | Argument | Type | |----------|------| - | `input` | InitEmptyRepoInput (required) | + | `--input.clientMutationId` | String | + | `--input.dbId` | UUID | + | `--input.storeId` | UUID | ### `confirm-delete-account` @@ -3497,7 +3589,9 @@ confirmDeleteAccount | Argument | Type | |----------|------| - | `input` | ConfirmDeleteAccountInput (required) | + | `--input.clientMutationId` | String | + | `--input.userId` | UUID | + | `--input.token` | String | ### `set-password` @@ -3508,7 +3602,9 @@ setPassword | Argument | Type | |----------|------| - | `input` | SetPasswordInput (required) | + | `--input.clientMutationId` | String | + | `--input.currentPassword` | String | + | `--input.newPassword` | String | ### `verify-email` @@ -3519,7 +3615,9 @@ verifyEmail | Argument | Type | |----------|------| - | `input` | VerifyEmailInput (required) | + | `--input.clientMutationId` | String | + | `--input.emailId` | UUID | + | `--input.token` | String | ### `reset-password` @@ -3530,7 +3628,10 @@ resetPassword | Argument | Type | |----------|------| - | `input` | ResetPasswordInput (required) | + | `--input.clientMutationId` | String | + | `--input.roleId` | UUID | + | `--input.resetToken` | String | + | `--input.newPassword` | String | ### `remove-node-at-path` @@ -3541,7 +3642,10 @@ removeNodeAtPath | Argument | Type | |----------|------| - | `input` | RemoveNodeAtPathInput (required) | + | `--input.clientMutationId` | String | + | `--input.dbId` | UUID | + | `--input.root` | UUID | + | `--input.path` | String | ### `bootstrap-user` @@ -3552,7 +3656,14 @@ bootstrapUser | Argument | Type | |----------|------| - | `input` | BootstrapUserInput (required) | + | `--input.clientMutationId` | String | + | `--input.targetDatabaseId` | UUID | + | `--input.password` | String | + | `--input.isAdmin` | Boolean | + | `--input.isOwner` | Boolean | + | `--input.username` | String | + | `--input.displayName` | String | + | `--input.returnApiKey` | Boolean | ### `set-data-at-path` @@ -3563,7 +3674,11 @@ setDataAtPath | Argument | Type | |----------|------| - | `input` | SetDataAtPathInput (required) | + | `--input.clientMutationId` | String | + | `--input.dbId` | UUID | + | `--input.root` | UUID | + | `--input.path` | String | + | `--input.data` | JSON | ### `set-props-and-commit` @@ -3574,7 +3689,12 @@ setPropsAndCommit | Argument | Type | |----------|------| - | `input` | SetPropsAndCommitInput (required) | + | `--input.clientMutationId` | String | + | `--input.dbId` | UUID | + | `--input.storeId` | UUID | + | `--input.refname` | String | + | `--input.path` | String | + | `--input.data` | JSON | ### `provision-database-with-user` @@ -3585,7 +3705,12 @@ provisionDatabaseWithUser | Argument | Type | |----------|------| - | `input` | ProvisionDatabaseWithUserInput (required) | + | `--input.clientMutationId` | String | + | `--input.pDatabaseName` | String | + | `--input.pDomain` | String | + | `--input.pSubdomain` | String | + | `--input.pModules` | String | + | `--input.pOptions` | JSON | ### `sign-in-one-time-token` @@ -3596,7 +3721,9 @@ signInOneTimeToken | Argument | Type | |----------|------| - | `input` | SignInOneTimeTokenInput (required) | + | `--input.clientMutationId` | String | + | `--input.token` | String | + | `--input.credentialKind` | String | ### `create-user-database` @@ -3623,7 +3750,14 @@ Example usage: | Argument | Type | |----------|------| - | `input` | CreateUserDatabaseInput (required) | + | `--input.clientMutationId` | String | + | `--input.databaseName` | String | + | `--input.ownerId` | UUID | + | `--input.includeInvites` | Boolean | + | `--input.includeGroups` | Boolean | + | `--input.includeLevels` | Boolean | + | `--input.bitlen` | Int | + | `--input.tokensExpiration` | IntervalInput | ### `extend-token-expires` @@ -3634,7 +3768,8 @@ extendTokenExpires | Argument | Type | |----------|------| - | `input` | ExtendTokenExpiresInput (required) | + | `--input.clientMutationId` | String | + | `--input.amount` | IntervalInput | ### `sign-in` @@ -3645,7 +3780,12 @@ signIn | Argument | Type | |----------|------| - | `input` | SignInInput (required) | + | `--input.clientMutationId` | String | + | `--input.email` | String | + | `--input.password` | String | + | `--input.rememberMe` | Boolean | + | `--input.credentialKind` | String | + | `--input.csrfToken` | String | ### `sign-up` @@ -3656,7 +3796,12 @@ signUp | Argument | Type | |----------|------| - | `input` | SignUpInput (required) | + | `--input.clientMutationId` | String | + | `--input.email` | String | + | `--input.password` | String | + | `--input.rememberMe` | Boolean | + | `--input.credentialKind` | String | + | `--input.csrfToken` | String | ### `set-field-order` @@ -3667,7 +3812,8 @@ setFieldOrder | Argument | Type | |----------|------| - | `input` | SetFieldOrderInput (required) | + | `--input.clientMutationId` | String | + | `--input.fieldIds` | UUID | ### `one-time-token` @@ -3678,7 +3824,11 @@ oneTimeToken | Argument | Type | |----------|------| - | `input` | OneTimeTokenInput (required) | + | `--input.clientMutationId` | String | + | `--input.email` | String | + | `--input.password` | String | + | `--input.origin` | Origin | + | `--input.rememberMe` | Boolean | ### `insert-node-at-path` @@ -3689,7 +3839,13 @@ insertNodeAtPath | Argument | Type | |----------|------| - | `input` | InsertNodeAtPathInput (required) | + | `--input.clientMutationId` | String | + | `--input.dbId` | UUID | + | `--input.root` | UUID | + | `--input.path` | String | + | `--input.data` | JSON | + | `--input.kids` | UUID | + | `--input.ktree` | String | ### `update-node-at-path` @@ -3700,7 +3856,13 @@ updateNodeAtPath | Argument | Type | |----------|------| - | `input` | UpdateNodeAtPathInput (required) | + | `--input.clientMutationId` | String | + | `--input.dbId` | UUID | + | `--input.root` | UUID | + | `--input.path` | String | + | `--input.data` | JSON | + | `--input.kids` | UUID | + | `--input.ktree` | String | ### `set-and-commit` @@ -3711,7 +3873,14 @@ setAndCommit | Argument | Type | |----------|------| - | `input` | SetAndCommitInput (required) | + | `--input.clientMutationId` | String | + | `--input.dbId` | UUID | + | `--input.storeId` | UUID | + | `--input.refname` | String | + | `--input.path` | String | + | `--input.data` | JSON | + | `--input.kids` | UUID | + | `--input.ktree` | String | ### `apply-rls` @@ -3722,7 +3891,14 @@ applyRls | Argument | Type | |----------|------| - | `input` | ApplyRlsInput (required) | + | `--input.clientMutationId` | String | + | `--input.tableId` | UUID | + | `--input.grants` | JSON | + | `--input.policyType` | String | + | `--input.vars` | JSON | + | `--input.fieldIds` | UUID | + | `--input.permissive` | Boolean | + | `--input.name` | String | ### `forgot-password` @@ -3733,7 +3909,8 @@ forgotPassword | Argument | Type | |----------|------| - | `input` | ForgotPasswordInput (required) | + | `--input.clientMutationId` | String | + | `--input.email` | Email | ### `send-verification-email` @@ -3744,7 +3921,8 @@ sendVerificationEmail | Argument | Type | |----------|------| - | `input` | SendVerificationEmailInput (required) | + | `--input.clientMutationId` | String | + | `--input.email` | Email | ### `verify-password` @@ -3755,7 +3933,8 @@ verifyPassword | Argument | Type | |----------|------| - | `input` | VerifyPasswordInput (required) | + | `--input.clientMutationId` | String | + | `--input.password` | String (required) | ### `verify-totp` @@ -3766,7 +3945,8 @@ verifyTotp | Argument | Type | |----------|------| - | `input` | VerifyTotpInput (required) | + | `--input.clientMutationId` | String | + | `--input.totpValue` | String (required) | ## Output @@ -3777,6 +3957,14 @@ csdk car list | jq '.[]' csdk car get --id | jq '.' ``` +## Non-Interactive Mode + +Use `--no-tty` to skip all interactive prompts (useful for scripts and CI): + +```bash +csdk --no-tty car create --name "Sedan" --year 2024 +``` + --- Built by the [Constructive](https://constructive.io) team. diff --git a/skills/cli-admin/SKILL.md b/skills/cli-admin/SKILL.md index b1f37d44c..2ee43b7e3 100644 --- a/skills/cli-admin/SKILL.md +++ b/skills/cli-admin/SKILL.md @@ -23,6 +23,9 @@ csdk auth set-token csdk org-get-managers-record list csdk org-get-managers-record get --id csdk org-get-managers-record create -- + +# Non-interactive mode (skip all prompts, use flags only) +csdk --no-tty org-get-managers-record list ``` ## Examples @@ -36,6 +39,12 @@ csdk auth set-token csdk org-get-managers-record list ``` +### Non-interactive mode (for scripts and CI) + +```bash +csdk --no-tty org-get-managers-record create -- +``` + ## References See the `references/` directory for detailed per-entity API documentation: diff --git a/skills/cli-admin/references/app-achievement.md b/skills/cli-admin/references/app-achievement.md index 96cd03f13..e8055d4fd 100644 --- a/skills/cli-admin/references/app-achievement.md +++ b/skills/cli-admin/references/app-achievement.md @@ -9,7 +9,7 @@ CRUD operations for AppAchievement records via csdk CLI ```bash csdk app-achievement list csdk app-achievement get --id -csdk app-achievement create --actorId --name --count +csdk app-achievement create --name [--actorId ] [--count ] csdk app-achievement update --id [--actorId ] [--name ] [--count ] csdk app-achievement delete --id ``` @@ -25,7 +25,7 @@ csdk app-achievement list ### Create a appAchievement ```bash -csdk app-achievement create --actorId "value" --name "value" --count "value" +csdk app-achievement create --name [--actorId ] [--count ] ``` ### Get a appAchievement by id diff --git a/skills/cli-admin/references/app-admin-grant.md b/skills/cli-admin/references/app-admin-grant.md index ad3fef5bf..f54cae59c 100644 --- a/skills/cli-admin/references/app-admin-grant.md +++ b/skills/cli-admin/references/app-admin-grant.md @@ -9,7 +9,7 @@ CRUD operations for AppAdminGrant records via csdk CLI ```bash csdk app-admin-grant list csdk app-admin-grant get --id -csdk app-admin-grant create --isGrant --actorId --grantorId +csdk app-admin-grant create --actorId [--isGrant ] [--grantorId ] csdk app-admin-grant update --id [--isGrant ] [--actorId ] [--grantorId ] csdk app-admin-grant delete --id ``` @@ -25,7 +25,7 @@ csdk app-admin-grant list ### Create a appAdminGrant ```bash -csdk app-admin-grant create --isGrant "value" --actorId "value" --grantorId "value" +csdk app-admin-grant create --actorId [--isGrant ] [--grantorId ] ``` ### Get a appAdminGrant by id diff --git a/skills/cli-admin/references/app-grant.md b/skills/cli-admin/references/app-grant.md index dad8808f5..a04cb4079 100644 --- a/skills/cli-admin/references/app-grant.md +++ b/skills/cli-admin/references/app-grant.md @@ -9,7 +9,7 @@ CRUD operations for AppGrant records via csdk CLI ```bash csdk app-grant list csdk app-grant get --id -csdk app-grant create --permissions --isGrant --actorId --grantorId +csdk app-grant create --actorId [--permissions ] [--isGrant ] [--grantorId ] csdk app-grant update --id [--permissions ] [--isGrant ] [--actorId ] [--grantorId ] csdk app-grant delete --id ``` @@ -25,7 +25,7 @@ csdk app-grant list ### Create a appGrant ```bash -csdk app-grant create --permissions "value" --isGrant "value" --actorId "value" --grantorId "value" +csdk app-grant create --actorId [--permissions ] [--isGrant ] [--grantorId ] ``` ### Get a appGrant by id diff --git a/skills/cli-admin/references/app-level-requirement.md b/skills/cli-admin/references/app-level-requirement.md index b69a5b226..a08403018 100644 --- a/skills/cli-admin/references/app-level-requirement.md +++ b/skills/cli-admin/references/app-level-requirement.md @@ -9,7 +9,7 @@ CRUD operations for AppLevelRequirement records via csdk CLI ```bash csdk app-level-requirement list csdk app-level-requirement get --id -csdk app-level-requirement create --name --level --description --requiredCount --priority +csdk app-level-requirement create --name --level [--description ] [--requiredCount ] [--priority ] csdk app-level-requirement update --id [--name ] [--level ] [--description ] [--requiredCount ] [--priority ] csdk app-level-requirement delete --id ``` @@ -25,7 +25,7 @@ csdk app-level-requirement list ### Create a appLevelRequirement ```bash -csdk app-level-requirement create --name "value" --level "value" --description "value" --requiredCount "value" --priority "value" +csdk app-level-requirement create --name --level [--description ] [--requiredCount ] [--priority ] ``` ### Get a appLevelRequirement by id diff --git a/skills/cli-admin/references/app-level.md b/skills/cli-admin/references/app-level.md index ec99c92f2..3ec5afb86 100644 --- a/skills/cli-admin/references/app-level.md +++ b/skills/cli-admin/references/app-level.md @@ -9,7 +9,7 @@ CRUD operations for AppLevel records via csdk CLI ```bash csdk app-level list csdk app-level get --id -csdk app-level create --name --description --image --ownerId +csdk app-level create --name [--description ] [--image ] [--ownerId ] csdk app-level update --id [--name ] [--description ] [--image ] [--ownerId ] csdk app-level delete --id ``` @@ -25,7 +25,7 @@ csdk app-level list ### Create a appLevel ```bash -csdk app-level create --name "value" --description "value" --image "value" --ownerId "value" +csdk app-level create --name [--description ] [--image ] [--ownerId ] ``` ### Get a appLevel by id diff --git a/skills/cli-admin/references/app-limit-default.md b/skills/cli-admin/references/app-limit-default.md index 8317537f7..2aca3f587 100644 --- a/skills/cli-admin/references/app-limit-default.md +++ b/skills/cli-admin/references/app-limit-default.md @@ -9,7 +9,7 @@ CRUD operations for AppLimitDefault records via csdk CLI ```bash csdk app-limit-default list csdk app-limit-default get --id -csdk app-limit-default create --name --max +csdk app-limit-default create --name [--max ] csdk app-limit-default update --id [--name ] [--max ] csdk app-limit-default delete --id ``` @@ -25,7 +25,7 @@ csdk app-limit-default list ### Create a appLimitDefault ```bash -csdk app-limit-default create --name "value" --max "value" +csdk app-limit-default create --name [--max ] ``` ### Get a appLimitDefault by id diff --git a/skills/cli-admin/references/app-limit.md b/skills/cli-admin/references/app-limit.md index a80ecd7cf..c1632d535 100644 --- a/skills/cli-admin/references/app-limit.md +++ b/skills/cli-admin/references/app-limit.md @@ -9,7 +9,7 @@ CRUD operations for AppLimit records via csdk CLI ```bash csdk app-limit list csdk app-limit get --id -csdk app-limit create --name --actorId --num --max +csdk app-limit create --actorId [--name ] [--num ] [--max ] csdk app-limit update --id [--name ] [--actorId ] [--num ] [--max ] csdk app-limit delete --id ``` @@ -25,7 +25,7 @@ csdk app-limit list ### Create a appLimit ```bash -csdk app-limit create --name "value" --actorId "value" --num "value" --max "value" +csdk app-limit create --actorId [--name ] [--num ] [--max ] ``` ### Get a appLimit by id diff --git a/skills/cli-admin/references/app-membership-default.md b/skills/cli-admin/references/app-membership-default.md index 6f6654de1..2fb906fa3 100644 --- a/skills/cli-admin/references/app-membership-default.md +++ b/skills/cli-admin/references/app-membership-default.md @@ -9,7 +9,7 @@ CRUD operations for AppMembershipDefault records via csdk CLI ```bash csdk app-membership-default list csdk app-membership-default get --id -csdk app-membership-default create --createdBy --updatedBy --isApproved --isVerified +csdk app-membership-default create [--createdBy ] [--updatedBy ] [--isApproved ] [--isVerified ] csdk app-membership-default update --id [--createdBy ] [--updatedBy ] [--isApproved ] [--isVerified ] csdk app-membership-default delete --id ``` @@ -25,7 +25,7 @@ csdk app-membership-default list ### Create a appMembershipDefault ```bash -csdk app-membership-default create --createdBy "value" --updatedBy "value" --isApproved "value" --isVerified "value" +csdk app-membership-default create [--createdBy ] [--updatedBy ] [--isApproved ] [--isVerified ] ``` ### Get a appMembershipDefault by id diff --git a/skills/cli-admin/references/app-membership.md b/skills/cli-admin/references/app-membership.md index ebd0760dd..a659dc75e 100644 --- a/skills/cli-admin/references/app-membership.md +++ b/skills/cli-admin/references/app-membership.md @@ -9,7 +9,7 @@ CRUD operations for AppMembership records via csdk CLI ```bash csdk app-membership list csdk app-membership get --id -csdk app-membership create --createdBy --updatedBy --isApproved --isBanned --isDisabled --isVerified --isActive --isOwner --isAdmin --permissions --granted --actorId --profileId +csdk app-membership create --actorId [--createdBy ] [--updatedBy ] [--isApproved ] [--isBanned ] [--isDisabled ] [--isVerified ] [--isActive ] [--isOwner ] [--isAdmin ] [--permissions ] [--granted ] [--profileId ] csdk app-membership update --id [--createdBy ] [--updatedBy ] [--isApproved ] [--isBanned ] [--isDisabled ] [--isVerified ] [--isActive ] [--isOwner ] [--isAdmin ] [--permissions ] [--granted ] [--actorId ] [--profileId ] csdk app-membership delete --id ``` @@ -25,7 +25,7 @@ csdk app-membership list ### Create a appMembership ```bash -csdk app-membership create --createdBy "value" --updatedBy "value" --isApproved "value" --isBanned "value" --isDisabled "value" --isVerified "value" --isActive "value" --isOwner "value" --isAdmin "value" --permissions "value" --granted "value" --actorId "value" --profileId "value" +csdk app-membership create --actorId [--createdBy ] [--updatedBy ] [--isApproved ] [--isBanned ] [--isDisabled ] [--isVerified ] [--isActive ] [--isOwner ] [--isAdmin ] [--permissions ] [--granted ] [--profileId ] ``` ### Get a appMembership by id diff --git a/skills/cli-admin/references/app-owner-grant.md b/skills/cli-admin/references/app-owner-grant.md index 62e59f861..35d2826ea 100644 --- a/skills/cli-admin/references/app-owner-grant.md +++ b/skills/cli-admin/references/app-owner-grant.md @@ -9,7 +9,7 @@ CRUD operations for AppOwnerGrant records via csdk CLI ```bash csdk app-owner-grant list csdk app-owner-grant get --id -csdk app-owner-grant create --isGrant --actorId --grantorId +csdk app-owner-grant create --actorId [--isGrant ] [--grantorId ] csdk app-owner-grant update --id [--isGrant ] [--actorId ] [--grantorId ] csdk app-owner-grant delete --id ``` @@ -25,7 +25,7 @@ csdk app-owner-grant list ### Create a appOwnerGrant ```bash -csdk app-owner-grant create --isGrant "value" --actorId "value" --grantorId "value" +csdk app-owner-grant create --actorId [--isGrant ] [--grantorId ] ``` ### Get a appOwnerGrant by id diff --git a/skills/cli-admin/references/app-permission-default.md b/skills/cli-admin/references/app-permission-default.md index 3976de27e..e8fcd4f3f 100644 --- a/skills/cli-admin/references/app-permission-default.md +++ b/skills/cli-admin/references/app-permission-default.md @@ -9,7 +9,7 @@ CRUD operations for AppPermissionDefault records via csdk CLI ```bash csdk app-permission-default list csdk app-permission-default get --id -csdk app-permission-default create --permissions +csdk app-permission-default create [--permissions ] csdk app-permission-default update --id [--permissions ] csdk app-permission-default delete --id ``` @@ -25,7 +25,7 @@ csdk app-permission-default list ### Create a appPermissionDefault ```bash -csdk app-permission-default create --permissions "value" +csdk app-permission-default create [--permissions ] ``` ### Get a appPermissionDefault by id diff --git a/skills/cli-admin/references/app-permission.md b/skills/cli-admin/references/app-permission.md index d2643e7da..eef95408e 100644 --- a/skills/cli-admin/references/app-permission.md +++ b/skills/cli-admin/references/app-permission.md @@ -9,7 +9,7 @@ CRUD operations for AppPermission records via csdk CLI ```bash csdk app-permission list csdk app-permission get --id -csdk app-permission create --name --bitnum --bitstr --description +csdk app-permission create [--name ] [--bitnum ] [--bitstr ] [--description ] csdk app-permission update --id [--name ] [--bitnum ] [--bitstr ] [--description ] csdk app-permission delete --id ``` @@ -25,7 +25,7 @@ csdk app-permission list ### Create a appPermission ```bash -csdk app-permission create --name "value" --bitnum "value" --bitstr "value" --description "value" +csdk app-permission create [--name ] [--bitnum ] [--bitstr ] [--description ] ``` ### Get a appPermission by id diff --git a/skills/cli-admin/references/app-step.md b/skills/cli-admin/references/app-step.md index ece32f606..a32d82784 100644 --- a/skills/cli-admin/references/app-step.md +++ b/skills/cli-admin/references/app-step.md @@ -9,7 +9,7 @@ CRUD operations for AppStep records via csdk CLI ```bash csdk app-step list csdk app-step get --id -csdk app-step create --actorId --name --count +csdk app-step create --name [--actorId ] [--count ] csdk app-step update --id [--actorId ] [--name ] [--count ] csdk app-step delete --id ``` @@ -25,7 +25,7 @@ csdk app-step list ### Create a appStep ```bash -csdk app-step create --actorId "value" --name "value" --count "value" +csdk app-step create --name [--actorId ] [--count ] ``` ### Get a appStep by id diff --git a/skills/cli-admin/references/claimed-invite.md b/skills/cli-admin/references/claimed-invite.md index 6546bf6ad..4861cc94d 100644 --- a/skills/cli-admin/references/claimed-invite.md +++ b/skills/cli-admin/references/claimed-invite.md @@ -9,7 +9,7 @@ CRUD operations for ClaimedInvite records via csdk CLI ```bash csdk claimed-invite list csdk claimed-invite get --id -csdk claimed-invite create --data --senderId --receiverId +csdk claimed-invite create [--data ] [--senderId ] [--receiverId ] csdk claimed-invite update --id [--data ] [--senderId ] [--receiverId ] csdk claimed-invite delete --id ``` @@ -25,7 +25,7 @@ csdk claimed-invite list ### Create a claimedInvite ```bash -csdk claimed-invite create --data "value" --senderId "value" --receiverId "value" +csdk claimed-invite create [--data ] [--senderId ] [--receiverId ] ``` ### Get a claimedInvite by id diff --git a/skills/cli-admin/references/invite.md b/skills/cli-admin/references/invite.md index b415cfafe..5b837cd1a 100644 --- a/skills/cli-admin/references/invite.md +++ b/skills/cli-admin/references/invite.md @@ -9,7 +9,7 @@ CRUD operations for Invite records via csdk CLI ```bash csdk invite list csdk invite get --id -csdk invite create --email --senderId --inviteToken --inviteValid --inviteLimit --inviteCount --multiple --data --expiresAt +csdk invite create [--email ] [--senderId ] [--inviteToken ] [--inviteValid ] [--inviteLimit ] [--inviteCount ] [--multiple ] [--data ] [--expiresAt ] csdk invite update --id [--email ] [--senderId ] [--inviteToken ] [--inviteValid ] [--inviteLimit ] [--inviteCount ] [--multiple ] [--data ] [--expiresAt ] csdk invite delete --id ``` @@ -25,7 +25,7 @@ csdk invite list ### Create a invite ```bash -csdk invite create --email "value" --senderId "value" --inviteToken "value" --inviteValid "value" --inviteLimit "value" --inviteCount "value" --multiple "value" --data "value" --expiresAt "value" +csdk invite create [--email ] [--senderId ] [--inviteToken ] [--inviteValid ] [--inviteLimit ] [--inviteCount ] [--multiple ] [--data ] [--expiresAt ] ``` ### Get a invite by id diff --git a/skills/cli-admin/references/membership-type.md b/skills/cli-admin/references/membership-type.md index 57d8204cc..4ef886048 100644 --- a/skills/cli-admin/references/membership-type.md +++ b/skills/cli-admin/references/membership-type.md @@ -25,7 +25,7 @@ csdk membership-type list ### Create a membershipType ```bash -csdk membership-type create --name "value" --description "value" --prefix "value" +csdk membership-type create --name --description --prefix ``` ### Get a membershipType by id diff --git a/skills/cli-admin/references/org-admin-grant.md b/skills/cli-admin/references/org-admin-grant.md index 27816639f..72f0f5fb5 100644 --- a/skills/cli-admin/references/org-admin-grant.md +++ b/skills/cli-admin/references/org-admin-grant.md @@ -9,7 +9,7 @@ CRUD operations for OrgAdminGrant records via csdk CLI ```bash csdk org-admin-grant list csdk org-admin-grant get --id -csdk org-admin-grant create --isGrant --actorId --entityId --grantorId +csdk org-admin-grant create --actorId --entityId [--isGrant ] [--grantorId ] csdk org-admin-grant update --id [--isGrant ] [--actorId ] [--entityId ] [--grantorId ] csdk org-admin-grant delete --id ``` @@ -25,7 +25,7 @@ csdk org-admin-grant list ### Create a orgAdminGrant ```bash -csdk org-admin-grant create --isGrant "value" --actorId "value" --entityId "value" --grantorId "value" +csdk org-admin-grant create --actorId --entityId [--isGrant ] [--grantorId ] ``` ### Get a orgAdminGrant by id diff --git a/skills/cli-admin/references/org-chart-edge-grant.md b/skills/cli-admin/references/org-chart-edge-grant.md index 08eaed6a9..62779ed5f 100644 --- a/skills/cli-admin/references/org-chart-edge-grant.md +++ b/skills/cli-admin/references/org-chart-edge-grant.md @@ -9,7 +9,7 @@ CRUD operations for OrgChartEdgeGrant records via csdk CLI ```bash csdk org-chart-edge-grant list csdk org-chart-edge-grant get --id -csdk org-chart-edge-grant create --entityId --childId --parentId --grantorId --isGrant --positionTitle --positionLevel +csdk org-chart-edge-grant create --entityId --childId --grantorId [--parentId ] [--isGrant ] [--positionTitle ] [--positionLevel ] csdk org-chart-edge-grant update --id [--entityId ] [--childId ] [--parentId ] [--grantorId ] [--isGrant ] [--positionTitle ] [--positionLevel ] csdk org-chart-edge-grant delete --id ``` @@ -25,7 +25,7 @@ csdk org-chart-edge-grant list ### Create a orgChartEdgeGrant ```bash -csdk org-chart-edge-grant create --entityId "value" --childId "value" --parentId "value" --grantorId "value" --isGrant "value" --positionTitle "value" --positionLevel "value" +csdk org-chart-edge-grant create --entityId --childId --grantorId [--parentId ] [--isGrant ] [--positionTitle ] [--positionLevel ] ``` ### Get a orgChartEdgeGrant by id diff --git a/skills/cli-admin/references/org-chart-edge.md b/skills/cli-admin/references/org-chart-edge.md index 048d899a5..5ead28ec2 100644 --- a/skills/cli-admin/references/org-chart-edge.md +++ b/skills/cli-admin/references/org-chart-edge.md @@ -9,7 +9,7 @@ CRUD operations for OrgChartEdge records via csdk CLI ```bash csdk org-chart-edge list csdk org-chart-edge get --id -csdk org-chart-edge create --entityId --childId --parentId --positionTitle --positionLevel +csdk org-chart-edge create --entityId --childId [--parentId ] [--positionTitle ] [--positionLevel ] csdk org-chart-edge update --id [--entityId ] [--childId ] [--parentId ] [--positionTitle ] [--positionLevel ] csdk org-chart-edge delete --id ``` @@ -25,7 +25,7 @@ csdk org-chart-edge list ### Create a orgChartEdge ```bash -csdk org-chart-edge create --entityId "value" --childId "value" --parentId "value" --positionTitle "value" --positionLevel "value" +csdk org-chart-edge create --entityId --childId [--parentId ] [--positionTitle ] [--positionLevel ] ``` ### Get a orgChartEdge by id diff --git a/skills/cli-admin/references/org-claimed-invite.md b/skills/cli-admin/references/org-claimed-invite.md index 4fa8c680a..e187202ee 100644 --- a/skills/cli-admin/references/org-claimed-invite.md +++ b/skills/cli-admin/references/org-claimed-invite.md @@ -9,7 +9,7 @@ CRUD operations for OrgClaimedInvite records via csdk CLI ```bash csdk org-claimed-invite list csdk org-claimed-invite get --id -csdk org-claimed-invite create --data --senderId --receiverId --entityId +csdk org-claimed-invite create --entityId [--data ] [--senderId ] [--receiverId ] csdk org-claimed-invite update --id [--data ] [--senderId ] [--receiverId ] [--entityId ] csdk org-claimed-invite delete --id ``` @@ -25,7 +25,7 @@ csdk org-claimed-invite list ### Create a orgClaimedInvite ```bash -csdk org-claimed-invite create --data "value" --senderId "value" --receiverId "value" --entityId "value" +csdk org-claimed-invite create --entityId [--data ] [--senderId ] [--receiverId ] ``` ### Get a orgClaimedInvite by id diff --git a/skills/cli-admin/references/org-get-managers-record.md b/skills/cli-admin/references/org-get-managers-record.md index ffc368c84..aaa46db48 100644 --- a/skills/cli-admin/references/org-get-managers-record.md +++ b/skills/cli-admin/references/org-get-managers-record.md @@ -25,7 +25,7 @@ csdk org-get-managers-record list ### Create a orgGetManagersRecord ```bash -csdk org-get-managers-record create --userId "value" --depth "value" +csdk org-get-managers-record create --userId --depth ``` ### Get a orgGetManagersRecord by id diff --git a/skills/cli-admin/references/org-get-subordinates-record.md b/skills/cli-admin/references/org-get-subordinates-record.md index f42ede9ff..4391288e9 100644 --- a/skills/cli-admin/references/org-get-subordinates-record.md +++ b/skills/cli-admin/references/org-get-subordinates-record.md @@ -25,7 +25,7 @@ csdk org-get-subordinates-record list ### Create a orgGetSubordinatesRecord ```bash -csdk org-get-subordinates-record create --userId "value" --depth "value" +csdk org-get-subordinates-record create --userId --depth ``` ### Get a orgGetSubordinatesRecord by id diff --git a/skills/cli-admin/references/org-grant.md b/skills/cli-admin/references/org-grant.md index 7162efc86..ef384b4c1 100644 --- a/skills/cli-admin/references/org-grant.md +++ b/skills/cli-admin/references/org-grant.md @@ -9,7 +9,7 @@ CRUD operations for OrgGrant records via csdk CLI ```bash csdk org-grant list csdk org-grant get --id -csdk org-grant create --permissions --isGrant --actorId --entityId --grantorId +csdk org-grant create --actorId --entityId [--permissions ] [--isGrant ] [--grantorId ] csdk org-grant update --id [--permissions ] [--isGrant ] [--actorId ] [--entityId ] [--grantorId ] csdk org-grant delete --id ``` @@ -25,7 +25,7 @@ csdk org-grant list ### Create a orgGrant ```bash -csdk org-grant create --permissions "value" --isGrant "value" --actorId "value" --entityId "value" --grantorId "value" +csdk org-grant create --actorId --entityId [--permissions ] [--isGrant ] [--grantorId ] ``` ### Get a orgGrant by id diff --git a/skills/cli-admin/references/org-invite.md b/skills/cli-admin/references/org-invite.md index 5042d0928..18554cef6 100644 --- a/skills/cli-admin/references/org-invite.md +++ b/skills/cli-admin/references/org-invite.md @@ -9,7 +9,7 @@ CRUD operations for OrgInvite records via csdk CLI ```bash csdk org-invite list csdk org-invite get --id -csdk org-invite create --email --senderId --receiverId --inviteToken --inviteValid --inviteLimit --inviteCount --multiple --data --expiresAt --entityId +csdk org-invite create --entityId [--email ] [--senderId ] [--receiverId ] [--inviteToken ] [--inviteValid ] [--inviteLimit ] [--inviteCount ] [--multiple ] [--data ] [--expiresAt ] csdk org-invite update --id [--email ] [--senderId ] [--receiverId ] [--inviteToken ] [--inviteValid ] [--inviteLimit ] [--inviteCount ] [--multiple ] [--data ] [--expiresAt ] [--entityId ] csdk org-invite delete --id ``` @@ -25,7 +25,7 @@ csdk org-invite list ### Create a orgInvite ```bash -csdk org-invite create --email "value" --senderId "value" --receiverId "value" --inviteToken "value" --inviteValid "value" --inviteLimit "value" --inviteCount "value" --multiple "value" --data "value" --expiresAt "value" --entityId "value" +csdk org-invite create --entityId [--email ] [--senderId ] [--receiverId ] [--inviteToken ] [--inviteValid ] [--inviteLimit ] [--inviteCount ] [--multiple ] [--data ] [--expiresAt ] ``` ### Get a orgInvite by id diff --git a/skills/cli-admin/references/org-limit-default.md b/skills/cli-admin/references/org-limit-default.md index 714d2bf2d..e8d91ae23 100644 --- a/skills/cli-admin/references/org-limit-default.md +++ b/skills/cli-admin/references/org-limit-default.md @@ -9,7 +9,7 @@ CRUD operations for OrgLimitDefault records via csdk CLI ```bash csdk org-limit-default list csdk org-limit-default get --id -csdk org-limit-default create --name --max +csdk org-limit-default create --name [--max ] csdk org-limit-default update --id [--name ] [--max ] csdk org-limit-default delete --id ``` @@ -25,7 +25,7 @@ csdk org-limit-default list ### Create a orgLimitDefault ```bash -csdk org-limit-default create --name "value" --max "value" +csdk org-limit-default create --name [--max ] ``` ### Get a orgLimitDefault by id diff --git a/skills/cli-admin/references/org-limit.md b/skills/cli-admin/references/org-limit.md index 00b123dc2..77229c233 100644 --- a/skills/cli-admin/references/org-limit.md +++ b/skills/cli-admin/references/org-limit.md @@ -9,7 +9,7 @@ CRUD operations for OrgLimit records via csdk CLI ```bash csdk org-limit list csdk org-limit get --id -csdk org-limit create --name --actorId --num --max --entityId +csdk org-limit create --actorId --entityId [--name ] [--num ] [--max ] csdk org-limit update --id [--name ] [--actorId ] [--num ] [--max ] [--entityId ] csdk org-limit delete --id ``` @@ -25,7 +25,7 @@ csdk org-limit list ### Create a orgLimit ```bash -csdk org-limit create --name "value" --actorId "value" --num "value" --max "value" --entityId "value" +csdk org-limit create --actorId --entityId [--name ] [--num ] [--max ] ``` ### Get a orgLimit by id diff --git a/skills/cli-admin/references/org-member.md b/skills/cli-admin/references/org-member.md index 52377f83c..e61869351 100644 --- a/skills/cli-admin/references/org-member.md +++ b/skills/cli-admin/references/org-member.md @@ -9,7 +9,7 @@ CRUD operations for OrgMember records via csdk CLI ```bash csdk org-member list csdk org-member get --id -csdk org-member create --isAdmin --actorId --entityId +csdk org-member create --actorId --entityId [--isAdmin ] csdk org-member update --id [--isAdmin ] [--actorId ] [--entityId ] csdk org-member delete --id ``` @@ -25,7 +25,7 @@ csdk org-member list ### Create a orgMember ```bash -csdk org-member create --isAdmin "value" --actorId "value" --entityId "value" +csdk org-member create --actorId --entityId [--isAdmin ] ``` ### Get a orgMember by id diff --git a/skills/cli-admin/references/org-membership-default.md b/skills/cli-admin/references/org-membership-default.md index 1c437e910..899ee3d65 100644 --- a/skills/cli-admin/references/org-membership-default.md +++ b/skills/cli-admin/references/org-membership-default.md @@ -9,7 +9,7 @@ CRUD operations for OrgMembershipDefault records via csdk CLI ```bash csdk org-membership-default list csdk org-membership-default get --id -csdk org-membership-default create --createdBy --updatedBy --isApproved --entityId --deleteMemberCascadeGroups --createGroupsCascadeMembers +csdk org-membership-default create --entityId [--createdBy ] [--updatedBy ] [--isApproved ] [--deleteMemberCascadeGroups ] [--createGroupsCascadeMembers ] csdk org-membership-default update --id [--createdBy ] [--updatedBy ] [--isApproved ] [--entityId ] [--deleteMemberCascadeGroups ] [--createGroupsCascadeMembers ] csdk org-membership-default delete --id ``` @@ -25,7 +25,7 @@ csdk org-membership-default list ### Create a orgMembershipDefault ```bash -csdk org-membership-default create --createdBy "value" --updatedBy "value" --isApproved "value" --entityId "value" --deleteMemberCascadeGroups "value" --createGroupsCascadeMembers "value" +csdk org-membership-default create --entityId [--createdBy ] [--updatedBy ] [--isApproved ] [--deleteMemberCascadeGroups ] [--createGroupsCascadeMembers ] ``` ### Get a orgMembershipDefault by id diff --git a/skills/cli-admin/references/org-membership.md b/skills/cli-admin/references/org-membership.md index ac871cb47..0fd9cc7e6 100644 --- a/skills/cli-admin/references/org-membership.md +++ b/skills/cli-admin/references/org-membership.md @@ -9,7 +9,7 @@ CRUD operations for OrgMembership records via csdk CLI ```bash csdk org-membership list csdk org-membership get --id -csdk org-membership create --createdBy --updatedBy --isApproved --isBanned --isDisabled --isActive --isOwner --isAdmin --permissions --granted --actorId --entityId --profileId +csdk org-membership create --actorId --entityId [--createdBy ] [--updatedBy ] [--isApproved ] [--isBanned ] [--isDisabled ] [--isActive ] [--isOwner ] [--isAdmin ] [--permissions ] [--granted ] [--profileId ] csdk org-membership update --id [--createdBy ] [--updatedBy ] [--isApproved ] [--isBanned ] [--isDisabled ] [--isActive ] [--isOwner ] [--isAdmin ] [--permissions ] [--granted ] [--actorId ] [--entityId ] [--profileId ] csdk org-membership delete --id ``` @@ -25,7 +25,7 @@ csdk org-membership list ### Create a orgMembership ```bash -csdk org-membership create --createdBy "value" --updatedBy "value" --isApproved "value" --isBanned "value" --isDisabled "value" --isActive "value" --isOwner "value" --isAdmin "value" --permissions "value" --granted "value" --actorId "value" --entityId "value" --profileId "value" +csdk org-membership create --actorId --entityId [--createdBy ] [--updatedBy ] [--isApproved ] [--isBanned ] [--isDisabled ] [--isActive ] [--isOwner ] [--isAdmin ] [--permissions ] [--granted ] [--profileId ] ``` ### Get a orgMembership by id diff --git a/skills/cli-admin/references/org-owner-grant.md b/skills/cli-admin/references/org-owner-grant.md index 687e2fc35..89e042066 100644 --- a/skills/cli-admin/references/org-owner-grant.md +++ b/skills/cli-admin/references/org-owner-grant.md @@ -9,7 +9,7 @@ CRUD operations for OrgOwnerGrant records via csdk CLI ```bash csdk org-owner-grant list csdk org-owner-grant get --id -csdk org-owner-grant create --isGrant --actorId --entityId --grantorId +csdk org-owner-grant create --actorId --entityId [--isGrant ] [--grantorId ] csdk org-owner-grant update --id [--isGrant ] [--actorId ] [--entityId ] [--grantorId ] csdk org-owner-grant delete --id ``` @@ -25,7 +25,7 @@ csdk org-owner-grant list ### Create a orgOwnerGrant ```bash -csdk org-owner-grant create --isGrant "value" --actorId "value" --entityId "value" --grantorId "value" +csdk org-owner-grant create --actorId --entityId [--isGrant ] [--grantorId ] ``` ### Get a orgOwnerGrant by id diff --git a/skills/cli-admin/references/org-permission-default.md b/skills/cli-admin/references/org-permission-default.md index 3b243d67d..4ffffab2b 100644 --- a/skills/cli-admin/references/org-permission-default.md +++ b/skills/cli-admin/references/org-permission-default.md @@ -9,7 +9,7 @@ CRUD operations for OrgPermissionDefault records via csdk CLI ```bash csdk org-permission-default list csdk org-permission-default get --id -csdk org-permission-default create --permissions --entityId +csdk org-permission-default create --entityId [--permissions ] csdk org-permission-default update --id [--permissions ] [--entityId ] csdk org-permission-default delete --id ``` @@ -25,7 +25,7 @@ csdk org-permission-default list ### Create a orgPermissionDefault ```bash -csdk org-permission-default create --permissions "value" --entityId "value" +csdk org-permission-default create --entityId [--permissions ] ``` ### Get a orgPermissionDefault by id diff --git a/skills/cli-admin/references/org-permission.md b/skills/cli-admin/references/org-permission.md index 45439c658..98bfe7d30 100644 --- a/skills/cli-admin/references/org-permission.md +++ b/skills/cli-admin/references/org-permission.md @@ -9,7 +9,7 @@ CRUD operations for OrgPermission records via csdk CLI ```bash csdk org-permission list csdk org-permission get --id -csdk org-permission create --name --bitnum --bitstr --description +csdk org-permission create [--name ] [--bitnum ] [--bitstr ] [--description ] csdk org-permission update --id [--name ] [--bitnum ] [--bitstr ] [--description ] csdk org-permission delete --id ``` @@ -25,7 +25,7 @@ csdk org-permission list ### Create a orgPermission ```bash -csdk org-permission create --name "value" --bitnum "value" --bitstr "value" --description "value" +csdk org-permission create [--name ] [--bitnum ] [--bitstr ] [--description ] ``` ### Get a orgPermission by id diff --git a/skills/cli-admin/references/submit-invite-code.md b/skills/cli-admin/references/submit-invite-code.md index da1be26f0..b61ec52a4 100644 --- a/skills/cli-admin/references/submit-invite-code.md +++ b/skills/cli-admin/references/submit-invite-code.md @@ -7,7 +7,7 @@ Execute the submitInviteCode mutation ## Usage ```bash -csdk submit-invite-code --input +csdk submit-invite-code --input.clientMutationId --input.token ``` ## Examples @@ -15,5 +15,5 @@ csdk submit-invite-code --input ### Run submitInviteCode ```bash -csdk submit-invite-code --input +csdk submit-invite-code --input.clientMutationId --input.token ``` diff --git a/skills/cli-admin/references/submit-org-invite-code.md b/skills/cli-admin/references/submit-org-invite-code.md index e09722277..93545f1a7 100644 --- a/skills/cli-admin/references/submit-org-invite-code.md +++ b/skills/cli-admin/references/submit-org-invite-code.md @@ -7,7 +7,7 @@ Execute the submitOrgInviteCode mutation ## Usage ```bash -csdk submit-org-invite-code --input +csdk submit-org-invite-code --input.clientMutationId --input.token ``` ## Examples @@ -15,5 +15,5 @@ csdk submit-org-invite-code --input ### Run submitOrgInviteCode ```bash -csdk submit-org-invite-code --input +csdk submit-org-invite-code --input.clientMutationId --input.token ``` diff --git a/skills/cli-auth/SKILL.md b/skills/cli-auth/SKILL.md index b635a868c..14063abed 100644 --- a/skills/cli-auth/SKILL.md +++ b/skills/cli-auth/SKILL.md @@ -23,6 +23,9 @@ csdk auth set-token csdk role-type list csdk role-type get --id csdk role-type create -- + +# Non-interactive mode (skip all prompts, use flags only) +csdk --no-tty role-type list ``` ## Examples @@ -36,6 +39,12 @@ csdk auth set-token csdk role-type list ``` +### Non-interactive mode (for scripts and CI) + +```bash +csdk --no-tty role-type create -- +``` + ## References See the `references/` directory for detailed per-entity API documentation: diff --git a/skills/cli-auth/references/audit-log.md b/skills/cli-auth/references/audit-log.md index df0b685d1..d7f2f0987 100644 --- a/skills/cli-auth/references/audit-log.md +++ b/skills/cli-auth/references/audit-log.md @@ -9,7 +9,7 @@ CRUD operations for AuditLog records via csdk CLI ```bash csdk audit-log list csdk audit-log get --id -csdk audit-log create --event --actorId --origin --userAgent --ipAddress --success +csdk audit-log create --event --success [--actorId ] [--origin ] [--userAgent ] [--ipAddress ] csdk audit-log update --id [--event ] [--actorId ] [--origin ] [--userAgent ] [--ipAddress ] [--success ] csdk audit-log delete --id ``` @@ -25,7 +25,7 @@ csdk audit-log list ### Create a auditLog ```bash -csdk audit-log create --event "value" --actorId "value" --origin "value" --userAgent "value" --ipAddress "value" --success "value" +csdk audit-log create --event --success [--actorId ] [--origin ] [--userAgent ] [--ipAddress ] ``` ### Get a auditLog by id diff --git a/skills/cli-auth/references/check-password.md b/skills/cli-auth/references/check-password.md index 4e91066c5..32842e3fd 100644 --- a/skills/cli-auth/references/check-password.md +++ b/skills/cli-auth/references/check-password.md @@ -7,7 +7,7 @@ Execute the checkPassword mutation ## Usage ```bash -csdk check-password --input +csdk check-password --input.clientMutationId --input.password ``` ## Examples @@ -15,5 +15,5 @@ csdk check-password --input ### Run checkPassword ```bash -csdk check-password --input +csdk check-password --input.clientMutationId --input.password ``` diff --git a/skills/cli-auth/references/confirm-delete-account.md b/skills/cli-auth/references/confirm-delete-account.md index 7b7bcaeb1..8107aa248 100644 --- a/skills/cli-auth/references/confirm-delete-account.md +++ b/skills/cli-auth/references/confirm-delete-account.md @@ -7,7 +7,7 @@ Execute the confirmDeleteAccount mutation ## Usage ```bash -csdk confirm-delete-account --input +csdk confirm-delete-account --input.clientMutationId --input.userId --input.token ``` ## Examples @@ -15,5 +15,5 @@ csdk confirm-delete-account --input ### Run confirmDeleteAccount ```bash -csdk confirm-delete-account --input +csdk confirm-delete-account --input.clientMutationId --input.userId --input.token ``` diff --git a/skills/cli-auth/references/connected-account.md b/skills/cli-auth/references/connected-account.md index f8cf7cb50..8223fc5d1 100644 --- a/skills/cli-auth/references/connected-account.md +++ b/skills/cli-auth/references/connected-account.md @@ -9,7 +9,7 @@ CRUD operations for ConnectedAccount records via csdk CLI ```bash csdk connected-account list csdk connected-account get --id -csdk connected-account create --ownerId --service --identifier --details --isVerified +csdk connected-account create --service --identifier --details [--ownerId ] [--isVerified ] csdk connected-account update --id [--ownerId ] [--service ] [--identifier ] [--details ] [--isVerified ] csdk connected-account delete --id ``` @@ -25,7 +25,7 @@ csdk connected-account list ### Create a connectedAccount ```bash -csdk connected-account create --ownerId "value" --service "value" --identifier "value" --details "value" --isVerified "value" +csdk connected-account create --service --identifier --details [--ownerId ] [--isVerified ] ``` ### Get a connectedAccount by id diff --git a/skills/cli-auth/references/crypto-address.md b/skills/cli-auth/references/crypto-address.md index ad22ed0a8..de3b59bfd 100644 --- a/skills/cli-auth/references/crypto-address.md +++ b/skills/cli-auth/references/crypto-address.md @@ -9,7 +9,7 @@ CRUD operations for CryptoAddress records via csdk CLI ```bash csdk crypto-address list csdk crypto-address get --id -csdk crypto-address create --ownerId --address --isVerified --isPrimary +csdk crypto-address create --address [--ownerId ] [--isVerified ] [--isPrimary ] csdk crypto-address update --id [--ownerId ] [--address ] [--isVerified ] [--isPrimary ] csdk crypto-address delete --id ``` @@ -25,7 +25,7 @@ csdk crypto-address list ### Create a cryptoAddress ```bash -csdk crypto-address create --ownerId "value" --address "value" --isVerified "value" --isPrimary "value" +csdk crypto-address create --address [--ownerId ] [--isVerified ] [--isPrimary ] ``` ### Get a cryptoAddress by id diff --git a/skills/cli-auth/references/email.md b/skills/cli-auth/references/email.md index 960928427..86bc34fdb 100644 --- a/skills/cli-auth/references/email.md +++ b/skills/cli-auth/references/email.md @@ -9,7 +9,7 @@ CRUD operations for Email records via csdk CLI ```bash csdk email list csdk email get --id -csdk email create --ownerId --email --isVerified --isPrimary +csdk email create --email [--ownerId ] [--isVerified ] [--isPrimary ] csdk email update --id [--ownerId ] [--email ] [--isVerified ] [--isPrimary ] csdk email delete --id ``` @@ -25,7 +25,7 @@ csdk email list ### Create a email ```bash -csdk email create --ownerId "value" --email "value" --isVerified "value" --isPrimary "value" +csdk email create --email [--ownerId ] [--isVerified ] [--isPrimary ] ``` ### Get a email by id diff --git a/skills/cli-auth/references/extend-token-expires.md b/skills/cli-auth/references/extend-token-expires.md index e49a37fd4..a65d0c4be 100644 --- a/skills/cli-auth/references/extend-token-expires.md +++ b/skills/cli-auth/references/extend-token-expires.md @@ -7,7 +7,7 @@ Execute the extendTokenExpires mutation ## Usage ```bash -csdk extend-token-expires --input +csdk extend-token-expires --input.clientMutationId --input.amount ``` ## Examples @@ -15,5 +15,5 @@ csdk extend-token-expires --input ### Run extendTokenExpires ```bash -csdk extend-token-expires --input +csdk extend-token-expires --input.clientMutationId --input.amount ``` diff --git a/skills/cli-auth/references/forgot-password.md b/skills/cli-auth/references/forgot-password.md index a3d51ab48..6d566389c 100644 --- a/skills/cli-auth/references/forgot-password.md +++ b/skills/cli-auth/references/forgot-password.md @@ -7,7 +7,7 @@ Execute the forgotPassword mutation ## Usage ```bash -csdk forgot-password --input +csdk forgot-password --input.clientMutationId --input.email ``` ## Examples @@ -15,5 +15,5 @@ csdk forgot-password --input ### Run forgotPassword ```bash -csdk forgot-password --input +csdk forgot-password --input.clientMutationId --input.email ``` diff --git a/skills/cli-auth/references/one-time-token.md b/skills/cli-auth/references/one-time-token.md index 870b071c6..5649f5c11 100644 --- a/skills/cli-auth/references/one-time-token.md +++ b/skills/cli-auth/references/one-time-token.md @@ -7,7 +7,7 @@ Execute the oneTimeToken mutation ## Usage ```bash -csdk one-time-token --input +csdk one-time-token --input.clientMutationId --input.email --input.password --input.origin --input.rememberMe ``` ## Examples @@ -15,5 +15,5 @@ csdk one-time-token --input ### Run oneTimeToken ```bash -csdk one-time-token --input +csdk one-time-token --input.clientMutationId --input.email --input.password --input.origin --input.rememberMe ``` diff --git a/skills/cli-auth/references/phone-number.md b/skills/cli-auth/references/phone-number.md index 1c607d10b..25c2b3f02 100644 --- a/skills/cli-auth/references/phone-number.md +++ b/skills/cli-auth/references/phone-number.md @@ -9,7 +9,7 @@ CRUD operations for PhoneNumber records via csdk CLI ```bash csdk phone-number list csdk phone-number get --id -csdk phone-number create --ownerId --cc --number --isVerified --isPrimary +csdk phone-number create --cc --number [--ownerId ] [--isVerified ] [--isPrimary ] csdk phone-number update --id [--ownerId ] [--cc ] [--number ] [--isVerified ] [--isPrimary ] csdk phone-number delete --id ``` @@ -25,7 +25,7 @@ csdk phone-number list ### Create a phoneNumber ```bash -csdk phone-number create --ownerId "value" --cc "value" --number "value" --isVerified "value" --isPrimary "value" +csdk phone-number create --cc --number [--ownerId ] [--isVerified ] [--isPrimary ] ``` ### Get a phoneNumber by id diff --git a/skills/cli-auth/references/reset-password.md b/skills/cli-auth/references/reset-password.md index cb9e666a6..7a52ad0a0 100644 --- a/skills/cli-auth/references/reset-password.md +++ b/skills/cli-auth/references/reset-password.md @@ -7,7 +7,7 @@ Execute the resetPassword mutation ## Usage ```bash -csdk reset-password --input +csdk reset-password --input.clientMutationId --input.roleId --input.resetToken --input.newPassword ``` ## Examples @@ -15,5 +15,5 @@ csdk reset-password --input ### Run resetPassword ```bash -csdk reset-password --input +csdk reset-password --input.clientMutationId --input.roleId --input.resetToken --input.newPassword ``` diff --git a/skills/cli-auth/references/role-type.md b/skills/cli-auth/references/role-type.md index a6b83f75f..f00f9e6c4 100644 --- a/skills/cli-auth/references/role-type.md +++ b/skills/cli-auth/references/role-type.md @@ -25,7 +25,7 @@ csdk role-type list ### Create a roleType ```bash -csdk role-type create --name "value" +csdk role-type create --name ``` ### Get a roleType by id diff --git a/skills/cli-auth/references/send-account-deletion-email.md b/skills/cli-auth/references/send-account-deletion-email.md index e89c21d02..8f9014e27 100644 --- a/skills/cli-auth/references/send-account-deletion-email.md +++ b/skills/cli-auth/references/send-account-deletion-email.md @@ -7,7 +7,7 @@ Execute the sendAccountDeletionEmail mutation ## Usage ```bash -csdk send-account-deletion-email --input +csdk send-account-deletion-email --input.clientMutationId ``` ## Examples @@ -15,5 +15,5 @@ csdk send-account-deletion-email --input ### Run sendAccountDeletionEmail ```bash -csdk send-account-deletion-email --input +csdk send-account-deletion-email --input.clientMutationId ``` diff --git a/skills/cli-auth/references/send-verification-email.md b/skills/cli-auth/references/send-verification-email.md index c0e6e05ee..de04a0acd 100644 --- a/skills/cli-auth/references/send-verification-email.md +++ b/skills/cli-auth/references/send-verification-email.md @@ -7,7 +7,7 @@ Execute the sendVerificationEmail mutation ## Usage ```bash -csdk send-verification-email --input +csdk send-verification-email --input.clientMutationId --input.email ``` ## Examples @@ -15,5 +15,5 @@ csdk send-verification-email --input ### Run sendVerificationEmail ```bash -csdk send-verification-email --input +csdk send-verification-email --input.clientMutationId --input.email ``` diff --git a/skills/cli-auth/references/set-password.md b/skills/cli-auth/references/set-password.md index df8a616d0..a53748330 100644 --- a/skills/cli-auth/references/set-password.md +++ b/skills/cli-auth/references/set-password.md @@ -7,7 +7,7 @@ Execute the setPassword mutation ## Usage ```bash -csdk set-password --input +csdk set-password --input.clientMutationId --input.currentPassword --input.newPassword ``` ## Examples @@ -15,5 +15,5 @@ csdk set-password --input ### Run setPassword ```bash -csdk set-password --input +csdk set-password --input.clientMutationId --input.currentPassword --input.newPassword ``` diff --git a/skills/cli-auth/references/sign-in-one-time-token.md b/skills/cli-auth/references/sign-in-one-time-token.md index a525541e0..ff2410414 100644 --- a/skills/cli-auth/references/sign-in-one-time-token.md +++ b/skills/cli-auth/references/sign-in-one-time-token.md @@ -7,7 +7,7 @@ Execute the signInOneTimeToken mutation ## Usage ```bash -csdk sign-in-one-time-token --input +csdk sign-in-one-time-token --input.clientMutationId --input.token --input.credentialKind ``` ## Examples @@ -15,5 +15,5 @@ csdk sign-in-one-time-token --input ### Run signInOneTimeToken ```bash -csdk sign-in-one-time-token --input +csdk sign-in-one-time-token --input.clientMutationId --input.token --input.credentialKind ``` diff --git a/skills/cli-auth/references/sign-in.md b/skills/cli-auth/references/sign-in.md index 5b8fb1c9c..54fbe6864 100644 --- a/skills/cli-auth/references/sign-in.md +++ b/skills/cli-auth/references/sign-in.md @@ -7,7 +7,7 @@ Execute the signIn mutation ## Usage ```bash -csdk sign-in --input +csdk sign-in --input.clientMutationId --input.email --input.password --input.rememberMe --input.credentialKind --input.csrfToken ``` ## Examples @@ -15,5 +15,5 @@ csdk sign-in --input ### Run signIn ```bash -csdk sign-in --input +csdk sign-in --input.clientMutationId --input.email --input.password --input.rememberMe --input.credentialKind --input.csrfToken ``` diff --git a/skills/cli-auth/references/sign-out.md b/skills/cli-auth/references/sign-out.md index 717b8923d..f4a29351d 100644 --- a/skills/cli-auth/references/sign-out.md +++ b/skills/cli-auth/references/sign-out.md @@ -7,7 +7,7 @@ Execute the signOut mutation ## Usage ```bash -csdk sign-out --input +csdk sign-out --input.clientMutationId ``` ## Examples @@ -15,5 +15,5 @@ csdk sign-out --input ### Run signOut ```bash -csdk sign-out --input +csdk sign-out --input.clientMutationId ``` diff --git a/skills/cli-auth/references/sign-up.md b/skills/cli-auth/references/sign-up.md index fd17fb1e1..7b69210e2 100644 --- a/skills/cli-auth/references/sign-up.md +++ b/skills/cli-auth/references/sign-up.md @@ -7,7 +7,7 @@ Execute the signUp mutation ## Usage ```bash -csdk sign-up --input +csdk sign-up --input.clientMutationId --input.email --input.password --input.rememberMe --input.credentialKind --input.csrfToken ``` ## Examples @@ -15,5 +15,5 @@ csdk sign-up --input ### Run signUp ```bash -csdk sign-up --input +csdk sign-up --input.clientMutationId --input.email --input.password --input.rememberMe --input.credentialKind --input.csrfToken ``` diff --git a/skills/cli-auth/references/user.md b/skills/cli-auth/references/user.md index e3d28ef47..69d26e25e 100644 --- a/skills/cli-auth/references/user.md +++ b/skills/cli-auth/references/user.md @@ -9,7 +9,7 @@ CRUD operations for User records via csdk CLI ```bash csdk user list csdk user get --id -csdk user create --username --displayName --profilePicture --searchTsv --type --searchTsvRank +csdk user create --searchTsvRank [--username ] [--displayName ] [--profilePicture ] [--searchTsv ] [--type ] csdk user update --id [--username ] [--displayName ] [--profilePicture ] [--searchTsv ] [--type ] [--searchTsvRank ] csdk user delete --id ``` @@ -25,7 +25,7 @@ csdk user list ### Create a user ```bash -csdk user create --username "value" --displayName "value" --profilePicture "value" --searchTsv "value" --type "value" --searchTsvRank "value" +csdk user create --searchTsvRank [--username ] [--displayName ] [--profilePicture ] [--searchTsv ] [--type ] ``` ### Get a user by id diff --git a/skills/cli-auth/references/verify-email.md b/skills/cli-auth/references/verify-email.md index 4a2a6b0d0..1f9aa7a34 100644 --- a/skills/cli-auth/references/verify-email.md +++ b/skills/cli-auth/references/verify-email.md @@ -7,7 +7,7 @@ Execute the verifyEmail mutation ## Usage ```bash -csdk verify-email --input +csdk verify-email --input.clientMutationId --input.emailId --input.token ``` ## Examples @@ -15,5 +15,5 @@ csdk verify-email --input ### Run verifyEmail ```bash -csdk verify-email --input +csdk verify-email --input.clientMutationId --input.emailId --input.token ``` diff --git a/skills/cli-auth/references/verify-password.md b/skills/cli-auth/references/verify-password.md index fa857e719..565a73c82 100644 --- a/skills/cli-auth/references/verify-password.md +++ b/skills/cli-auth/references/verify-password.md @@ -7,7 +7,7 @@ Execute the verifyPassword mutation ## Usage ```bash -csdk verify-password --input +csdk verify-password --input.clientMutationId --input.password ``` ## Examples @@ -15,5 +15,5 @@ csdk verify-password --input ### Run verifyPassword ```bash -csdk verify-password --input +csdk verify-password --input.clientMutationId --input.password ``` diff --git a/skills/cli-auth/references/verify-totp.md b/skills/cli-auth/references/verify-totp.md index 04b4f30be..1bff74409 100644 --- a/skills/cli-auth/references/verify-totp.md +++ b/skills/cli-auth/references/verify-totp.md @@ -7,7 +7,7 @@ Execute the verifyTotp mutation ## Usage ```bash -csdk verify-totp --input +csdk verify-totp --input.clientMutationId --input.totpValue ``` ## Examples @@ -15,5 +15,5 @@ csdk verify-totp --input ### Run verifyTotp ```bash -csdk verify-totp --input +csdk verify-totp --input.clientMutationId --input.totpValue ``` diff --git a/skills/cli-objects/SKILL.md b/skills/cli-objects/SKILL.md index d09f60bd6..51e15c0c8 100644 --- a/skills/cli-objects/SKILL.md +++ b/skills/cli-objects/SKILL.md @@ -23,6 +23,9 @@ csdk auth set-token csdk get-all-record list csdk get-all-record get --id csdk get-all-record create -- + +# Non-interactive mode (skip all prompts, use flags only) +csdk --no-tty get-all-record list ``` ## Examples @@ -36,6 +39,12 @@ csdk auth set-token csdk get-all-record list ``` +### Non-interactive mode (for scripts and CI) + +```bash +csdk --no-tty get-all-record create -- +``` + ## References See the `references/` directory for detailed per-entity API documentation: diff --git a/skills/cli-objects/references/commit.md b/skills/cli-objects/references/commit.md index a0e0a701c..72a80f6a1 100644 --- a/skills/cli-objects/references/commit.md +++ b/skills/cli-objects/references/commit.md @@ -9,7 +9,7 @@ CRUD operations for Commit records via csdk CLI ```bash csdk commit list csdk commit get --id -csdk commit create --message --databaseId --storeId --parentIds --authorId --committerId --treeId --date +csdk commit create --databaseId --storeId [--message ] [--parentIds ] [--authorId ] [--committerId ] [--treeId ] [--date ] csdk commit update --id [--message ] [--databaseId ] [--storeId ] [--parentIds ] [--authorId ] [--committerId ] [--treeId ] [--date ] csdk commit delete --id ``` @@ -25,7 +25,7 @@ csdk commit list ### Create a commit ```bash -csdk commit create --message "value" --databaseId "value" --storeId "value" --parentIds "value" --authorId "value" --committerId "value" --treeId "value" --date "value" +csdk commit create --databaseId --storeId [--message ] [--parentIds ] [--authorId ] [--committerId ] [--treeId ] [--date ] ``` ### Get a commit by id diff --git a/skills/cli-objects/references/freeze-objects.md b/skills/cli-objects/references/freeze-objects.md index ccbe73bc5..d7d659aed 100644 --- a/skills/cli-objects/references/freeze-objects.md +++ b/skills/cli-objects/references/freeze-objects.md @@ -7,7 +7,7 @@ Execute the freezeObjects mutation ## Usage ```bash -csdk freeze-objects --input +csdk freeze-objects --input.clientMutationId --input.databaseId --input.id ``` ## Examples @@ -15,5 +15,5 @@ csdk freeze-objects --input ### Run freezeObjects ```bash -csdk freeze-objects --input +csdk freeze-objects --input.clientMutationId --input.databaseId --input.id ``` diff --git a/skills/cli-objects/references/get-all-record.md b/skills/cli-objects/references/get-all-record.md index b52c0b95c..18e738512 100644 --- a/skills/cli-objects/references/get-all-record.md +++ b/skills/cli-objects/references/get-all-record.md @@ -25,7 +25,7 @@ csdk get-all-record list ### Create a getAllRecord ```bash -csdk get-all-record create --path "value" --data "value" +csdk get-all-record create --path --data ``` ### Get a getAllRecord by id diff --git a/skills/cli-objects/references/init-empty-repo.md b/skills/cli-objects/references/init-empty-repo.md index 06fc74e9e..dfac16a2c 100644 --- a/skills/cli-objects/references/init-empty-repo.md +++ b/skills/cli-objects/references/init-empty-repo.md @@ -7,7 +7,7 @@ Execute the initEmptyRepo mutation ## Usage ```bash -csdk init-empty-repo --input +csdk init-empty-repo --input.clientMutationId --input.dbId --input.storeId ``` ## Examples @@ -15,5 +15,5 @@ csdk init-empty-repo --input ### Run initEmptyRepo ```bash -csdk init-empty-repo --input +csdk init-empty-repo --input.clientMutationId --input.dbId --input.storeId ``` diff --git a/skills/cli-objects/references/insert-node-at-path.md b/skills/cli-objects/references/insert-node-at-path.md index 7af725e74..4a95b904d 100644 --- a/skills/cli-objects/references/insert-node-at-path.md +++ b/skills/cli-objects/references/insert-node-at-path.md @@ -7,7 +7,7 @@ Execute the insertNodeAtPath mutation ## Usage ```bash -csdk insert-node-at-path --input +csdk insert-node-at-path --input.clientMutationId --input.dbId --input.root --input.path --input.data --input.kids --input.ktree ``` ## Examples @@ -15,5 +15,5 @@ csdk insert-node-at-path --input ### Run insertNodeAtPath ```bash -csdk insert-node-at-path --input +csdk insert-node-at-path --input.clientMutationId --input.dbId --input.root --input.path --input.data --input.kids --input.ktree ``` diff --git a/skills/cli-objects/references/object.md b/skills/cli-objects/references/object.md index 2c6ad2c83..a49ba8ef6 100644 --- a/skills/cli-objects/references/object.md +++ b/skills/cli-objects/references/object.md @@ -9,7 +9,7 @@ CRUD operations for Object records via csdk CLI ```bash csdk object list csdk object get --id -csdk object create --hashUuid --databaseId --kids --ktree --data --frzn +csdk object create --hashUuid --databaseId [--kids ] [--ktree ] [--data ] [--frzn ] csdk object update --id [--hashUuid ] [--databaseId ] [--kids ] [--ktree ] [--data ] [--frzn ] csdk object delete --id ``` @@ -25,7 +25,7 @@ csdk object list ### Create a object ```bash -csdk object create --hashUuid "value" --databaseId "value" --kids "value" --ktree "value" --data "value" --frzn "value" +csdk object create --hashUuid --databaseId [--kids ] [--ktree ] [--data ] [--frzn ] ``` ### Get a object by id diff --git a/skills/cli-objects/references/ref.md b/skills/cli-objects/references/ref.md index eb5962f43..1115ca4e4 100644 --- a/skills/cli-objects/references/ref.md +++ b/skills/cli-objects/references/ref.md @@ -9,7 +9,7 @@ CRUD operations for Ref records via csdk CLI ```bash csdk ref list csdk ref get --id -csdk ref create --name --databaseId --storeId --commitId +csdk ref create --name --databaseId --storeId [--commitId ] csdk ref update --id [--name ] [--databaseId ] [--storeId ] [--commitId ] csdk ref delete --id ``` @@ -25,7 +25,7 @@ csdk ref list ### Create a ref ```bash -csdk ref create --name "value" --databaseId "value" --storeId "value" --commitId "value" +csdk ref create --name --databaseId --storeId [--commitId ] ``` ### Get a ref by id diff --git a/skills/cli-objects/references/remove-node-at-path.md b/skills/cli-objects/references/remove-node-at-path.md index 4c08b622a..5a4c3906c 100644 --- a/skills/cli-objects/references/remove-node-at-path.md +++ b/skills/cli-objects/references/remove-node-at-path.md @@ -7,7 +7,7 @@ Execute the removeNodeAtPath mutation ## Usage ```bash -csdk remove-node-at-path --input +csdk remove-node-at-path --input.clientMutationId --input.dbId --input.root --input.path ``` ## Examples @@ -15,5 +15,5 @@ csdk remove-node-at-path --input ### Run removeNodeAtPath ```bash -csdk remove-node-at-path --input +csdk remove-node-at-path --input.clientMutationId --input.dbId --input.root --input.path ``` diff --git a/skills/cli-objects/references/set-and-commit.md b/skills/cli-objects/references/set-and-commit.md index b3c180d35..419777f6b 100644 --- a/skills/cli-objects/references/set-and-commit.md +++ b/skills/cli-objects/references/set-and-commit.md @@ -7,7 +7,7 @@ Execute the setAndCommit mutation ## Usage ```bash -csdk set-and-commit --input +csdk set-and-commit --input.clientMutationId --input.dbId --input.storeId --input.refname --input.path --input.data --input.kids --input.ktree ``` ## Examples @@ -15,5 +15,5 @@ csdk set-and-commit --input ### Run setAndCommit ```bash -csdk set-and-commit --input +csdk set-and-commit --input.clientMutationId --input.dbId --input.storeId --input.refname --input.path --input.data --input.kids --input.ktree ``` diff --git a/skills/cli-objects/references/set-data-at-path.md b/skills/cli-objects/references/set-data-at-path.md index efb3ba4b9..7fe032779 100644 --- a/skills/cli-objects/references/set-data-at-path.md +++ b/skills/cli-objects/references/set-data-at-path.md @@ -7,7 +7,7 @@ Execute the setDataAtPath mutation ## Usage ```bash -csdk set-data-at-path --input +csdk set-data-at-path --input.clientMutationId --input.dbId --input.root --input.path --input.data ``` ## Examples @@ -15,5 +15,5 @@ csdk set-data-at-path --input ### Run setDataAtPath ```bash -csdk set-data-at-path --input +csdk set-data-at-path --input.clientMutationId --input.dbId --input.root --input.path --input.data ``` diff --git a/skills/cli-objects/references/set-props-and-commit.md b/skills/cli-objects/references/set-props-and-commit.md index 8767344e9..cdb7d15a0 100644 --- a/skills/cli-objects/references/set-props-and-commit.md +++ b/skills/cli-objects/references/set-props-and-commit.md @@ -7,7 +7,7 @@ Execute the setPropsAndCommit mutation ## Usage ```bash -csdk set-props-and-commit --input +csdk set-props-and-commit --input.clientMutationId --input.dbId --input.storeId --input.refname --input.path --input.data ``` ## Examples @@ -15,5 +15,5 @@ csdk set-props-and-commit --input ### Run setPropsAndCommit ```bash -csdk set-props-and-commit --input +csdk set-props-and-commit --input.clientMutationId --input.dbId --input.storeId --input.refname --input.path --input.data ``` diff --git a/skills/cli-objects/references/store.md b/skills/cli-objects/references/store.md index 3ae73ddbc..6f1a7482e 100644 --- a/skills/cli-objects/references/store.md +++ b/skills/cli-objects/references/store.md @@ -9,7 +9,7 @@ CRUD operations for Store records via csdk CLI ```bash csdk store list csdk store get --id -csdk store create --name --databaseId --hash +csdk store create --name --databaseId [--hash ] csdk store update --id [--name ] [--databaseId ] [--hash ] csdk store delete --id ``` @@ -25,7 +25,7 @@ csdk store list ### Create a store ```bash -csdk store create --name "value" --databaseId "value" --hash "value" +csdk store create --name --databaseId [--hash ] ``` ### Get a store by id diff --git a/skills/cli-objects/references/update-node-at-path.md b/skills/cli-objects/references/update-node-at-path.md index 8374c33e7..289876550 100644 --- a/skills/cli-objects/references/update-node-at-path.md +++ b/skills/cli-objects/references/update-node-at-path.md @@ -7,7 +7,7 @@ Execute the updateNodeAtPath mutation ## Usage ```bash -csdk update-node-at-path --input +csdk update-node-at-path --input.clientMutationId --input.dbId --input.root --input.path --input.data --input.kids --input.ktree ``` ## Examples @@ -15,5 +15,5 @@ csdk update-node-at-path --input ### Run updateNodeAtPath ```bash -csdk update-node-at-path --input +csdk update-node-at-path --input.clientMutationId --input.dbId --input.root --input.path --input.data --input.kids --input.ktree ``` diff --git a/skills/cli-public/SKILL.md b/skills/cli-public/SKILL.md index 48bd091e1..73d443794 100644 --- a/skills/cli-public/SKILL.md +++ b/skills/cli-public/SKILL.md @@ -23,6 +23,9 @@ csdk auth set-token csdk org-get-managers-record list csdk org-get-managers-record get --id csdk org-get-managers-record create -- + +# Non-interactive mode (skip all prompts, use flags only) +csdk --no-tty org-get-managers-record list ``` ## Examples @@ -36,6 +39,12 @@ csdk auth set-token csdk org-get-managers-record list ``` +### Non-interactive mode (for scripts and CI) + +```bash +csdk --no-tty org-get-managers-record create -- +``` + ## References See the `references/` directory for detailed per-entity API documentation: diff --git a/skills/cli-public/references/api-module.md b/skills/cli-public/references/api-module.md index 4377d091b..b54ab09cb 100644 --- a/skills/cli-public/references/api-module.md +++ b/skills/cli-public/references/api-module.md @@ -25,7 +25,7 @@ csdk api-module list ### Create a apiModule ```bash -csdk api-module create --databaseId "value" --apiId "value" --name "value" --data "value" +csdk api-module create --databaseId --apiId --name --data ``` ### Get a apiModule by id diff --git a/skills/cli-public/references/api-schema.md b/skills/cli-public/references/api-schema.md index 2711ccb38..93b7e9401 100644 --- a/skills/cli-public/references/api-schema.md +++ b/skills/cli-public/references/api-schema.md @@ -25,7 +25,7 @@ csdk api-schema list ### Create a apiSchema ```bash -csdk api-schema create --databaseId "value" --schemaId "value" --apiId "value" +csdk api-schema create --databaseId --schemaId --apiId ``` ### Get a apiSchema by id diff --git a/skills/cli-public/references/api.md b/skills/cli-public/references/api.md index b2b67c0d3..7583a91a7 100644 --- a/skills/cli-public/references/api.md +++ b/skills/cli-public/references/api.md @@ -9,7 +9,7 @@ CRUD operations for Api records via csdk CLI ```bash csdk api list csdk api get --id -csdk api create --databaseId --name --dbname --roleName --anonRole --isPublic +csdk api create --databaseId --name [--dbname ] [--roleName ] [--anonRole ] [--isPublic ] csdk api update --id [--databaseId ] [--name ] [--dbname ] [--roleName ] [--anonRole ] [--isPublic ] csdk api delete --id ``` @@ -25,7 +25,7 @@ csdk api list ### Create a api ```bash -csdk api create --databaseId "value" --name "value" --dbname "value" --roleName "value" --anonRole "value" --isPublic "value" +csdk api create --databaseId --name [--dbname ] [--roleName ] [--anonRole ] [--isPublic ] ``` ### Get a api by id diff --git a/skills/cli-public/references/app-achievement.md b/skills/cli-public/references/app-achievement.md index 96cd03f13..e8055d4fd 100644 --- a/skills/cli-public/references/app-achievement.md +++ b/skills/cli-public/references/app-achievement.md @@ -9,7 +9,7 @@ CRUD operations for AppAchievement records via csdk CLI ```bash csdk app-achievement list csdk app-achievement get --id -csdk app-achievement create --actorId --name --count +csdk app-achievement create --name [--actorId ] [--count ] csdk app-achievement update --id [--actorId ] [--name ] [--count ] csdk app-achievement delete --id ``` @@ -25,7 +25,7 @@ csdk app-achievement list ### Create a appAchievement ```bash -csdk app-achievement create --actorId "value" --name "value" --count "value" +csdk app-achievement create --name [--actorId ] [--count ] ``` ### Get a appAchievement by id diff --git a/skills/cli-public/references/app-admin-grant.md b/skills/cli-public/references/app-admin-grant.md index ad3fef5bf..f54cae59c 100644 --- a/skills/cli-public/references/app-admin-grant.md +++ b/skills/cli-public/references/app-admin-grant.md @@ -9,7 +9,7 @@ CRUD operations for AppAdminGrant records via csdk CLI ```bash csdk app-admin-grant list csdk app-admin-grant get --id -csdk app-admin-grant create --isGrant --actorId --grantorId +csdk app-admin-grant create --actorId [--isGrant ] [--grantorId ] csdk app-admin-grant update --id [--isGrant ] [--actorId ] [--grantorId ] csdk app-admin-grant delete --id ``` @@ -25,7 +25,7 @@ csdk app-admin-grant list ### Create a appAdminGrant ```bash -csdk app-admin-grant create --isGrant "value" --actorId "value" --grantorId "value" +csdk app-admin-grant create --actorId [--isGrant ] [--grantorId ] ``` ### Get a appAdminGrant by id diff --git a/skills/cli-public/references/app-grant.md b/skills/cli-public/references/app-grant.md index dad8808f5..a04cb4079 100644 --- a/skills/cli-public/references/app-grant.md +++ b/skills/cli-public/references/app-grant.md @@ -9,7 +9,7 @@ CRUD operations for AppGrant records via csdk CLI ```bash csdk app-grant list csdk app-grant get --id -csdk app-grant create --permissions --isGrant --actorId --grantorId +csdk app-grant create --actorId [--permissions ] [--isGrant ] [--grantorId ] csdk app-grant update --id [--permissions ] [--isGrant ] [--actorId ] [--grantorId ] csdk app-grant delete --id ``` @@ -25,7 +25,7 @@ csdk app-grant list ### Create a appGrant ```bash -csdk app-grant create --permissions "value" --isGrant "value" --actorId "value" --grantorId "value" +csdk app-grant create --actorId [--permissions ] [--isGrant ] [--grantorId ] ``` ### Get a appGrant by id diff --git a/skills/cli-public/references/app-level-requirement.md b/skills/cli-public/references/app-level-requirement.md index b69a5b226..a08403018 100644 --- a/skills/cli-public/references/app-level-requirement.md +++ b/skills/cli-public/references/app-level-requirement.md @@ -9,7 +9,7 @@ CRUD operations for AppLevelRequirement records via csdk CLI ```bash csdk app-level-requirement list csdk app-level-requirement get --id -csdk app-level-requirement create --name --level --description --requiredCount --priority +csdk app-level-requirement create --name --level [--description ] [--requiredCount ] [--priority ] csdk app-level-requirement update --id [--name ] [--level ] [--description ] [--requiredCount ] [--priority ] csdk app-level-requirement delete --id ``` @@ -25,7 +25,7 @@ csdk app-level-requirement list ### Create a appLevelRequirement ```bash -csdk app-level-requirement create --name "value" --level "value" --description "value" --requiredCount "value" --priority "value" +csdk app-level-requirement create --name --level [--description ] [--requiredCount ] [--priority ] ``` ### Get a appLevelRequirement by id diff --git a/skills/cli-public/references/app-level.md b/skills/cli-public/references/app-level.md index ec99c92f2..3ec5afb86 100644 --- a/skills/cli-public/references/app-level.md +++ b/skills/cli-public/references/app-level.md @@ -9,7 +9,7 @@ CRUD operations for AppLevel records via csdk CLI ```bash csdk app-level list csdk app-level get --id -csdk app-level create --name --description --image --ownerId +csdk app-level create --name [--description ] [--image ] [--ownerId ] csdk app-level update --id [--name ] [--description ] [--image ] [--ownerId ] csdk app-level delete --id ``` @@ -25,7 +25,7 @@ csdk app-level list ### Create a appLevel ```bash -csdk app-level create --name "value" --description "value" --image "value" --ownerId "value" +csdk app-level create --name [--description ] [--image ] [--ownerId ] ``` ### Get a appLevel by id diff --git a/skills/cli-public/references/app-limit-default.md b/skills/cli-public/references/app-limit-default.md index 8317537f7..2aca3f587 100644 --- a/skills/cli-public/references/app-limit-default.md +++ b/skills/cli-public/references/app-limit-default.md @@ -9,7 +9,7 @@ CRUD operations for AppLimitDefault records via csdk CLI ```bash csdk app-limit-default list csdk app-limit-default get --id -csdk app-limit-default create --name --max +csdk app-limit-default create --name [--max ] csdk app-limit-default update --id [--name ] [--max ] csdk app-limit-default delete --id ``` @@ -25,7 +25,7 @@ csdk app-limit-default list ### Create a appLimitDefault ```bash -csdk app-limit-default create --name "value" --max "value" +csdk app-limit-default create --name [--max ] ``` ### Get a appLimitDefault by id diff --git a/skills/cli-public/references/app-limit.md b/skills/cli-public/references/app-limit.md index a80ecd7cf..c1632d535 100644 --- a/skills/cli-public/references/app-limit.md +++ b/skills/cli-public/references/app-limit.md @@ -9,7 +9,7 @@ CRUD operations for AppLimit records via csdk CLI ```bash csdk app-limit list csdk app-limit get --id -csdk app-limit create --name --actorId --num --max +csdk app-limit create --actorId [--name ] [--num ] [--max ] csdk app-limit update --id [--name ] [--actorId ] [--num ] [--max ] csdk app-limit delete --id ``` @@ -25,7 +25,7 @@ csdk app-limit list ### Create a appLimit ```bash -csdk app-limit create --name "value" --actorId "value" --num "value" --max "value" +csdk app-limit create --actorId [--name ] [--num ] [--max ] ``` ### Get a appLimit by id diff --git a/skills/cli-public/references/app-membership-default.md b/skills/cli-public/references/app-membership-default.md index 6f6654de1..2fb906fa3 100644 --- a/skills/cli-public/references/app-membership-default.md +++ b/skills/cli-public/references/app-membership-default.md @@ -9,7 +9,7 @@ CRUD operations for AppMembershipDefault records via csdk CLI ```bash csdk app-membership-default list csdk app-membership-default get --id -csdk app-membership-default create --createdBy --updatedBy --isApproved --isVerified +csdk app-membership-default create [--createdBy ] [--updatedBy ] [--isApproved ] [--isVerified ] csdk app-membership-default update --id [--createdBy ] [--updatedBy ] [--isApproved ] [--isVerified ] csdk app-membership-default delete --id ``` @@ -25,7 +25,7 @@ csdk app-membership-default list ### Create a appMembershipDefault ```bash -csdk app-membership-default create --createdBy "value" --updatedBy "value" --isApproved "value" --isVerified "value" +csdk app-membership-default create [--createdBy ] [--updatedBy ] [--isApproved ] [--isVerified ] ``` ### Get a appMembershipDefault by id diff --git a/skills/cli-public/references/app-membership.md b/skills/cli-public/references/app-membership.md index ebd0760dd..a659dc75e 100644 --- a/skills/cli-public/references/app-membership.md +++ b/skills/cli-public/references/app-membership.md @@ -9,7 +9,7 @@ CRUD operations for AppMembership records via csdk CLI ```bash csdk app-membership list csdk app-membership get --id -csdk app-membership create --createdBy --updatedBy --isApproved --isBanned --isDisabled --isVerified --isActive --isOwner --isAdmin --permissions --granted --actorId --profileId +csdk app-membership create --actorId [--createdBy ] [--updatedBy ] [--isApproved ] [--isBanned ] [--isDisabled ] [--isVerified ] [--isActive ] [--isOwner ] [--isAdmin ] [--permissions ] [--granted ] [--profileId ] csdk app-membership update --id [--createdBy ] [--updatedBy ] [--isApproved ] [--isBanned ] [--isDisabled ] [--isVerified ] [--isActive ] [--isOwner ] [--isAdmin ] [--permissions ] [--granted ] [--actorId ] [--profileId ] csdk app-membership delete --id ``` @@ -25,7 +25,7 @@ csdk app-membership list ### Create a appMembership ```bash -csdk app-membership create --createdBy "value" --updatedBy "value" --isApproved "value" --isBanned "value" --isDisabled "value" --isVerified "value" --isActive "value" --isOwner "value" --isAdmin "value" --permissions "value" --granted "value" --actorId "value" --profileId "value" +csdk app-membership create --actorId [--createdBy ] [--updatedBy ] [--isApproved ] [--isBanned ] [--isDisabled ] [--isVerified ] [--isActive ] [--isOwner ] [--isAdmin ] [--permissions ] [--granted ] [--profileId ] ``` ### Get a appMembership by id diff --git a/skills/cli-public/references/app-owner-grant.md b/skills/cli-public/references/app-owner-grant.md index 62e59f861..35d2826ea 100644 --- a/skills/cli-public/references/app-owner-grant.md +++ b/skills/cli-public/references/app-owner-grant.md @@ -9,7 +9,7 @@ CRUD operations for AppOwnerGrant records via csdk CLI ```bash csdk app-owner-grant list csdk app-owner-grant get --id -csdk app-owner-grant create --isGrant --actorId --grantorId +csdk app-owner-grant create --actorId [--isGrant ] [--grantorId ] csdk app-owner-grant update --id [--isGrant ] [--actorId ] [--grantorId ] csdk app-owner-grant delete --id ``` @@ -25,7 +25,7 @@ csdk app-owner-grant list ### Create a appOwnerGrant ```bash -csdk app-owner-grant create --isGrant "value" --actorId "value" --grantorId "value" +csdk app-owner-grant create --actorId [--isGrant ] [--grantorId ] ``` ### Get a appOwnerGrant by id diff --git a/skills/cli-public/references/app-permission-default.md b/skills/cli-public/references/app-permission-default.md index 3976de27e..e8fcd4f3f 100644 --- a/skills/cli-public/references/app-permission-default.md +++ b/skills/cli-public/references/app-permission-default.md @@ -9,7 +9,7 @@ CRUD operations for AppPermissionDefault records via csdk CLI ```bash csdk app-permission-default list csdk app-permission-default get --id -csdk app-permission-default create --permissions +csdk app-permission-default create [--permissions ] csdk app-permission-default update --id [--permissions ] csdk app-permission-default delete --id ``` @@ -25,7 +25,7 @@ csdk app-permission-default list ### Create a appPermissionDefault ```bash -csdk app-permission-default create --permissions "value" +csdk app-permission-default create [--permissions ] ``` ### Get a appPermissionDefault by id diff --git a/skills/cli-public/references/app-permission.md b/skills/cli-public/references/app-permission.md index d2643e7da..eef95408e 100644 --- a/skills/cli-public/references/app-permission.md +++ b/skills/cli-public/references/app-permission.md @@ -9,7 +9,7 @@ CRUD operations for AppPermission records via csdk CLI ```bash csdk app-permission list csdk app-permission get --id -csdk app-permission create --name --bitnum --bitstr --description +csdk app-permission create [--name ] [--bitnum ] [--bitstr ] [--description ] csdk app-permission update --id [--name ] [--bitnum ] [--bitstr ] [--description ] csdk app-permission delete --id ``` @@ -25,7 +25,7 @@ csdk app-permission list ### Create a appPermission ```bash -csdk app-permission create --name "value" --bitnum "value" --bitstr "value" --description "value" +csdk app-permission create [--name ] [--bitnum ] [--bitstr ] [--description ] ``` ### Get a appPermission by id diff --git a/skills/cli-public/references/app-step.md b/skills/cli-public/references/app-step.md index ece32f606..a32d82784 100644 --- a/skills/cli-public/references/app-step.md +++ b/skills/cli-public/references/app-step.md @@ -9,7 +9,7 @@ CRUD operations for AppStep records via csdk CLI ```bash csdk app-step list csdk app-step get --id -csdk app-step create --actorId --name --count +csdk app-step create --name [--actorId ] [--count ] csdk app-step update --id [--actorId ] [--name ] [--count ] csdk app-step delete --id ``` @@ -25,7 +25,7 @@ csdk app-step list ### Create a appStep ```bash -csdk app-step create --actorId "value" --name "value" --count "value" +csdk app-step create --name [--actorId ] [--count ] ``` ### Get a appStep by id diff --git a/skills/cli-public/references/app.md b/skills/cli-public/references/app.md index 43621e0c7..cb1a44224 100644 --- a/skills/cli-public/references/app.md +++ b/skills/cli-public/references/app.md @@ -9,7 +9,7 @@ CRUD operations for App records via csdk CLI ```bash csdk app list csdk app get --id -csdk app create --databaseId --siteId --name --appImage --appStoreLink --appStoreId --appIdPrefix --playStoreLink +csdk app create --databaseId --siteId [--name ] [--appImage ] [--appStoreLink ] [--appStoreId ] [--appIdPrefix ] [--playStoreLink ] csdk app update --id [--databaseId ] [--siteId ] [--name ] [--appImage ] [--appStoreLink ] [--appStoreId ] [--appIdPrefix ] [--playStoreLink ] csdk app delete --id ``` @@ -25,7 +25,7 @@ csdk app list ### Create a app ```bash -csdk app create --databaseId "value" --siteId "value" --name "value" --appImage "value" --appStoreLink "value" --appStoreId "value" --appIdPrefix "value" --playStoreLink "value" +csdk app create --databaseId --siteId [--name ] [--appImage ] [--appStoreLink ] [--appStoreId ] [--appIdPrefix ] [--playStoreLink ] ``` ### Get a app by id diff --git a/skills/cli-public/references/apply-rls.md b/skills/cli-public/references/apply-rls.md index 60d08c548..9a04cb32e 100644 --- a/skills/cli-public/references/apply-rls.md +++ b/skills/cli-public/references/apply-rls.md @@ -7,7 +7,7 @@ Execute the applyRls mutation ## Usage ```bash -csdk apply-rls --input +csdk apply-rls --input.clientMutationId --input.tableId --input.grants --input.policyType --input.vars --input.fieldIds --input.permissive --input.name ``` ## Examples @@ -15,5 +15,5 @@ csdk apply-rls --input ### Run applyRls ```bash -csdk apply-rls --input +csdk apply-rls --input.clientMutationId --input.tableId --input.grants --input.policyType --input.vars --input.fieldIds --input.permissive --input.name ``` diff --git a/skills/cli-public/references/ast-migration.md b/skills/cli-public/references/ast-migration.md index 9b74216e6..cd3dc5dac 100644 --- a/skills/cli-public/references/ast-migration.md +++ b/skills/cli-public/references/ast-migration.md @@ -9,7 +9,7 @@ CRUD operations for AstMigration records via csdk CLI ```bash csdk ast-migration list csdk ast-migration get --id -csdk ast-migration create --databaseId --name --requires --payload --deploys --deploy --revert --verify --action --actionId --actorId +csdk ast-migration create [--databaseId ] [--name ] [--requires ] [--payload ] [--deploys ] [--deploy ] [--revert ] [--verify ] [--action ] [--actionId ] [--actorId ] csdk ast-migration update --id [--databaseId ] [--name ] [--requires ] [--payload ] [--deploys ] [--deploy ] [--revert ] [--verify ] [--action ] [--actionId ] [--actorId ] csdk ast-migration delete --id ``` @@ -25,7 +25,7 @@ csdk ast-migration list ### Create a astMigration ```bash -csdk ast-migration create --databaseId "value" --name "value" --requires "value" --payload "value" --deploys "value" --deploy "value" --revert "value" --verify "value" --action "value" --actionId "value" --actorId "value" +csdk ast-migration create [--databaseId ] [--name ] [--requires ] [--payload ] [--deploys ] [--deploy ] [--revert ] [--verify ] [--action ] [--actionId ] [--actorId ] ``` ### Get a astMigration by id diff --git a/skills/cli-public/references/audit-log.md b/skills/cli-public/references/audit-log.md index df0b685d1..d7f2f0987 100644 --- a/skills/cli-public/references/audit-log.md +++ b/skills/cli-public/references/audit-log.md @@ -9,7 +9,7 @@ CRUD operations for AuditLog records via csdk CLI ```bash csdk audit-log list csdk audit-log get --id -csdk audit-log create --event --actorId --origin --userAgent --ipAddress --success +csdk audit-log create --event --success [--actorId ] [--origin ] [--userAgent ] [--ipAddress ] csdk audit-log update --id [--event ] [--actorId ] [--origin ] [--userAgent ] [--ipAddress ] [--success ] csdk audit-log delete --id ``` @@ -25,7 +25,7 @@ csdk audit-log list ### Create a auditLog ```bash -csdk audit-log create --event "value" --actorId "value" --origin "value" --userAgent "value" --ipAddress "value" --success "value" +csdk audit-log create --event --success [--actorId ] [--origin ] [--userAgent ] [--ipAddress ] ``` ### Get a auditLog by id diff --git a/skills/cli-public/references/bootstrap-user.md b/skills/cli-public/references/bootstrap-user.md index c7331b9b3..51423abb8 100644 --- a/skills/cli-public/references/bootstrap-user.md +++ b/skills/cli-public/references/bootstrap-user.md @@ -7,7 +7,7 @@ Execute the bootstrapUser mutation ## Usage ```bash -csdk bootstrap-user --input +csdk bootstrap-user --input.clientMutationId --input.targetDatabaseId --input.password --input.isAdmin --input.isOwner --input.username --input.displayName --input.returnApiKey ``` ## Examples @@ -15,5 +15,5 @@ csdk bootstrap-user --input ### Run bootstrapUser ```bash -csdk bootstrap-user --input +csdk bootstrap-user --input.clientMutationId --input.targetDatabaseId --input.password --input.isAdmin --input.isOwner --input.username --input.displayName --input.returnApiKey ``` diff --git a/skills/cli-public/references/check-constraint.md b/skills/cli-public/references/check-constraint.md index 9a1f27759..e85fe6a7b 100644 --- a/skills/cli-public/references/check-constraint.md +++ b/skills/cli-public/references/check-constraint.md @@ -9,7 +9,7 @@ CRUD operations for CheckConstraint records via csdk CLI ```bash csdk check-constraint list csdk check-constraint get --id -csdk check-constraint create --databaseId --tableId --name --type --fieldIds --expr --smartTags --category --module --scope --tags +csdk check-constraint create --tableId --fieldIds [--databaseId ] [--name ] [--type ] [--expr ] [--smartTags ] [--category ] [--module ] [--scope ] [--tags ] csdk check-constraint update --id [--databaseId ] [--tableId ] [--name ] [--type ] [--fieldIds ] [--expr ] [--smartTags ] [--category ] [--module ] [--scope ] [--tags ] csdk check-constraint delete --id ``` @@ -25,7 +25,7 @@ csdk check-constraint list ### Create a checkConstraint ```bash -csdk check-constraint create --databaseId "value" --tableId "value" --name "value" --type "value" --fieldIds "value" --expr "value" --smartTags "value" --category "value" --module "value" --scope "value" --tags "value" +csdk check-constraint create --tableId --fieldIds [--databaseId ] [--name ] [--type ] [--expr ] [--smartTags ] [--category ] [--module ] [--scope ] [--tags ] ``` ### Get a checkConstraint by id diff --git a/skills/cli-public/references/check-password.md b/skills/cli-public/references/check-password.md index 4e91066c5..32842e3fd 100644 --- a/skills/cli-public/references/check-password.md +++ b/skills/cli-public/references/check-password.md @@ -7,7 +7,7 @@ Execute the checkPassword mutation ## Usage ```bash -csdk check-password --input +csdk check-password --input.clientMutationId --input.password ``` ## Examples @@ -15,5 +15,5 @@ csdk check-password --input ### Run checkPassword ```bash -csdk check-password --input +csdk check-password --input.clientMutationId --input.password ``` diff --git a/skills/cli-public/references/claimed-invite.md b/skills/cli-public/references/claimed-invite.md index 6546bf6ad..4861cc94d 100644 --- a/skills/cli-public/references/claimed-invite.md +++ b/skills/cli-public/references/claimed-invite.md @@ -9,7 +9,7 @@ CRUD operations for ClaimedInvite records via csdk CLI ```bash csdk claimed-invite list csdk claimed-invite get --id -csdk claimed-invite create --data --senderId --receiverId +csdk claimed-invite create [--data ] [--senderId ] [--receiverId ] csdk claimed-invite update --id [--data ] [--senderId ] [--receiverId ] csdk claimed-invite delete --id ``` @@ -25,7 +25,7 @@ csdk claimed-invite list ### Create a claimedInvite ```bash -csdk claimed-invite create --data "value" --senderId "value" --receiverId "value" +csdk claimed-invite create [--data ] [--senderId ] [--receiverId ] ``` ### Get a claimedInvite by id diff --git a/skills/cli-public/references/commit.md b/skills/cli-public/references/commit.md index a0e0a701c..72a80f6a1 100644 --- a/skills/cli-public/references/commit.md +++ b/skills/cli-public/references/commit.md @@ -9,7 +9,7 @@ CRUD operations for Commit records via csdk CLI ```bash csdk commit list csdk commit get --id -csdk commit create --message --databaseId --storeId --parentIds --authorId --committerId --treeId --date +csdk commit create --databaseId --storeId [--message ] [--parentIds ] [--authorId ] [--committerId ] [--treeId ] [--date ] csdk commit update --id [--message ] [--databaseId ] [--storeId ] [--parentIds ] [--authorId ] [--committerId ] [--treeId ] [--date ] csdk commit delete --id ``` @@ -25,7 +25,7 @@ csdk commit list ### Create a commit ```bash -csdk commit create --message "value" --databaseId "value" --storeId "value" --parentIds "value" --authorId "value" --committerId "value" --treeId "value" --date "value" +csdk commit create --databaseId --storeId [--message ] [--parentIds ] [--authorId ] [--committerId ] [--treeId ] [--date ] ``` ### Get a commit by id diff --git a/skills/cli-public/references/confirm-delete-account.md b/skills/cli-public/references/confirm-delete-account.md index 7b7bcaeb1..8107aa248 100644 --- a/skills/cli-public/references/confirm-delete-account.md +++ b/skills/cli-public/references/confirm-delete-account.md @@ -7,7 +7,7 @@ Execute the confirmDeleteAccount mutation ## Usage ```bash -csdk confirm-delete-account --input +csdk confirm-delete-account --input.clientMutationId --input.userId --input.token ``` ## Examples @@ -15,5 +15,5 @@ csdk confirm-delete-account --input ### Run confirmDeleteAccount ```bash -csdk confirm-delete-account --input +csdk confirm-delete-account --input.clientMutationId --input.userId --input.token ``` diff --git a/skills/cli-public/references/connected-account.md b/skills/cli-public/references/connected-account.md index f8cf7cb50..8223fc5d1 100644 --- a/skills/cli-public/references/connected-account.md +++ b/skills/cli-public/references/connected-account.md @@ -9,7 +9,7 @@ CRUD operations for ConnectedAccount records via csdk CLI ```bash csdk connected-account list csdk connected-account get --id -csdk connected-account create --ownerId --service --identifier --details --isVerified +csdk connected-account create --service --identifier --details [--ownerId ] [--isVerified ] csdk connected-account update --id [--ownerId ] [--service ] [--identifier ] [--details ] [--isVerified ] csdk connected-account delete --id ``` @@ -25,7 +25,7 @@ csdk connected-account list ### Create a connectedAccount ```bash -csdk connected-account create --ownerId "value" --service "value" --identifier "value" --details "value" --isVerified "value" +csdk connected-account create --service --identifier --details [--ownerId ] [--isVerified ] ``` ### Get a connectedAccount by id diff --git a/skills/cli-public/references/connected-accounts-module.md b/skills/cli-public/references/connected-accounts-module.md index 3a2be04d8..25815530e 100644 --- a/skills/cli-public/references/connected-accounts-module.md +++ b/skills/cli-public/references/connected-accounts-module.md @@ -9,7 +9,7 @@ CRUD operations for ConnectedAccountsModule records via csdk CLI ```bash csdk connected-accounts-module list csdk connected-accounts-module get --id -csdk connected-accounts-module create --databaseId --schemaId --privateSchemaId --tableId --ownerTableId --tableName +csdk connected-accounts-module create --databaseId --tableName [--schemaId ] [--privateSchemaId ] [--tableId ] [--ownerTableId ] csdk connected-accounts-module update --id [--databaseId ] [--schemaId ] [--privateSchemaId ] [--tableId ] [--ownerTableId ] [--tableName ] csdk connected-accounts-module delete --id ``` @@ -25,7 +25,7 @@ csdk connected-accounts-module list ### Create a connectedAccountsModule ```bash -csdk connected-accounts-module create --databaseId "value" --schemaId "value" --privateSchemaId "value" --tableId "value" --ownerTableId "value" --tableName "value" +csdk connected-accounts-module create --databaseId --tableName [--schemaId ] [--privateSchemaId ] [--tableId ] [--ownerTableId ] ``` ### Get a connectedAccountsModule by id diff --git a/skills/cli-public/references/create-user-database.md b/skills/cli-public/references/create-user-database.md index 8afd99a84..401f7a4c1 100644 --- a/skills/cli-public/references/create-user-database.md +++ b/skills/cli-public/references/create-user-database.md @@ -23,7 +23,7 @@ Example usage: ## Usage ```bash -csdk create-user-database --input +csdk create-user-database --input.clientMutationId --input.databaseName --input.ownerId --input.includeInvites --input.includeGroups --input.includeLevels --input.bitlen --input.tokensExpiration ``` ## Examples @@ -31,5 +31,5 @@ csdk create-user-database --input ### Run createUserDatabase ```bash -csdk create-user-database --input +csdk create-user-database --input.clientMutationId --input.databaseName --input.ownerId --input.includeInvites --input.includeGroups --input.includeLevels --input.bitlen --input.tokensExpiration ``` diff --git a/skills/cli-public/references/crypto-address.md b/skills/cli-public/references/crypto-address.md index ad22ed0a8..de3b59bfd 100644 --- a/skills/cli-public/references/crypto-address.md +++ b/skills/cli-public/references/crypto-address.md @@ -9,7 +9,7 @@ CRUD operations for CryptoAddress records via csdk CLI ```bash csdk crypto-address list csdk crypto-address get --id -csdk crypto-address create --ownerId --address --isVerified --isPrimary +csdk crypto-address create --address [--ownerId ] [--isVerified ] [--isPrimary ] csdk crypto-address update --id [--ownerId ] [--address ] [--isVerified ] [--isPrimary ] csdk crypto-address delete --id ``` @@ -25,7 +25,7 @@ csdk crypto-address list ### Create a cryptoAddress ```bash -csdk crypto-address create --ownerId "value" --address "value" --isVerified "value" --isPrimary "value" +csdk crypto-address create --address [--ownerId ] [--isVerified ] [--isPrimary ] ``` ### Get a cryptoAddress by id diff --git a/skills/cli-public/references/crypto-addresses-module.md b/skills/cli-public/references/crypto-addresses-module.md index 4294437f7..81830aa6a 100644 --- a/skills/cli-public/references/crypto-addresses-module.md +++ b/skills/cli-public/references/crypto-addresses-module.md @@ -9,7 +9,7 @@ CRUD operations for CryptoAddressesModule records via csdk CLI ```bash csdk crypto-addresses-module list csdk crypto-addresses-module get --id -csdk crypto-addresses-module create --databaseId --schemaId --privateSchemaId --tableId --ownerTableId --tableName --cryptoNetwork +csdk crypto-addresses-module create --databaseId --tableName [--schemaId ] [--privateSchemaId ] [--tableId ] [--ownerTableId ] [--cryptoNetwork ] csdk crypto-addresses-module update --id [--databaseId ] [--schemaId ] [--privateSchemaId ] [--tableId ] [--ownerTableId ] [--tableName ] [--cryptoNetwork ] csdk crypto-addresses-module delete --id ``` @@ -25,7 +25,7 @@ csdk crypto-addresses-module list ### Create a cryptoAddressesModule ```bash -csdk crypto-addresses-module create --databaseId "value" --schemaId "value" --privateSchemaId "value" --tableId "value" --ownerTableId "value" --tableName "value" --cryptoNetwork "value" +csdk crypto-addresses-module create --databaseId --tableName [--schemaId ] [--privateSchemaId ] [--tableId ] [--ownerTableId ] [--cryptoNetwork ] ``` ### Get a cryptoAddressesModule by id diff --git a/skills/cli-public/references/crypto-auth-module.md b/skills/cli-public/references/crypto-auth-module.md index 3b0b5f13f..7e5b9366d 100644 --- a/skills/cli-public/references/crypto-auth-module.md +++ b/skills/cli-public/references/crypto-auth-module.md @@ -9,7 +9,7 @@ CRUD operations for CryptoAuthModule records via csdk CLI ```bash csdk crypto-auth-module list csdk crypto-auth-module get --id -csdk crypto-auth-module create --databaseId --schemaId --usersTableId --secretsTableId --sessionsTableId --sessionCredentialsTableId --addressesTableId --userField --cryptoNetwork --signInRequestChallenge --signInRecordFailure --signUpWithKey --signInWithChallenge +csdk crypto-auth-module create --databaseId --userField [--schemaId ] [--usersTableId ] [--secretsTableId ] [--sessionsTableId ] [--sessionCredentialsTableId ] [--addressesTableId ] [--cryptoNetwork ] [--signInRequestChallenge ] [--signInRecordFailure ] [--signUpWithKey ] [--signInWithChallenge ] csdk crypto-auth-module update --id [--databaseId ] [--schemaId ] [--usersTableId ] [--secretsTableId ] [--sessionsTableId ] [--sessionCredentialsTableId ] [--addressesTableId ] [--userField ] [--cryptoNetwork ] [--signInRequestChallenge ] [--signInRecordFailure ] [--signUpWithKey ] [--signInWithChallenge ] csdk crypto-auth-module delete --id ``` @@ -25,7 +25,7 @@ csdk crypto-auth-module list ### Create a cryptoAuthModule ```bash -csdk crypto-auth-module create --databaseId "value" --schemaId "value" --usersTableId "value" --secretsTableId "value" --sessionsTableId "value" --sessionCredentialsTableId "value" --addressesTableId "value" --userField "value" --cryptoNetwork "value" --signInRequestChallenge "value" --signInRecordFailure "value" --signUpWithKey "value" --signInWithChallenge "value" +csdk crypto-auth-module create --databaseId --userField [--schemaId ] [--usersTableId ] [--secretsTableId ] [--sessionsTableId ] [--sessionCredentialsTableId ] [--addressesTableId ] [--cryptoNetwork ] [--signInRequestChallenge ] [--signInRecordFailure ] [--signUpWithKey ] [--signInWithChallenge ] ``` ### Get a cryptoAuthModule by id diff --git a/skills/cli-public/references/database-provision-module.md b/skills/cli-public/references/database-provision-module.md index cc89fdacd..a1e78a37e 100644 --- a/skills/cli-public/references/database-provision-module.md +++ b/skills/cli-public/references/database-provision-module.md @@ -9,7 +9,7 @@ CRUD operations for DatabaseProvisionModule records via csdk CLI ```bash csdk database-provision-module list csdk database-provision-module get --id -csdk database-provision-module create --databaseName --ownerId --subdomain --domain --modules --options --bootstrapUser --status --errorMessage --databaseId --completedAt +csdk database-provision-module create --databaseName --ownerId --domain [--subdomain ] [--modules ] [--options ] [--bootstrapUser ] [--status ] [--errorMessage ] [--databaseId ] [--completedAt ] csdk database-provision-module update --id [--databaseName ] [--ownerId ] [--subdomain ] [--domain ] [--modules ] [--options ] [--bootstrapUser ] [--status ] [--errorMessage ] [--databaseId ] [--completedAt ] csdk database-provision-module delete --id ``` @@ -25,7 +25,7 @@ csdk database-provision-module list ### Create a databaseProvisionModule ```bash -csdk database-provision-module create --databaseName "value" --ownerId "value" --subdomain "value" --domain "value" --modules "value" --options "value" --bootstrapUser "value" --status "value" --errorMessage "value" --databaseId "value" --completedAt "value" +csdk database-provision-module create --databaseName --ownerId --domain [--subdomain ] [--modules ] [--options ] [--bootstrapUser ] [--status ] [--errorMessage ] [--databaseId ] [--completedAt ] ``` ### Get a databaseProvisionModule by id diff --git a/skills/cli-public/references/database.md b/skills/cli-public/references/database.md index b4dfca269..7fafae1aa 100644 --- a/skills/cli-public/references/database.md +++ b/skills/cli-public/references/database.md @@ -9,7 +9,7 @@ CRUD operations for Database records via csdk CLI ```bash csdk database list csdk database get --id -csdk database create --ownerId --schemaHash --name --label --hash +csdk database create [--ownerId ] [--schemaHash ] [--name ] [--label ] [--hash ] csdk database update --id [--ownerId ] [--schemaHash ] [--name ] [--label ] [--hash ] csdk database delete --id ``` @@ -25,7 +25,7 @@ csdk database list ### Create a database ```bash -csdk database create --ownerId "value" --schemaHash "value" --name "value" --label "value" --hash "value" +csdk database create [--ownerId ] [--schemaHash ] [--name ] [--label ] [--hash ] ``` ### Get a database by id diff --git a/skills/cli-public/references/default-ids-module.md b/skills/cli-public/references/default-ids-module.md index 8a261023a..7e3b21cde 100644 --- a/skills/cli-public/references/default-ids-module.md +++ b/skills/cli-public/references/default-ids-module.md @@ -25,7 +25,7 @@ csdk default-ids-module list ### Create a defaultIdsModule ```bash -csdk default-ids-module create --databaseId "value" +csdk default-ids-module create --databaseId ``` ### Get a defaultIdsModule by id diff --git a/skills/cli-public/references/default-privilege.md b/skills/cli-public/references/default-privilege.md index 392d056bf..80c352ef6 100644 --- a/skills/cli-public/references/default-privilege.md +++ b/skills/cli-public/references/default-privilege.md @@ -9,7 +9,7 @@ CRUD operations for DefaultPrivilege records via csdk CLI ```bash csdk default-privilege list csdk default-privilege get --id -csdk default-privilege create --databaseId --schemaId --objectType --privilege --granteeName --isGrant +csdk default-privilege create --schemaId --objectType --privilege --granteeName [--databaseId ] [--isGrant ] csdk default-privilege update --id [--databaseId ] [--schemaId ] [--objectType ] [--privilege ] [--granteeName ] [--isGrant ] csdk default-privilege delete --id ``` @@ -25,7 +25,7 @@ csdk default-privilege list ### Create a defaultPrivilege ```bash -csdk default-privilege create --databaseId "value" --schemaId "value" --objectType "value" --privilege "value" --granteeName "value" --isGrant "value" +csdk default-privilege create --schemaId --objectType --privilege --granteeName [--databaseId ] [--isGrant ] ``` ### Get a defaultPrivilege by id diff --git a/skills/cli-public/references/denormalized-table-field.md b/skills/cli-public/references/denormalized-table-field.md index 30a32a496..e7b070d6a 100644 --- a/skills/cli-public/references/denormalized-table-field.md +++ b/skills/cli-public/references/denormalized-table-field.md @@ -9,7 +9,7 @@ CRUD operations for DenormalizedTableField records via csdk CLI ```bash csdk denormalized-table-field list csdk denormalized-table-field get --id -csdk denormalized-table-field create --databaseId --tableId --fieldId --setIds --refTableId --refFieldId --refIds --useUpdates --updateDefaults --funcName --funcOrder +csdk denormalized-table-field create --databaseId --tableId --fieldId --refTableId --refFieldId [--setIds ] [--refIds ] [--useUpdates ] [--updateDefaults ] [--funcName ] [--funcOrder ] csdk denormalized-table-field update --id [--databaseId ] [--tableId ] [--fieldId ] [--setIds ] [--refTableId ] [--refFieldId ] [--refIds ] [--useUpdates ] [--updateDefaults ] [--funcName ] [--funcOrder ] csdk denormalized-table-field delete --id ``` @@ -25,7 +25,7 @@ csdk denormalized-table-field list ### Create a denormalizedTableField ```bash -csdk denormalized-table-field create --databaseId "value" --tableId "value" --fieldId "value" --setIds "value" --refTableId "value" --refFieldId "value" --refIds "value" --useUpdates "value" --updateDefaults "value" --funcName "value" --funcOrder "value" +csdk denormalized-table-field create --databaseId --tableId --fieldId --refTableId --refFieldId [--setIds ] [--refIds ] [--useUpdates ] [--updateDefaults ] [--funcName ] [--funcOrder ] ``` ### Get a denormalizedTableField by id diff --git a/skills/cli-public/references/domain.md b/skills/cli-public/references/domain.md index 82492f89a..a9f060e5a 100644 --- a/skills/cli-public/references/domain.md +++ b/skills/cli-public/references/domain.md @@ -9,7 +9,7 @@ CRUD operations for Domain records via csdk CLI ```bash csdk domain list csdk domain get --id -csdk domain create --databaseId --apiId --siteId --subdomain --domain +csdk domain create --databaseId [--apiId ] [--siteId ] [--subdomain ] [--domain ] csdk domain update --id [--databaseId ] [--apiId ] [--siteId ] [--subdomain ] [--domain ] csdk domain delete --id ``` @@ -25,7 +25,7 @@ csdk domain list ### Create a domain ```bash -csdk domain create --databaseId "value" --apiId "value" --siteId "value" --subdomain "value" --domain "value" +csdk domain create --databaseId [--apiId ] [--siteId ] [--subdomain ] [--domain ] ``` ### Get a domain by id diff --git a/skills/cli-public/references/email.md b/skills/cli-public/references/email.md index 960928427..86bc34fdb 100644 --- a/skills/cli-public/references/email.md +++ b/skills/cli-public/references/email.md @@ -9,7 +9,7 @@ CRUD operations for Email records via csdk CLI ```bash csdk email list csdk email get --id -csdk email create --ownerId --email --isVerified --isPrimary +csdk email create --email [--ownerId ] [--isVerified ] [--isPrimary ] csdk email update --id [--ownerId ] [--email ] [--isVerified ] [--isPrimary ] csdk email delete --id ``` @@ -25,7 +25,7 @@ csdk email list ### Create a email ```bash -csdk email create --ownerId "value" --email "value" --isVerified "value" --isPrimary "value" +csdk email create --email [--ownerId ] [--isVerified ] [--isPrimary ] ``` ### Get a email by id diff --git a/skills/cli-public/references/emails-module.md b/skills/cli-public/references/emails-module.md index 1628d6c22..720ee4b9d 100644 --- a/skills/cli-public/references/emails-module.md +++ b/skills/cli-public/references/emails-module.md @@ -9,7 +9,7 @@ CRUD operations for EmailsModule records via csdk CLI ```bash csdk emails-module list csdk emails-module get --id -csdk emails-module create --databaseId --schemaId --privateSchemaId --tableId --ownerTableId --tableName +csdk emails-module create --databaseId --tableName [--schemaId ] [--privateSchemaId ] [--tableId ] [--ownerTableId ] csdk emails-module update --id [--databaseId ] [--schemaId ] [--privateSchemaId ] [--tableId ] [--ownerTableId ] [--tableName ] csdk emails-module delete --id ``` @@ -25,7 +25,7 @@ csdk emails-module list ### Create a emailsModule ```bash -csdk emails-module create --databaseId "value" --schemaId "value" --privateSchemaId "value" --tableId "value" --ownerTableId "value" --tableName "value" +csdk emails-module create --databaseId --tableName [--schemaId ] [--privateSchemaId ] [--tableId ] [--ownerTableId ] ``` ### Get a emailsModule by id diff --git a/skills/cli-public/references/encrypted-secrets-module.md b/skills/cli-public/references/encrypted-secrets-module.md index 5e88b42cb..0d11093b2 100644 --- a/skills/cli-public/references/encrypted-secrets-module.md +++ b/skills/cli-public/references/encrypted-secrets-module.md @@ -9,7 +9,7 @@ CRUD operations for EncryptedSecretsModule records via csdk CLI ```bash csdk encrypted-secrets-module list csdk encrypted-secrets-module get --id -csdk encrypted-secrets-module create --databaseId --schemaId --tableId --tableName +csdk encrypted-secrets-module create --databaseId [--schemaId ] [--tableId ] [--tableName ] csdk encrypted-secrets-module update --id [--databaseId ] [--schemaId ] [--tableId ] [--tableName ] csdk encrypted-secrets-module delete --id ``` @@ -25,7 +25,7 @@ csdk encrypted-secrets-module list ### Create a encryptedSecretsModule ```bash -csdk encrypted-secrets-module create --databaseId "value" --schemaId "value" --tableId "value" --tableName "value" +csdk encrypted-secrets-module create --databaseId [--schemaId ] [--tableId ] [--tableName ] ``` ### Get a encryptedSecretsModule by id diff --git a/skills/cli-public/references/extend-token-expires.md b/skills/cli-public/references/extend-token-expires.md index e49a37fd4..a65d0c4be 100644 --- a/skills/cli-public/references/extend-token-expires.md +++ b/skills/cli-public/references/extend-token-expires.md @@ -7,7 +7,7 @@ Execute the extendTokenExpires mutation ## Usage ```bash -csdk extend-token-expires --input +csdk extend-token-expires --input.clientMutationId --input.amount ``` ## Examples @@ -15,5 +15,5 @@ csdk extend-token-expires --input ### Run extendTokenExpires ```bash -csdk extend-token-expires --input +csdk extend-token-expires --input.clientMutationId --input.amount ``` diff --git a/skills/cli-public/references/field-module.md b/skills/cli-public/references/field-module.md index 6225943e8..bcfbb01d7 100644 --- a/skills/cli-public/references/field-module.md +++ b/skills/cli-public/references/field-module.md @@ -9,7 +9,7 @@ CRUD operations for FieldModule records via csdk CLI ```bash csdk field-module list csdk field-module get --id -csdk field-module create --databaseId --privateSchemaId --tableId --fieldId --nodeType --data --triggers --functions +csdk field-module create --databaseId --nodeType [--privateSchemaId ] [--tableId ] [--fieldId ] [--data ] [--triggers ] [--functions ] csdk field-module update --id [--databaseId ] [--privateSchemaId ] [--tableId ] [--fieldId ] [--nodeType ] [--data ] [--triggers ] [--functions ] csdk field-module delete --id ``` @@ -25,7 +25,7 @@ csdk field-module list ### Create a fieldModule ```bash -csdk field-module create --databaseId "value" --privateSchemaId "value" --tableId "value" --fieldId "value" --nodeType "value" --data "value" --triggers "value" --functions "value" +csdk field-module create --databaseId --nodeType [--privateSchemaId ] [--tableId ] [--fieldId ] [--data ] [--triggers ] [--functions ] ``` ### Get a fieldModule by id diff --git a/skills/cli-public/references/field.md b/skills/cli-public/references/field.md index 7eaf01b9d..67756b5d2 100644 --- a/skills/cli-public/references/field.md +++ b/skills/cli-public/references/field.md @@ -9,7 +9,7 @@ CRUD operations for Field records via csdk CLI ```bash csdk field list csdk field get --id -csdk field create --databaseId --tableId --name --label --description --smartTags --isRequired --defaultValue --defaultValueAst --isHidden --type --fieldOrder --regexp --chk --chkExpr --min --max --tags --category --module --scope +csdk field create --tableId --name --type [--databaseId ] [--label ] [--description ] [--smartTags ] [--isRequired ] [--defaultValue ] [--defaultValueAst ] [--isHidden ] [--fieldOrder ] [--regexp ] [--chk ] [--chkExpr ] [--min ] [--max ] [--tags ] [--category ] [--module ] [--scope ] csdk field update --id [--databaseId ] [--tableId ] [--name ] [--label ] [--description ] [--smartTags ] [--isRequired ] [--defaultValue ] [--defaultValueAst ] [--isHidden ] [--type ] [--fieldOrder ] [--regexp ] [--chk ] [--chkExpr ] [--min ] [--max ] [--tags ] [--category ] [--module ] [--scope ] csdk field delete --id ``` @@ -25,7 +25,7 @@ csdk field list ### Create a field ```bash -csdk field create --databaseId "value" --tableId "value" --name "value" --label "value" --description "value" --smartTags "value" --isRequired "value" --defaultValue "value" --defaultValueAst "value" --isHidden "value" --type "value" --fieldOrder "value" --regexp "value" --chk "value" --chkExpr "value" --min "value" --max "value" --tags "value" --category "value" --module "value" --scope "value" +csdk field create --tableId --name --type [--databaseId ] [--label ] [--description ] [--smartTags ] [--isRequired ] [--defaultValue ] [--defaultValueAst ] [--isHidden ] [--fieldOrder ] [--regexp ] [--chk ] [--chkExpr ] [--min ] [--max ] [--tags ] [--category ] [--module ] [--scope ] ``` ### Get a field by id diff --git a/skills/cli-public/references/foreign-key-constraint.md b/skills/cli-public/references/foreign-key-constraint.md index 443c8b7e8..6a54666d7 100644 --- a/skills/cli-public/references/foreign-key-constraint.md +++ b/skills/cli-public/references/foreign-key-constraint.md @@ -9,7 +9,7 @@ CRUD operations for ForeignKeyConstraint records via csdk CLI ```bash csdk foreign-key-constraint list csdk foreign-key-constraint get --id -csdk foreign-key-constraint create --databaseId --tableId --name --description --smartTags --type --fieldIds --refTableId --refFieldIds --deleteAction --updateAction --category --module --scope --tags +csdk foreign-key-constraint create --tableId --fieldIds --refTableId --refFieldIds [--databaseId ] [--name ] [--description ] [--smartTags ] [--type ] [--deleteAction ] [--updateAction ] [--category ] [--module ] [--scope ] [--tags ] csdk foreign-key-constraint update --id [--databaseId ] [--tableId ] [--name ] [--description ] [--smartTags ] [--type ] [--fieldIds ] [--refTableId ] [--refFieldIds ] [--deleteAction ] [--updateAction ] [--category ] [--module ] [--scope ] [--tags ] csdk foreign-key-constraint delete --id ``` @@ -25,7 +25,7 @@ csdk foreign-key-constraint list ### Create a foreignKeyConstraint ```bash -csdk foreign-key-constraint create --databaseId "value" --tableId "value" --name "value" --description "value" --smartTags "value" --type "value" --fieldIds "value" --refTableId "value" --refFieldIds "value" --deleteAction "value" --updateAction "value" --category "value" --module "value" --scope "value" --tags "value" +csdk foreign-key-constraint create --tableId --fieldIds --refTableId --refFieldIds [--databaseId ] [--name ] [--description ] [--smartTags ] [--type ] [--deleteAction ] [--updateAction ] [--category ] [--module ] [--scope ] [--tags ] ``` ### Get a foreignKeyConstraint by id diff --git a/skills/cli-public/references/forgot-password.md b/skills/cli-public/references/forgot-password.md index a3d51ab48..6d566389c 100644 --- a/skills/cli-public/references/forgot-password.md +++ b/skills/cli-public/references/forgot-password.md @@ -7,7 +7,7 @@ Execute the forgotPassword mutation ## Usage ```bash -csdk forgot-password --input +csdk forgot-password --input.clientMutationId --input.email ``` ## Examples @@ -15,5 +15,5 @@ csdk forgot-password --input ### Run forgotPassword ```bash -csdk forgot-password --input +csdk forgot-password --input.clientMutationId --input.email ``` diff --git a/skills/cli-public/references/freeze-objects.md b/skills/cli-public/references/freeze-objects.md index ccbe73bc5..d7d659aed 100644 --- a/skills/cli-public/references/freeze-objects.md +++ b/skills/cli-public/references/freeze-objects.md @@ -7,7 +7,7 @@ Execute the freezeObjects mutation ## Usage ```bash -csdk freeze-objects --input +csdk freeze-objects --input.clientMutationId --input.databaseId --input.id ``` ## Examples @@ -15,5 +15,5 @@ csdk freeze-objects --input ### Run freezeObjects ```bash -csdk freeze-objects --input +csdk freeze-objects --input.clientMutationId --input.databaseId --input.id ``` diff --git a/skills/cli-public/references/full-text-search.md b/skills/cli-public/references/full-text-search.md index 72aeb0a9e..0b7a1afb8 100644 --- a/skills/cli-public/references/full-text-search.md +++ b/skills/cli-public/references/full-text-search.md @@ -9,7 +9,7 @@ CRUD operations for FullTextSearch records via csdk CLI ```bash csdk full-text-search list csdk full-text-search get --id -csdk full-text-search create --databaseId --tableId --fieldId --fieldIds --weights --langs +csdk full-text-search create --tableId --fieldId --fieldIds --weights --langs [--databaseId ] csdk full-text-search update --id [--databaseId ] [--tableId ] [--fieldId ] [--fieldIds ] [--weights ] [--langs ] csdk full-text-search delete --id ``` @@ -25,7 +25,7 @@ csdk full-text-search list ### Create a fullTextSearch ```bash -csdk full-text-search create --databaseId "value" --tableId "value" --fieldId "value" --fieldIds "value" --weights "value" --langs "value" +csdk full-text-search create --tableId --fieldId --fieldIds --weights --langs [--databaseId ] ``` ### Get a fullTextSearch by id diff --git a/skills/cli-public/references/get-all-record.md b/skills/cli-public/references/get-all-record.md index b52c0b95c..18e738512 100644 --- a/skills/cli-public/references/get-all-record.md +++ b/skills/cli-public/references/get-all-record.md @@ -25,7 +25,7 @@ csdk get-all-record list ### Create a getAllRecord ```bash -csdk get-all-record create --path "value" --data "value" +csdk get-all-record create --path --data ``` ### Get a getAllRecord by id diff --git a/skills/cli-public/references/hierarchy-module.md b/skills/cli-public/references/hierarchy-module.md index 49df227c5..3a9c94651 100644 --- a/skills/cli-public/references/hierarchy-module.md +++ b/skills/cli-public/references/hierarchy-module.md @@ -9,7 +9,7 @@ CRUD operations for HierarchyModule records via csdk CLI ```bash csdk hierarchy-module list csdk hierarchy-module get --id -csdk hierarchy-module create --databaseId --schemaId --privateSchemaId --chartEdgesTableId --chartEdgesTableName --hierarchySprtTableId --hierarchySprtTableName --chartEdgeGrantsTableId --chartEdgeGrantsTableName --entityTableId --usersTableId --prefix --privateSchemaName --sprtTableName --rebuildHierarchyFunction --getSubordinatesFunction --getManagersFunction --isManagerOfFunction +csdk hierarchy-module create --databaseId --entityTableId --usersTableId [--schemaId ] [--privateSchemaId ] [--chartEdgesTableId ] [--chartEdgesTableName ] [--hierarchySprtTableId ] [--hierarchySprtTableName ] [--chartEdgeGrantsTableId ] [--chartEdgeGrantsTableName ] [--prefix ] [--privateSchemaName ] [--sprtTableName ] [--rebuildHierarchyFunction ] [--getSubordinatesFunction ] [--getManagersFunction ] [--isManagerOfFunction ] csdk hierarchy-module update --id [--databaseId ] [--schemaId ] [--privateSchemaId ] [--chartEdgesTableId ] [--chartEdgesTableName ] [--hierarchySprtTableId ] [--hierarchySprtTableName ] [--chartEdgeGrantsTableId ] [--chartEdgeGrantsTableName ] [--entityTableId ] [--usersTableId ] [--prefix ] [--privateSchemaName ] [--sprtTableName ] [--rebuildHierarchyFunction ] [--getSubordinatesFunction ] [--getManagersFunction ] [--isManagerOfFunction ] csdk hierarchy-module delete --id ``` @@ -25,7 +25,7 @@ csdk hierarchy-module list ### Create a hierarchyModule ```bash -csdk hierarchy-module create --databaseId "value" --schemaId "value" --privateSchemaId "value" --chartEdgesTableId "value" --chartEdgesTableName "value" --hierarchySprtTableId "value" --hierarchySprtTableName "value" --chartEdgeGrantsTableId "value" --chartEdgeGrantsTableName "value" --entityTableId "value" --usersTableId "value" --prefix "value" --privateSchemaName "value" --sprtTableName "value" --rebuildHierarchyFunction "value" --getSubordinatesFunction "value" --getManagersFunction "value" --isManagerOfFunction "value" +csdk hierarchy-module create --databaseId --entityTableId --usersTableId [--schemaId ] [--privateSchemaId ] [--chartEdgesTableId ] [--chartEdgesTableName ] [--hierarchySprtTableId ] [--hierarchySprtTableName ] [--chartEdgeGrantsTableId ] [--chartEdgeGrantsTableName ] [--prefix ] [--privateSchemaName ] [--sprtTableName ] [--rebuildHierarchyFunction ] [--getSubordinatesFunction ] [--getManagersFunction ] [--isManagerOfFunction ] ``` ### Get a hierarchyModule by id diff --git a/skills/cli-public/references/index.md b/skills/cli-public/references/index.md index b51921553..0f27f35fc 100644 --- a/skills/cli-public/references/index.md +++ b/skills/cli-public/references/index.md @@ -9,7 +9,7 @@ CRUD operations for Index records via csdk CLI ```bash csdk index list csdk index get --id -csdk index create --databaseId --tableId --name --fieldIds --includeFieldIds --accessMethod --indexParams --whereClause --isUnique --smartTags --category --module --scope --tags +csdk index create --databaseId --tableId [--name ] [--fieldIds ] [--includeFieldIds ] [--accessMethod ] [--indexParams ] [--whereClause ] [--isUnique ] [--smartTags ] [--category ] [--module ] [--scope ] [--tags ] csdk index update --id [--databaseId ] [--tableId ] [--name ] [--fieldIds ] [--includeFieldIds ] [--accessMethod ] [--indexParams ] [--whereClause ] [--isUnique ] [--smartTags ] [--category ] [--module ] [--scope ] [--tags ] csdk index delete --id ``` @@ -25,7 +25,7 @@ csdk index list ### Create a index ```bash -csdk index create --databaseId "value" --tableId "value" --name "value" --fieldIds "value" --includeFieldIds "value" --accessMethod "value" --indexParams "value" --whereClause "value" --isUnique "value" --smartTags "value" --category "value" --module "value" --scope "value" --tags "value" +csdk index create --databaseId --tableId [--name ] [--fieldIds ] [--includeFieldIds ] [--accessMethod ] [--indexParams ] [--whereClause ] [--isUnique ] [--smartTags ] [--category ] [--module ] [--scope ] [--tags ] ``` ### Get a index by id diff --git a/skills/cli-public/references/init-empty-repo.md b/skills/cli-public/references/init-empty-repo.md index 06fc74e9e..dfac16a2c 100644 --- a/skills/cli-public/references/init-empty-repo.md +++ b/skills/cli-public/references/init-empty-repo.md @@ -7,7 +7,7 @@ Execute the initEmptyRepo mutation ## Usage ```bash -csdk init-empty-repo --input +csdk init-empty-repo --input.clientMutationId --input.dbId --input.storeId ``` ## Examples @@ -15,5 +15,5 @@ csdk init-empty-repo --input ### Run initEmptyRepo ```bash -csdk init-empty-repo --input +csdk init-empty-repo --input.clientMutationId --input.dbId --input.storeId ``` diff --git a/skills/cli-public/references/insert-node-at-path.md b/skills/cli-public/references/insert-node-at-path.md index 7af725e74..4a95b904d 100644 --- a/skills/cli-public/references/insert-node-at-path.md +++ b/skills/cli-public/references/insert-node-at-path.md @@ -7,7 +7,7 @@ Execute the insertNodeAtPath mutation ## Usage ```bash -csdk insert-node-at-path --input +csdk insert-node-at-path --input.clientMutationId --input.dbId --input.root --input.path --input.data --input.kids --input.ktree ``` ## Examples @@ -15,5 +15,5 @@ csdk insert-node-at-path --input ### Run insertNodeAtPath ```bash -csdk insert-node-at-path --input +csdk insert-node-at-path --input.clientMutationId --input.dbId --input.root --input.path --input.data --input.kids --input.ktree ``` diff --git a/skills/cli-public/references/invite.md b/skills/cli-public/references/invite.md index b415cfafe..5b837cd1a 100644 --- a/skills/cli-public/references/invite.md +++ b/skills/cli-public/references/invite.md @@ -9,7 +9,7 @@ CRUD operations for Invite records via csdk CLI ```bash csdk invite list csdk invite get --id -csdk invite create --email --senderId --inviteToken --inviteValid --inviteLimit --inviteCount --multiple --data --expiresAt +csdk invite create [--email ] [--senderId ] [--inviteToken ] [--inviteValid ] [--inviteLimit ] [--inviteCount ] [--multiple ] [--data ] [--expiresAt ] csdk invite update --id [--email ] [--senderId ] [--inviteToken ] [--inviteValid ] [--inviteLimit ] [--inviteCount ] [--multiple ] [--data ] [--expiresAt ] csdk invite delete --id ``` @@ -25,7 +25,7 @@ csdk invite list ### Create a invite ```bash -csdk invite create --email "value" --senderId "value" --inviteToken "value" --inviteValid "value" --inviteLimit "value" --inviteCount "value" --multiple "value" --data "value" --expiresAt "value" +csdk invite create [--email ] [--senderId ] [--inviteToken ] [--inviteValid ] [--inviteLimit ] [--inviteCount ] [--multiple ] [--data ] [--expiresAt ] ``` ### Get a invite by id diff --git a/skills/cli-public/references/invites-module.md b/skills/cli-public/references/invites-module.md index 7c4f53146..12aec3b8b 100644 --- a/skills/cli-public/references/invites-module.md +++ b/skills/cli-public/references/invites-module.md @@ -9,7 +9,7 @@ CRUD operations for InvitesModule records via csdk CLI ```bash csdk invites-module list csdk invites-module get --id -csdk invites-module create --databaseId --schemaId --privateSchemaId --emailsTableId --usersTableId --invitesTableId --claimedInvitesTableId --invitesTableName --claimedInvitesTableName --submitInviteCodeFunction --prefix --membershipType --entityTableId +csdk invites-module create --databaseId --membershipType [--schemaId ] [--privateSchemaId ] [--emailsTableId ] [--usersTableId ] [--invitesTableId ] [--claimedInvitesTableId ] [--invitesTableName ] [--claimedInvitesTableName ] [--submitInviteCodeFunction ] [--prefix ] [--entityTableId ] csdk invites-module update --id [--databaseId ] [--schemaId ] [--privateSchemaId ] [--emailsTableId ] [--usersTableId ] [--invitesTableId ] [--claimedInvitesTableId ] [--invitesTableName ] [--claimedInvitesTableName ] [--submitInviteCodeFunction ] [--prefix ] [--membershipType ] [--entityTableId ] csdk invites-module delete --id ``` @@ -25,7 +25,7 @@ csdk invites-module list ### Create a invitesModule ```bash -csdk invites-module create --databaseId "value" --schemaId "value" --privateSchemaId "value" --emailsTableId "value" --usersTableId "value" --invitesTableId "value" --claimedInvitesTableId "value" --invitesTableName "value" --claimedInvitesTableName "value" --submitInviteCodeFunction "value" --prefix "value" --membershipType "value" --entityTableId "value" +csdk invites-module create --databaseId --membershipType [--schemaId ] [--privateSchemaId ] [--emailsTableId ] [--usersTableId ] [--invitesTableId ] [--claimedInvitesTableId ] [--invitesTableName ] [--claimedInvitesTableName ] [--submitInviteCodeFunction ] [--prefix ] [--entityTableId ] ``` ### Get a invitesModule by id diff --git a/skills/cli-public/references/levels-module.md b/skills/cli-public/references/levels-module.md index 6e058c30d..a0d430873 100644 --- a/skills/cli-public/references/levels-module.md +++ b/skills/cli-public/references/levels-module.md @@ -9,7 +9,7 @@ CRUD operations for LevelsModule records via csdk CLI ```bash csdk levels-module list csdk levels-module get --id -csdk levels-module create --databaseId --schemaId --privateSchemaId --stepsTableId --stepsTableName --achievementsTableId --achievementsTableName --levelsTableId --levelsTableName --levelRequirementsTableId --levelRequirementsTableName --completedStep --incompletedStep --tgAchievement --tgAchievementToggle --tgAchievementToggleBoolean --tgAchievementBoolean --upsertAchievement --tgUpdateAchievements --stepsRequired --levelAchieved --prefix --membershipType --entityTableId --actorTableId +csdk levels-module create --databaseId --membershipType [--schemaId ] [--privateSchemaId ] [--stepsTableId ] [--stepsTableName ] [--achievementsTableId ] [--achievementsTableName ] [--levelsTableId ] [--levelsTableName ] [--levelRequirementsTableId ] [--levelRequirementsTableName ] [--completedStep ] [--incompletedStep ] [--tgAchievement ] [--tgAchievementToggle ] [--tgAchievementToggleBoolean ] [--tgAchievementBoolean ] [--upsertAchievement ] [--tgUpdateAchievements ] [--stepsRequired ] [--levelAchieved ] [--prefix ] [--entityTableId ] [--actorTableId ] csdk levels-module update --id [--databaseId ] [--schemaId ] [--privateSchemaId ] [--stepsTableId ] [--stepsTableName ] [--achievementsTableId ] [--achievementsTableName ] [--levelsTableId ] [--levelsTableName ] [--levelRequirementsTableId ] [--levelRequirementsTableName ] [--completedStep ] [--incompletedStep ] [--tgAchievement ] [--tgAchievementToggle ] [--tgAchievementToggleBoolean ] [--tgAchievementBoolean ] [--upsertAchievement ] [--tgUpdateAchievements ] [--stepsRequired ] [--levelAchieved ] [--prefix ] [--membershipType ] [--entityTableId ] [--actorTableId ] csdk levels-module delete --id ``` @@ -25,7 +25,7 @@ csdk levels-module list ### Create a levelsModule ```bash -csdk levels-module create --databaseId "value" --schemaId "value" --privateSchemaId "value" --stepsTableId "value" --stepsTableName "value" --achievementsTableId "value" --achievementsTableName "value" --levelsTableId "value" --levelsTableName "value" --levelRequirementsTableId "value" --levelRequirementsTableName "value" --completedStep "value" --incompletedStep "value" --tgAchievement "value" --tgAchievementToggle "value" --tgAchievementToggleBoolean "value" --tgAchievementBoolean "value" --upsertAchievement "value" --tgUpdateAchievements "value" --stepsRequired "value" --levelAchieved "value" --prefix "value" --membershipType "value" --entityTableId "value" --actorTableId "value" +csdk levels-module create --databaseId --membershipType [--schemaId ] [--privateSchemaId ] [--stepsTableId ] [--stepsTableName ] [--achievementsTableId ] [--achievementsTableName ] [--levelsTableId ] [--levelsTableName ] [--levelRequirementsTableId ] [--levelRequirementsTableName ] [--completedStep ] [--incompletedStep ] [--tgAchievement ] [--tgAchievementToggle ] [--tgAchievementToggleBoolean ] [--tgAchievementBoolean ] [--upsertAchievement ] [--tgUpdateAchievements ] [--stepsRequired ] [--levelAchieved ] [--prefix ] [--entityTableId ] [--actorTableId ] ``` ### Get a levelsModule by id diff --git a/skills/cli-public/references/limits-module.md b/skills/cli-public/references/limits-module.md index f76a2582c..7b684787a 100644 --- a/skills/cli-public/references/limits-module.md +++ b/skills/cli-public/references/limits-module.md @@ -9,7 +9,7 @@ CRUD operations for LimitsModule records via csdk CLI ```bash csdk limits-module list csdk limits-module get --id -csdk limits-module create --databaseId --schemaId --privateSchemaId --tableId --tableName --defaultTableId --defaultTableName --limitIncrementFunction --limitDecrementFunction --limitIncrementTrigger --limitDecrementTrigger --limitUpdateTrigger --limitCheckFunction --prefix --membershipType --entityTableId --actorTableId +csdk limits-module create --databaseId --membershipType [--schemaId ] [--privateSchemaId ] [--tableId ] [--tableName ] [--defaultTableId ] [--defaultTableName ] [--limitIncrementFunction ] [--limitDecrementFunction ] [--limitIncrementTrigger ] [--limitDecrementTrigger ] [--limitUpdateTrigger ] [--limitCheckFunction ] [--prefix ] [--entityTableId ] [--actorTableId ] csdk limits-module update --id [--databaseId ] [--schemaId ] [--privateSchemaId ] [--tableId ] [--tableName ] [--defaultTableId ] [--defaultTableName ] [--limitIncrementFunction ] [--limitDecrementFunction ] [--limitIncrementTrigger ] [--limitDecrementTrigger ] [--limitUpdateTrigger ] [--limitCheckFunction ] [--prefix ] [--membershipType ] [--entityTableId ] [--actorTableId ] csdk limits-module delete --id ``` @@ -25,7 +25,7 @@ csdk limits-module list ### Create a limitsModule ```bash -csdk limits-module create --databaseId "value" --schemaId "value" --privateSchemaId "value" --tableId "value" --tableName "value" --defaultTableId "value" --defaultTableName "value" --limitIncrementFunction "value" --limitDecrementFunction "value" --limitIncrementTrigger "value" --limitDecrementTrigger "value" --limitUpdateTrigger "value" --limitCheckFunction "value" --prefix "value" --membershipType "value" --entityTableId "value" --actorTableId "value" +csdk limits-module create --databaseId --membershipType [--schemaId ] [--privateSchemaId ] [--tableId ] [--tableName ] [--defaultTableId ] [--defaultTableName ] [--limitIncrementFunction ] [--limitDecrementFunction ] [--limitIncrementTrigger ] [--limitDecrementTrigger ] [--limitUpdateTrigger ] [--limitCheckFunction ] [--prefix ] [--entityTableId ] [--actorTableId ] ``` ### Get a limitsModule by id diff --git a/skills/cli-public/references/membership-type.md b/skills/cli-public/references/membership-type.md index 57d8204cc..4ef886048 100644 --- a/skills/cli-public/references/membership-type.md +++ b/skills/cli-public/references/membership-type.md @@ -25,7 +25,7 @@ csdk membership-type list ### Create a membershipType ```bash -csdk membership-type create --name "value" --description "value" --prefix "value" +csdk membership-type create --name --description --prefix ``` ### Get a membershipType by id diff --git a/skills/cli-public/references/membership-types-module.md b/skills/cli-public/references/membership-types-module.md index 1841ac648..44d01b857 100644 --- a/skills/cli-public/references/membership-types-module.md +++ b/skills/cli-public/references/membership-types-module.md @@ -9,7 +9,7 @@ CRUD operations for MembershipTypesModule records via csdk CLI ```bash csdk membership-types-module list csdk membership-types-module get --id -csdk membership-types-module create --databaseId --schemaId --tableId --tableName +csdk membership-types-module create --databaseId [--schemaId ] [--tableId ] [--tableName ] csdk membership-types-module update --id [--databaseId ] [--schemaId ] [--tableId ] [--tableName ] csdk membership-types-module delete --id ``` @@ -25,7 +25,7 @@ csdk membership-types-module list ### Create a membershipTypesModule ```bash -csdk membership-types-module create --databaseId "value" --schemaId "value" --tableId "value" --tableName "value" +csdk membership-types-module create --databaseId [--schemaId ] [--tableId ] [--tableName ] ``` ### Get a membershipTypesModule by id diff --git a/skills/cli-public/references/memberships-module.md b/skills/cli-public/references/memberships-module.md index e1ad63cdf..762b93f18 100644 --- a/skills/cli-public/references/memberships-module.md +++ b/skills/cli-public/references/memberships-module.md @@ -9,7 +9,7 @@ CRUD operations for MembershipsModule records via csdk CLI ```bash csdk memberships-module list csdk memberships-module get --id -csdk memberships-module create --databaseId --schemaId --privateSchemaId --membershipsTableId --membershipsTableName --membersTableId --membersTableName --membershipDefaultsTableId --membershipDefaultsTableName --grantsTableId --grantsTableName --actorTableId --limitsTableId --defaultLimitsTableId --permissionsTableId --defaultPermissionsTableId --sprtTableId --adminGrantsTableId --adminGrantsTableName --ownerGrantsTableId --ownerGrantsTableName --membershipType --entityTableId --entityTableOwnerId --prefix --actorMaskCheck --actorPermCheck --entityIdsByMask --entityIdsByPerm --entityIdsFunction +csdk memberships-module create --databaseId --membershipType [--schemaId ] [--privateSchemaId ] [--membershipsTableId ] [--membershipsTableName ] [--membersTableId ] [--membersTableName ] [--membershipDefaultsTableId ] [--membershipDefaultsTableName ] [--grantsTableId ] [--grantsTableName ] [--actorTableId ] [--limitsTableId ] [--defaultLimitsTableId ] [--permissionsTableId ] [--defaultPermissionsTableId ] [--sprtTableId ] [--adminGrantsTableId ] [--adminGrantsTableName ] [--ownerGrantsTableId ] [--ownerGrantsTableName ] [--entityTableId ] [--entityTableOwnerId ] [--prefix ] [--actorMaskCheck ] [--actorPermCheck ] [--entityIdsByMask ] [--entityIdsByPerm ] [--entityIdsFunction ] csdk memberships-module update --id [--databaseId ] [--schemaId ] [--privateSchemaId ] [--membershipsTableId ] [--membershipsTableName ] [--membersTableId ] [--membersTableName ] [--membershipDefaultsTableId ] [--membershipDefaultsTableName ] [--grantsTableId ] [--grantsTableName ] [--actorTableId ] [--limitsTableId ] [--defaultLimitsTableId ] [--permissionsTableId ] [--defaultPermissionsTableId ] [--sprtTableId ] [--adminGrantsTableId ] [--adminGrantsTableName ] [--ownerGrantsTableId ] [--ownerGrantsTableName ] [--membershipType ] [--entityTableId ] [--entityTableOwnerId ] [--prefix ] [--actorMaskCheck ] [--actorPermCheck ] [--entityIdsByMask ] [--entityIdsByPerm ] [--entityIdsFunction ] csdk memberships-module delete --id ``` @@ -25,7 +25,7 @@ csdk memberships-module list ### Create a membershipsModule ```bash -csdk memberships-module create --databaseId "value" --schemaId "value" --privateSchemaId "value" --membershipsTableId "value" --membershipsTableName "value" --membersTableId "value" --membersTableName "value" --membershipDefaultsTableId "value" --membershipDefaultsTableName "value" --grantsTableId "value" --grantsTableName "value" --actorTableId "value" --limitsTableId "value" --defaultLimitsTableId "value" --permissionsTableId "value" --defaultPermissionsTableId "value" --sprtTableId "value" --adminGrantsTableId "value" --adminGrantsTableName "value" --ownerGrantsTableId "value" --ownerGrantsTableName "value" --membershipType "value" --entityTableId "value" --entityTableOwnerId "value" --prefix "value" --actorMaskCheck "value" --actorPermCheck "value" --entityIdsByMask "value" --entityIdsByPerm "value" --entityIdsFunction "value" +csdk memberships-module create --databaseId --membershipType [--schemaId ] [--privateSchemaId ] [--membershipsTableId ] [--membershipsTableName ] [--membersTableId ] [--membersTableName ] [--membershipDefaultsTableId ] [--membershipDefaultsTableName ] [--grantsTableId ] [--grantsTableName ] [--actorTableId ] [--limitsTableId ] [--defaultLimitsTableId ] [--permissionsTableId ] [--defaultPermissionsTableId ] [--sprtTableId ] [--adminGrantsTableId ] [--adminGrantsTableName ] [--ownerGrantsTableId ] [--ownerGrantsTableName ] [--entityTableId ] [--entityTableOwnerId ] [--prefix ] [--actorMaskCheck ] [--actorPermCheck ] [--entityIdsByMask ] [--entityIdsByPerm ] [--entityIdsFunction ] ``` ### Get a membershipsModule by id diff --git a/skills/cli-public/references/node-type-registry.md b/skills/cli-public/references/node-type-registry.md index be71d263c..077fa13b9 100644 --- a/skills/cli-public/references/node-type-registry.md +++ b/skills/cli-public/references/node-type-registry.md @@ -9,7 +9,7 @@ CRUD operations for NodeTypeRegistry records via csdk CLI ```bash csdk node-type-registry list csdk node-type-registry get --name -csdk node-type-registry create --slug --category --displayName --description --parameterSchema --tags +csdk node-type-registry create --slug --category [--displayName ] [--description ] [--parameterSchema ] [--tags ] csdk node-type-registry update --name [--slug ] [--category ] [--displayName ] [--description ] [--parameterSchema ] [--tags ] csdk node-type-registry delete --name ``` @@ -25,7 +25,7 @@ csdk node-type-registry list ### Create a nodeTypeRegistry ```bash -csdk node-type-registry create --slug "value" --category "value" --displayName "value" --description "value" --parameterSchema "value" --tags "value" +csdk node-type-registry create --slug --category [--displayName ] [--description ] [--parameterSchema ] [--tags ] ``` ### Get a nodeTypeRegistry by name diff --git a/skills/cli-public/references/object.md b/skills/cli-public/references/object.md index 2c6ad2c83..a49ba8ef6 100644 --- a/skills/cli-public/references/object.md +++ b/skills/cli-public/references/object.md @@ -9,7 +9,7 @@ CRUD operations for Object records via csdk CLI ```bash csdk object list csdk object get --id -csdk object create --hashUuid --databaseId --kids --ktree --data --frzn +csdk object create --hashUuid --databaseId [--kids ] [--ktree ] [--data ] [--frzn ] csdk object update --id [--hashUuid ] [--databaseId ] [--kids ] [--ktree ] [--data ] [--frzn ] csdk object delete --id ``` @@ -25,7 +25,7 @@ csdk object list ### Create a object ```bash -csdk object create --hashUuid "value" --databaseId "value" --kids "value" --ktree "value" --data "value" --frzn "value" +csdk object create --hashUuid --databaseId [--kids ] [--ktree ] [--data ] [--frzn ] ``` ### Get a object by id diff --git a/skills/cli-public/references/one-time-token.md b/skills/cli-public/references/one-time-token.md index 870b071c6..5649f5c11 100644 --- a/skills/cli-public/references/one-time-token.md +++ b/skills/cli-public/references/one-time-token.md @@ -7,7 +7,7 @@ Execute the oneTimeToken mutation ## Usage ```bash -csdk one-time-token --input +csdk one-time-token --input.clientMutationId --input.email --input.password --input.origin --input.rememberMe ``` ## Examples @@ -15,5 +15,5 @@ csdk one-time-token --input ### Run oneTimeToken ```bash -csdk one-time-token --input +csdk one-time-token --input.clientMutationId --input.email --input.password --input.origin --input.rememberMe ``` diff --git a/skills/cli-public/references/org-admin-grant.md b/skills/cli-public/references/org-admin-grant.md index 27816639f..72f0f5fb5 100644 --- a/skills/cli-public/references/org-admin-grant.md +++ b/skills/cli-public/references/org-admin-grant.md @@ -9,7 +9,7 @@ CRUD operations for OrgAdminGrant records via csdk CLI ```bash csdk org-admin-grant list csdk org-admin-grant get --id -csdk org-admin-grant create --isGrant --actorId --entityId --grantorId +csdk org-admin-grant create --actorId --entityId [--isGrant ] [--grantorId ] csdk org-admin-grant update --id [--isGrant ] [--actorId ] [--entityId ] [--grantorId ] csdk org-admin-grant delete --id ``` @@ -25,7 +25,7 @@ csdk org-admin-grant list ### Create a orgAdminGrant ```bash -csdk org-admin-grant create --isGrant "value" --actorId "value" --entityId "value" --grantorId "value" +csdk org-admin-grant create --actorId --entityId [--isGrant ] [--grantorId ] ``` ### Get a orgAdminGrant by id diff --git a/skills/cli-public/references/org-chart-edge-grant.md b/skills/cli-public/references/org-chart-edge-grant.md index 08eaed6a9..62779ed5f 100644 --- a/skills/cli-public/references/org-chart-edge-grant.md +++ b/skills/cli-public/references/org-chart-edge-grant.md @@ -9,7 +9,7 @@ CRUD operations for OrgChartEdgeGrant records via csdk CLI ```bash csdk org-chart-edge-grant list csdk org-chart-edge-grant get --id -csdk org-chart-edge-grant create --entityId --childId --parentId --grantorId --isGrant --positionTitle --positionLevel +csdk org-chart-edge-grant create --entityId --childId --grantorId [--parentId ] [--isGrant ] [--positionTitle ] [--positionLevel ] csdk org-chart-edge-grant update --id [--entityId ] [--childId ] [--parentId ] [--grantorId ] [--isGrant ] [--positionTitle ] [--positionLevel ] csdk org-chart-edge-grant delete --id ``` @@ -25,7 +25,7 @@ csdk org-chart-edge-grant list ### Create a orgChartEdgeGrant ```bash -csdk org-chart-edge-grant create --entityId "value" --childId "value" --parentId "value" --grantorId "value" --isGrant "value" --positionTitle "value" --positionLevel "value" +csdk org-chart-edge-grant create --entityId --childId --grantorId [--parentId ] [--isGrant ] [--positionTitle ] [--positionLevel ] ``` ### Get a orgChartEdgeGrant by id diff --git a/skills/cli-public/references/org-chart-edge.md b/skills/cli-public/references/org-chart-edge.md index 048d899a5..5ead28ec2 100644 --- a/skills/cli-public/references/org-chart-edge.md +++ b/skills/cli-public/references/org-chart-edge.md @@ -9,7 +9,7 @@ CRUD operations for OrgChartEdge records via csdk CLI ```bash csdk org-chart-edge list csdk org-chart-edge get --id -csdk org-chart-edge create --entityId --childId --parentId --positionTitle --positionLevel +csdk org-chart-edge create --entityId --childId [--parentId ] [--positionTitle ] [--positionLevel ] csdk org-chart-edge update --id [--entityId ] [--childId ] [--parentId ] [--positionTitle ] [--positionLevel ] csdk org-chart-edge delete --id ``` @@ -25,7 +25,7 @@ csdk org-chart-edge list ### Create a orgChartEdge ```bash -csdk org-chart-edge create --entityId "value" --childId "value" --parentId "value" --positionTitle "value" --positionLevel "value" +csdk org-chart-edge create --entityId --childId [--parentId ] [--positionTitle ] [--positionLevel ] ``` ### Get a orgChartEdge by id diff --git a/skills/cli-public/references/org-claimed-invite.md b/skills/cli-public/references/org-claimed-invite.md index 4fa8c680a..e187202ee 100644 --- a/skills/cli-public/references/org-claimed-invite.md +++ b/skills/cli-public/references/org-claimed-invite.md @@ -9,7 +9,7 @@ CRUD operations for OrgClaimedInvite records via csdk CLI ```bash csdk org-claimed-invite list csdk org-claimed-invite get --id -csdk org-claimed-invite create --data --senderId --receiverId --entityId +csdk org-claimed-invite create --entityId [--data ] [--senderId ] [--receiverId ] csdk org-claimed-invite update --id [--data ] [--senderId ] [--receiverId ] [--entityId ] csdk org-claimed-invite delete --id ``` @@ -25,7 +25,7 @@ csdk org-claimed-invite list ### Create a orgClaimedInvite ```bash -csdk org-claimed-invite create --data "value" --senderId "value" --receiverId "value" --entityId "value" +csdk org-claimed-invite create --entityId [--data ] [--senderId ] [--receiverId ] ``` ### Get a orgClaimedInvite by id diff --git a/skills/cli-public/references/org-get-managers-record.md b/skills/cli-public/references/org-get-managers-record.md index ffc368c84..aaa46db48 100644 --- a/skills/cli-public/references/org-get-managers-record.md +++ b/skills/cli-public/references/org-get-managers-record.md @@ -25,7 +25,7 @@ csdk org-get-managers-record list ### Create a orgGetManagersRecord ```bash -csdk org-get-managers-record create --userId "value" --depth "value" +csdk org-get-managers-record create --userId --depth ``` ### Get a orgGetManagersRecord by id diff --git a/skills/cli-public/references/org-get-subordinates-record.md b/skills/cli-public/references/org-get-subordinates-record.md index f42ede9ff..4391288e9 100644 --- a/skills/cli-public/references/org-get-subordinates-record.md +++ b/skills/cli-public/references/org-get-subordinates-record.md @@ -25,7 +25,7 @@ csdk org-get-subordinates-record list ### Create a orgGetSubordinatesRecord ```bash -csdk org-get-subordinates-record create --userId "value" --depth "value" +csdk org-get-subordinates-record create --userId --depth ``` ### Get a orgGetSubordinatesRecord by id diff --git a/skills/cli-public/references/org-grant.md b/skills/cli-public/references/org-grant.md index 7162efc86..ef384b4c1 100644 --- a/skills/cli-public/references/org-grant.md +++ b/skills/cli-public/references/org-grant.md @@ -9,7 +9,7 @@ CRUD operations for OrgGrant records via csdk CLI ```bash csdk org-grant list csdk org-grant get --id -csdk org-grant create --permissions --isGrant --actorId --entityId --grantorId +csdk org-grant create --actorId --entityId [--permissions ] [--isGrant ] [--grantorId ] csdk org-grant update --id [--permissions ] [--isGrant ] [--actorId ] [--entityId ] [--grantorId ] csdk org-grant delete --id ``` @@ -25,7 +25,7 @@ csdk org-grant list ### Create a orgGrant ```bash -csdk org-grant create --permissions "value" --isGrant "value" --actorId "value" --entityId "value" --grantorId "value" +csdk org-grant create --actorId --entityId [--permissions ] [--isGrant ] [--grantorId ] ``` ### Get a orgGrant by id diff --git a/skills/cli-public/references/org-invite.md b/skills/cli-public/references/org-invite.md index 5042d0928..18554cef6 100644 --- a/skills/cli-public/references/org-invite.md +++ b/skills/cli-public/references/org-invite.md @@ -9,7 +9,7 @@ CRUD operations for OrgInvite records via csdk CLI ```bash csdk org-invite list csdk org-invite get --id -csdk org-invite create --email --senderId --receiverId --inviteToken --inviteValid --inviteLimit --inviteCount --multiple --data --expiresAt --entityId +csdk org-invite create --entityId [--email ] [--senderId ] [--receiverId ] [--inviteToken ] [--inviteValid ] [--inviteLimit ] [--inviteCount ] [--multiple ] [--data ] [--expiresAt ] csdk org-invite update --id [--email ] [--senderId ] [--receiverId ] [--inviteToken ] [--inviteValid ] [--inviteLimit ] [--inviteCount ] [--multiple ] [--data ] [--expiresAt ] [--entityId ] csdk org-invite delete --id ``` @@ -25,7 +25,7 @@ csdk org-invite list ### Create a orgInvite ```bash -csdk org-invite create --email "value" --senderId "value" --receiverId "value" --inviteToken "value" --inviteValid "value" --inviteLimit "value" --inviteCount "value" --multiple "value" --data "value" --expiresAt "value" --entityId "value" +csdk org-invite create --entityId [--email ] [--senderId ] [--receiverId ] [--inviteToken ] [--inviteValid ] [--inviteLimit ] [--inviteCount ] [--multiple ] [--data ] [--expiresAt ] ``` ### Get a orgInvite by id diff --git a/skills/cli-public/references/org-limit-default.md b/skills/cli-public/references/org-limit-default.md index 714d2bf2d..e8d91ae23 100644 --- a/skills/cli-public/references/org-limit-default.md +++ b/skills/cli-public/references/org-limit-default.md @@ -9,7 +9,7 @@ CRUD operations for OrgLimitDefault records via csdk CLI ```bash csdk org-limit-default list csdk org-limit-default get --id -csdk org-limit-default create --name --max +csdk org-limit-default create --name [--max ] csdk org-limit-default update --id [--name ] [--max ] csdk org-limit-default delete --id ``` @@ -25,7 +25,7 @@ csdk org-limit-default list ### Create a orgLimitDefault ```bash -csdk org-limit-default create --name "value" --max "value" +csdk org-limit-default create --name [--max ] ``` ### Get a orgLimitDefault by id diff --git a/skills/cli-public/references/org-limit.md b/skills/cli-public/references/org-limit.md index 00b123dc2..77229c233 100644 --- a/skills/cli-public/references/org-limit.md +++ b/skills/cli-public/references/org-limit.md @@ -9,7 +9,7 @@ CRUD operations for OrgLimit records via csdk CLI ```bash csdk org-limit list csdk org-limit get --id -csdk org-limit create --name --actorId --num --max --entityId +csdk org-limit create --actorId --entityId [--name ] [--num ] [--max ] csdk org-limit update --id [--name ] [--actorId ] [--num ] [--max ] [--entityId ] csdk org-limit delete --id ``` @@ -25,7 +25,7 @@ csdk org-limit list ### Create a orgLimit ```bash -csdk org-limit create --name "value" --actorId "value" --num "value" --max "value" --entityId "value" +csdk org-limit create --actorId --entityId [--name ] [--num ] [--max ] ``` ### Get a orgLimit by id diff --git a/skills/cli-public/references/org-member.md b/skills/cli-public/references/org-member.md index 52377f83c..e61869351 100644 --- a/skills/cli-public/references/org-member.md +++ b/skills/cli-public/references/org-member.md @@ -9,7 +9,7 @@ CRUD operations for OrgMember records via csdk CLI ```bash csdk org-member list csdk org-member get --id -csdk org-member create --isAdmin --actorId --entityId +csdk org-member create --actorId --entityId [--isAdmin ] csdk org-member update --id [--isAdmin ] [--actorId ] [--entityId ] csdk org-member delete --id ``` @@ -25,7 +25,7 @@ csdk org-member list ### Create a orgMember ```bash -csdk org-member create --isAdmin "value" --actorId "value" --entityId "value" +csdk org-member create --actorId --entityId [--isAdmin ] ``` ### Get a orgMember by id diff --git a/skills/cli-public/references/org-membership-default.md b/skills/cli-public/references/org-membership-default.md index 1c437e910..899ee3d65 100644 --- a/skills/cli-public/references/org-membership-default.md +++ b/skills/cli-public/references/org-membership-default.md @@ -9,7 +9,7 @@ CRUD operations for OrgMembershipDefault records via csdk CLI ```bash csdk org-membership-default list csdk org-membership-default get --id -csdk org-membership-default create --createdBy --updatedBy --isApproved --entityId --deleteMemberCascadeGroups --createGroupsCascadeMembers +csdk org-membership-default create --entityId [--createdBy ] [--updatedBy ] [--isApproved ] [--deleteMemberCascadeGroups ] [--createGroupsCascadeMembers ] csdk org-membership-default update --id [--createdBy ] [--updatedBy ] [--isApproved ] [--entityId ] [--deleteMemberCascadeGroups ] [--createGroupsCascadeMembers ] csdk org-membership-default delete --id ``` @@ -25,7 +25,7 @@ csdk org-membership-default list ### Create a orgMembershipDefault ```bash -csdk org-membership-default create --createdBy "value" --updatedBy "value" --isApproved "value" --entityId "value" --deleteMemberCascadeGroups "value" --createGroupsCascadeMembers "value" +csdk org-membership-default create --entityId [--createdBy ] [--updatedBy ] [--isApproved ] [--deleteMemberCascadeGroups ] [--createGroupsCascadeMembers ] ``` ### Get a orgMembershipDefault by id diff --git a/skills/cli-public/references/org-membership.md b/skills/cli-public/references/org-membership.md index ac871cb47..0fd9cc7e6 100644 --- a/skills/cli-public/references/org-membership.md +++ b/skills/cli-public/references/org-membership.md @@ -9,7 +9,7 @@ CRUD operations for OrgMembership records via csdk CLI ```bash csdk org-membership list csdk org-membership get --id -csdk org-membership create --createdBy --updatedBy --isApproved --isBanned --isDisabled --isActive --isOwner --isAdmin --permissions --granted --actorId --entityId --profileId +csdk org-membership create --actorId --entityId [--createdBy ] [--updatedBy ] [--isApproved ] [--isBanned ] [--isDisabled ] [--isActive ] [--isOwner ] [--isAdmin ] [--permissions ] [--granted ] [--profileId ] csdk org-membership update --id [--createdBy ] [--updatedBy ] [--isApproved ] [--isBanned ] [--isDisabled ] [--isActive ] [--isOwner ] [--isAdmin ] [--permissions ] [--granted ] [--actorId ] [--entityId ] [--profileId ] csdk org-membership delete --id ``` @@ -25,7 +25,7 @@ csdk org-membership list ### Create a orgMembership ```bash -csdk org-membership create --createdBy "value" --updatedBy "value" --isApproved "value" --isBanned "value" --isDisabled "value" --isActive "value" --isOwner "value" --isAdmin "value" --permissions "value" --granted "value" --actorId "value" --entityId "value" --profileId "value" +csdk org-membership create --actorId --entityId [--createdBy ] [--updatedBy ] [--isApproved ] [--isBanned ] [--isDisabled ] [--isActive ] [--isOwner ] [--isAdmin ] [--permissions ] [--granted ] [--profileId ] ``` ### Get a orgMembership by id diff --git a/skills/cli-public/references/org-owner-grant.md b/skills/cli-public/references/org-owner-grant.md index 687e2fc35..89e042066 100644 --- a/skills/cli-public/references/org-owner-grant.md +++ b/skills/cli-public/references/org-owner-grant.md @@ -9,7 +9,7 @@ CRUD operations for OrgOwnerGrant records via csdk CLI ```bash csdk org-owner-grant list csdk org-owner-grant get --id -csdk org-owner-grant create --isGrant --actorId --entityId --grantorId +csdk org-owner-grant create --actorId --entityId [--isGrant ] [--grantorId ] csdk org-owner-grant update --id [--isGrant ] [--actorId ] [--entityId ] [--grantorId ] csdk org-owner-grant delete --id ``` @@ -25,7 +25,7 @@ csdk org-owner-grant list ### Create a orgOwnerGrant ```bash -csdk org-owner-grant create --isGrant "value" --actorId "value" --entityId "value" --grantorId "value" +csdk org-owner-grant create --actorId --entityId [--isGrant ] [--grantorId ] ``` ### Get a orgOwnerGrant by id diff --git a/skills/cli-public/references/org-permission-default.md b/skills/cli-public/references/org-permission-default.md index 3b243d67d..4ffffab2b 100644 --- a/skills/cli-public/references/org-permission-default.md +++ b/skills/cli-public/references/org-permission-default.md @@ -9,7 +9,7 @@ CRUD operations for OrgPermissionDefault records via csdk CLI ```bash csdk org-permission-default list csdk org-permission-default get --id -csdk org-permission-default create --permissions --entityId +csdk org-permission-default create --entityId [--permissions ] csdk org-permission-default update --id [--permissions ] [--entityId ] csdk org-permission-default delete --id ``` @@ -25,7 +25,7 @@ csdk org-permission-default list ### Create a orgPermissionDefault ```bash -csdk org-permission-default create --permissions "value" --entityId "value" +csdk org-permission-default create --entityId [--permissions ] ``` ### Get a orgPermissionDefault by id diff --git a/skills/cli-public/references/org-permission.md b/skills/cli-public/references/org-permission.md index 45439c658..98bfe7d30 100644 --- a/skills/cli-public/references/org-permission.md +++ b/skills/cli-public/references/org-permission.md @@ -9,7 +9,7 @@ CRUD operations for OrgPermission records via csdk CLI ```bash csdk org-permission list csdk org-permission get --id -csdk org-permission create --name --bitnum --bitstr --description +csdk org-permission create [--name ] [--bitnum ] [--bitstr ] [--description ] csdk org-permission update --id [--name ] [--bitnum ] [--bitstr ] [--description ] csdk org-permission delete --id ``` @@ -25,7 +25,7 @@ csdk org-permission list ### Create a orgPermission ```bash -csdk org-permission create --name "value" --bitnum "value" --bitstr "value" --description "value" +csdk org-permission create [--name ] [--bitnum ] [--bitstr ] [--description ] ``` ### Get a orgPermission by id diff --git a/skills/cli-public/references/permissions-module.md b/skills/cli-public/references/permissions-module.md index b1e303c0b..a97160309 100644 --- a/skills/cli-public/references/permissions-module.md +++ b/skills/cli-public/references/permissions-module.md @@ -9,7 +9,7 @@ CRUD operations for PermissionsModule records via csdk CLI ```bash csdk permissions-module list csdk permissions-module get --id -csdk permissions-module create --databaseId --schemaId --privateSchemaId --tableId --tableName --defaultTableId --defaultTableName --bitlen --membershipType --entityTableId --actorTableId --prefix --getPaddedMask --getMask --getByMask --getMaskByName +csdk permissions-module create --databaseId --membershipType [--schemaId ] [--privateSchemaId ] [--tableId ] [--tableName ] [--defaultTableId ] [--defaultTableName ] [--bitlen ] [--entityTableId ] [--actorTableId ] [--prefix ] [--getPaddedMask ] [--getMask ] [--getByMask ] [--getMaskByName ] csdk permissions-module update --id [--databaseId ] [--schemaId ] [--privateSchemaId ] [--tableId ] [--tableName ] [--defaultTableId ] [--defaultTableName ] [--bitlen ] [--membershipType ] [--entityTableId ] [--actorTableId ] [--prefix ] [--getPaddedMask ] [--getMask ] [--getByMask ] [--getMaskByName ] csdk permissions-module delete --id ``` @@ -25,7 +25,7 @@ csdk permissions-module list ### Create a permissionsModule ```bash -csdk permissions-module create --databaseId "value" --schemaId "value" --privateSchemaId "value" --tableId "value" --tableName "value" --defaultTableId "value" --defaultTableName "value" --bitlen "value" --membershipType "value" --entityTableId "value" --actorTableId "value" --prefix "value" --getPaddedMask "value" --getMask "value" --getByMask "value" --getMaskByName "value" +csdk permissions-module create --databaseId --membershipType [--schemaId ] [--privateSchemaId ] [--tableId ] [--tableName ] [--defaultTableId ] [--defaultTableName ] [--bitlen ] [--entityTableId ] [--actorTableId ] [--prefix ] [--getPaddedMask ] [--getMask ] [--getByMask ] [--getMaskByName ] ``` ### Get a permissionsModule by id diff --git a/skills/cli-public/references/phone-number.md b/skills/cli-public/references/phone-number.md index 1c607d10b..25c2b3f02 100644 --- a/skills/cli-public/references/phone-number.md +++ b/skills/cli-public/references/phone-number.md @@ -9,7 +9,7 @@ CRUD operations for PhoneNumber records via csdk CLI ```bash csdk phone-number list csdk phone-number get --id -csdk phone-number create --ownerId --cc --number --isVerified --isPrimary +csdk phone-number create --cc --number [--ownerId ] [--isVerified ] [--isPrimary ] csdk phone-number update --id [--ownerId ] [--cc ] [--number ] [--isVerified ] [--isPrimary ] csdk phone-number delete --id ``` @@ -25,7 +25,7 @@ csdk phone-number list ### Create a phoneNumber ```bash -csdk phone-number create --ownerId "value" --cc "value" --number "value" --isVerified "value" --isPrimary "value" +csdk phone-number create --cc --number [--ownerId ] [--isVerified ] [--isPrimary ] ``` ### Get a phoneNumber by id diff --git a/skills/cli-public/references/phone-numbers-module.md b/skills/cli-public/references/phone-numbers-module.md index 1dee74ba2..c26215106 100644 --- a/skills/cli-public/references/phone-numbers-module.md +++ b/skills/cli-public/references/phone-numbers-module.md @@ -9,7 +9,7 @@ CRUD operations for PhoneNumbersModule records via csdk CLI ```bash csdk phone-numbers-module list csdk phone-numbers-module get --id -csdk phone-numbers-module create --databaseId --schemaId --privateSchemaId --tableId --ownerTableId --tableName +csdk phone-numbers-module create --databaseId --tableName [--schemaId ] [--privateSchemaId ] [--tableId ] [--ownerTableId ] csdk phone-numbers-module update --id [--databaseId ] [--schemaId ] [--privateSchemaId ] [--tableId ] [--ownerTableId ] [--tableName ] csdk phone-numbers-module delete --id ``` @@ -25,7 +25,7 @@ csdk phone-numbers-module list ### Create a phoneNumbersModule ```bash -csdk phone-numbers-module create --databaseId "value" --schemaId "value" --privateSchemaId "value" --tableId "value" --ownerTableId "value" --tableName "value" +csdk phone-numbers-module create --databaseId --tableName [--schemaId ] [--privateSchemaId ] [--tableId ] [--ownerTableId ] ``` ### Get a phoneNumbersModule by id diff --git a/skills/cli-public/references/policy.md b/skills/cli-public/references/policy.md index a6d3c08dd..ed3b90a0c 100644 --- a/skills/cli-public/references/policy.md +++ b/skills/cli-public/references/policy.md @@ -9,7 +9,7 @@ CRUD operations for Policy records via csdk CLI ```bash csdk policy list csdk policy get --id -csdk policy create --databaseId --tableId --name --granteeName --privilege --permissive --disabled --policyType --data --smartTags --category --module --scope --tags +csdk policy create --tableId [--databaseId ] [--name ] [--granteeName ] [--privilege ] [--permissive ] [--disabled ] [--policyType ] [--data ] [--smartTags ] [--category ] [--module ] [--scope ] [--tags ] csdk policy update --id [--databaseId ] [--tableId ] [--name ] [--granteeName ] [--privilege ] [--permissive ] [--disabled ] [--policyType ] [--data ] [--smartTags ] [--category ] [--module ] [--scope ] [--tags ] csdk policy delete --id ``` @@ -25,7 +25,7 @@ csdk policy list ### Create a policy ```bash -csdk policy create --databaseId "value" --tableId "value" --name "value" --granteeName "value" --privilege "value" --permissive "value" --disabled "value" --policyType "value" --data "value" --smartTags "value" --category "value" --module "value" --scope "value" --tags "value" +csdk policy create --tableId [--databaseId ] [--name ] [--granteeName ] [--privilege ] [--permissive ] [--disabled ] [--policyType ] [--data ] [--smartTags ] [--category ] [--module ] [--scope ] [--tags ] ``` ### Get a policy by id diff --git a/skills/cli-public/references/primary-key-constraint.md b/skills/cli-public/references/primary-key-constraint.md index a8a05f994..6d0c3d51d 100644 --- a/skills/cli-public/references/primary-key-constraint.md +++ b/skills/cli-public/references/primary-key-constraint.md @@ -9,7 +9,7 @@ CRUD operations for PrimaryKeyConstraint records via csdk CLI ```bash csdk primary-key-constraint list csdk primary-key-constraint get --id -csdk primary-key-constraint create --databaseId --tableId --name --type --fieldIds --smartTags --category --module --scope --tags +csdk primary-key-constraint create --tableId --fieldIds [--databaseId ] [--name ] [--type ] [--smartTags ] [--category ] [--module ] [--scope ] [--tags ] csdk primary-key-constraint update --id [--databaseId ] [--tableId ] [--name ] [--type ] [--fieldIds ] [--smartTags ] [--category ] [--module ] [--scope ] [--tags ] csdk primary-key-constraint delete --id ``` @@ -25,7 +25,7 @@ csdk primary-key-constraint list ### Create a primaryKeyConstraint ```bash -csdk primary-key-constraint create --databaseId "value" --tableId "value" --name "value" --type "value" --fieldIds "value" --smartTags "value" --category "value" --module "value" --scope "value" --tags "value" +csdk primary-key-constraint create --tableId --fieldIds [--databaseId ] [--name ] [--type ] [--smartTags ] [--category ] [--module ] [--scope ] [--tags ] ``` ### Get a primaryKeyConstraint by id diff --git a/skills/cli-public/references/profiles-module.md b/skills/cli-public/references/profiles-module.md index 5182d3f2d..3fe547487 100644 --- a/skills/cli-public/references/profiles-module.md +++ b/skills/cli-public/references/profiles-module.md @@ -9,7 +9,7 @@ CRUD operations for ProfilesModule records via csdk CLI ```bash csdk profiles-module list csdk profiles-module get --id -csdk profiles-module create --databaseId --schemaId --privateSchemaId --tableId --tableName --profilePermissionsTableId --profilePermissionsTableName --profileGrantsTableId --profileGrantsTableName --profileDefinitionGrantsTableId --profileDefinitionGrantsTableName --membershipType --entityTableId --actorTableId --permissionsTableId --membershipsTableId --prefix +csdk profiles-module create --databaseId --membershipType [--schemaId ] [--privateSchemaId ] [--tableId ] [--tableName ] [--profilePermissionsTableId ] [--profilePermissionsTableName ] [--profileGrantsTableId ] [--profileGrantsTableName ] [--profileDefinitionGrantsTableId ] [--profileDefinitionGrantsTableName ] [--entityTableId ] [--actorTableId ] [--permissionsTableId ] [--membershipsTableId ] [--prefix ] csdk profiles-module update --id [--databaseId ] [--schemaId ] [--privateSchemaId ] [--tableId ] [--tableName ] [--profilePermissionsTableId ] [--profilePermissionsTableName ] [--profileGrantsTableId ] [--profileGrantsTableName ] [--profileDefinitionGrantsTableId ] [--profileDefinitionGrantsTableName ] [--membershipType ] [--entityTableId ] [--actorTableId ] [--permissionsTableId ] [--membershipsTableId ] [--prefix ] csdk profiles-module delete --id ``` @@ -25,7 +25,7 @@ csdk profiles-module list ### Create a profilesModule ```bash -csdk profiles-module create --databaseId "value" --schemaId "value" --privateSchemaId "value" --tableId "value" --tableName "value" --profilePermissionsTableId "value" --profilePermissionsTableName "value" --profileGrantsTableId "value" --profileGrantsTableName "value" --profileDefinitionGrantsTableId "value" --profileDefinitionGrantsTableName "value" --membershipType "value" --entityTableId "value" --actorTableId "value" --permissionsTableId "value" --membershipsTableId "value" --prefix "value" +csdk profiles-module create --databaseId --membershipType [--schemaId ] [--privateSchemaId ] [--tableId ] [--tableName ] [--profilePermissionsTableId ] [--profilePermissionsTableName ] [--profileGrantsTableId ] [--profileGrantsTableName ] [--profileDefinitionGrantsTableId ] [--profileDefinitionGrantsTableName ] [--entityTableId ] [--actorTableId ] [--permissionsTableId ] [--membershipsTableId ] [--prefix ] ``` ### Get a profilesModule by id diff --git a/skills/cli-public/references/provision-database-with-user.md b/skills/cli-public/references/provision-database-with-user.md index 6de44e528..64db46863 100644 --- a/skills/cli-public/references/provision-database-with-user.md +++ b/skills/cli-public/references/provision-database-with-user.md @@ -7,7 +7,7 @@ Execute the provisionDatabaseWithUser mutation ## Usage ```bash -csdk provision-database-with-user --input +csdk provision-database-with-user --input.clientMutationId --input.pDatabaseName --input.pDomain --input.pSubdomain --input.pModules --input.pOptions ``` ## Examples @@ -15,5 +15,5 @@ csdk provision-database-with-user --input ### Run provisionDatabaseWithUser ```bash -csdk provision-database-with-user --input +csdk provision-database-with-user --input.clientMutationId --input.pDatabaseName --input.pDomain --input.pSubdomain --input.pModules --input.pOptions ``` diff --git a/skills/cli-public/references/ref.md b/skills/cli-public/references/ref.md index eb5962f43..1115ca4e4 100644 --- a/skills/cli-public/references/ref.md +++ b/skills/cli-public/references/ref.md @@ -9,7 +9,7 @@ CRUD operations for Ref records via csdk CLI ```bash csdk ref list csdk ref get --id -csdk ref create --name --databaseId --storeId --commitId +csdk ref create --name --databaseId --storeId [--commitId ] csdk ref update --id [--name ] [--databaseId ] [--storeId ] [--commitId ] csdk ref delete --id ``` @@ -25,7 +25,7 @@ csdk ref list ### Create a ref ```bash -csdk ref create --name "value" --databaseId "value" --storeId "value" --commitId "value" +csdk ref create --name --databaseId --storeId [--commitId ] ``` ### Get a ref by id diff --git a/skills/cli-public/references/relation-provision.md b/skills/cli-public/references/relation-provision.md index 9b347896f..0d6520f64 100644 --- a/skills/cli-public/references/relation-provision.md +++ b/skills/cli-public/references/relation-provision.md @@ -9,7 +9,7 @@ CRUD operations for RelationProvision records via csdk CLI ```bash csdk relation-provision list csdk relation-provision get --id -csdk relation-provision create --databaseId --relationType --sourceTableId --targetTableId --fieldName --deleteAction --isRequired --junctionTableId --junctionTableName --junctionSchemaId --sourceFieldName --targetFieldName --useCompositeKey --nodeType --nodeData --grantRoles --grantPrivileges --policyType --policyPrivileges --policyRole --policyPermissive --policyName --policyData --outFieldId --outJunctionTableId --outSourceFieldId --outTargetFieldId +csdk relation-provision create --databaseId --relationType --sourceTableId --targetTableId [--fieldName ] [--deleteAction ] [--isRequired ] [--junctionTableId ] [--junctionTableName ] [--junctionSchemaId ] [--sourceFieldName ] [--targetFieldName ] [--useCompositeKey ] [--nodeType ] [--nodeData ] [--grantRoles ] [--grantPrivileges ] [--policyType ] [--policyPrivileges ] [--policyRole ] [--policyPermissive ] [--policyName ] [--policyData ] [--outFieldId ] [--outJunctionTableId ] [--outSourceFieldId ] [--outTargetFieldId ] csdk relation-provision update --id [--databaseId ] [--relationType ] [--sourceTableId ] [--targetTableId ] [--fieldName ] [--deleteAction ] [--isRequired ] [--junctionTableId ] [--junctionTableName ] [--junctionSchemaId ] [--sourceFieldName ] [--targetFieldName ] [--useCompositeKey ] [--nodeType ] [--nodeData ] [--grantRoles ] [--grantPrivileges ] [--policyType ] [--policyPrivileges ] [--policyRole ] [--policyPermissive ] [--policyName ] [--policyData ] [--outFieldId ] [--outJunctionTableId ] [--outSourceFieldId ] [--outTargetFieldId ] csdk relation-provision delete --id ``` @@ -25,7 +25,7 @@ csdk relation-provision list ### Create a relationProvision ```bash -csdk relation-provision create --databaseId "value" --relationType "value" --sourceTableId "value" --targetTableId "value" --fieldName "value" --deleteAction "value" --isRequired "value" --junctionTableId "value" --junctionTableName "value" --junctionSchemaId "value" --sourceFieldName "value" --targetFieldName "value" --useCompositeKey "value" --nodeType "value" --nodeData "value" --grantRoles "value" --grantPrivileges "value" --policyType "value" --policyPrivileges "value" --policyRole "value" --policyPermissive "value" --policyName "value" --policyData "value" --outFieldId "value" --outJunctionTableId "value" --outSourceFieldId "value" --outTargetFieldId "value" +csdk relation-provision create --databaseId --relationType --sourceTableId --targetTableId [--fieldName ] [--deleteAction ] [--isRequired ] [--junctionTableId ] [--junctionTableName ] [--junctionSchemaId ] [--sourceFieldName ] [--targetFieldName ] [--useCompositeKey ] [--nodeType ] [--nodeData ] [--grantRoles ] [--grantPrivileges ] [--policyType ] [--policyPrivileges ] [--policyRole ] [--policyPermissive ] [--policyName ] [--policyData ] [--outFieldId ] [--outJunctionTableId ] [--outSourceFieldId ] [--outTargetFieldId ] ``` ### Get a relationProvision by id diff --git a/skills/cli-public/references/remove-node-at-path.md b/skills/cli-public/references/remove-node-at-path.md index 4c08b622a..5a4c3906c 100644 --- a/skills/cli-public/references/remove-node-at-path.md +++ b/skills/cli-public/references/remove-node-at-path.md @@ -7,7 +7,7 @@ Execute the removeNodeAtPath mutation ## Usage ```bash -csdk remove-node-at-path --input +csdk remove-node-at-path --input.clientMutationId --input.dbId --input.root --input.path ``` ## Examples @@ -15,5 +15,5 @@ csdk remove-node-at-path --input ### Run removeNodeAtPath ```bash -csdk remove-node-at-path --input +csdk remove-node-at-path --input.clientMutationId --input.dbId --input.root --input.path ``` diff --git a/skills/cli-public/references/reset-password.md b/skills/cli-public/references/reset-password.md index cb9e666a6..7a52ad0a0 100644 --- a/skills/cli-public/references/reset-password.md +++ b/skills/cli-public/references/reset-password.md @@ -7,7 +7,7 @@ Execute the resetPassword mutation ## Usage ```bash -csdk reset-password --input +csdk reset-password --input.clientMutationId --input.roleId --input.resetToken --input.newPassword ``` ## Examples @@ -15,5 +15,5 @@ csdk reset-password --input ### Run resetPassword ```bash -csdk reset-password --input +csdk reset-password --input.clientMutationId --input.roleId --input.resetToken --input.newPassword ``` diff --git a/skills/cli-public/references/rls-module.md b/skills/cli-public/references/rls-module.md index 7470f6b77..1f4f2f088 100644 --- a/skills/cli-public/references/rls-module.md +++ b/skills/cli-public/references/rls-module.md @@ -9,7 +9,7 @@ CRUD operations for RlsModule records via csdk CLI ```bash csdk rls-module list csdk rls-module get --id -csdk rls-module create --databaseId --apiId --schemaId --privateSchemaId --sessionCredentialsTableId --sessionsTableId --usersTableId --authenticate --authenticateStrict --currentRole --currentRoleId +csdk rls-module create --databaseId [--apiId ] [--schemaId ] [--privateSchemaId ] [--sessionCredentialsTableId ] [--sessionsTableId ] [--usersTableId ] [--authenticate ] [--authenticateStrict ] [--currentRole ] [--currentRoleId ] csdk rls-module update --id [--databaseId ] [--apiId ] [--schemaId ] [--privateSchemaId ] [--sessionCredentialsTableId ] [--sessionsTableId ] [--usersTableId ] [--authenticate ] [--authenticateStrict ] [--currentRole ] [--currentRoleId ] csdk rls-module delete --id ``` @@ -25,7 +25,7 @@ csdk rls-module list ### Create a rlsModule ```bash -csdk rls-module create --databaseId "value" --apiId "value" --schemaId "value" --privateSchemaId "value" --sessionCredentialsTableId "value" --sessionsTableId "value" --usersTableId "value" --authenticate "value" --authenticateStrict "value" --currentRole "value" --currentRoleId "value" +csdk rls-module create --databaseId [--apiId ] [--schemaId ] [--privateSchemaId ] [--sessionCredentialsTableId ] [--sessionsTableId ] [--usersTableId ] [--authenticate ] [--authenticateStrict ] [--currentRole ] [--currentRoleId ] ``` ### Get a rlsModule by id diff --git a/skills/cli-public/references/role-type.md b/skills/cli-public/references/role-type.md index a6b83f75f..f00f9e6c4 100644 --- a/skills/cli-public/references/role-type.md +++ b/skills/cli-public/references/role-type.md @@ -25,7 +25,7 @@ csdk role-type list ### Create a roleType ```bash -csdk role-type create --name "value" +csdk role-type create --name ``` ### Get a roleType by id diff --git a/skills/cli-public/references/schema-grant.md b/skills/cli-public/references/schema-grant.md index 4aeff7cd2..5565bf2c3 100644 --- a/skills/cli-public/references/schema-grant.md +++ b/skills/cli-public/references/schema-grant.md @@ -9,7 +9,7 @@ CRUD operations for SchemaGrant records via csdk CLI ```bash csdk schema-grant list csdk schema-grant get --id -csdk schema-grant create --databaseId --schemaId --granteeName +csdk schema-grant create --schemaId --granteeName [--databaseId ] csdk schema-grant update --id [--databaseId ] [--schemaId ] [--granteeName ] csdk schema-grant delete --id ``` @@ -25,7 +25,7 @@ csdk schema-grant list ### Create a schemaGrant ```bash -csdk schema-grant create --databaseId "value" --schemaId "value" --granteeName "value" +csdk schema-grant create --schemaId --granteeName [--databaseId ] ``` ### Get a schemaGrant by id diff --git a/skills/cli-public/references/schema.md b/skills/cli-public/references/schema.md index 630e52edd..6ed1bf10a 100644 --- a/skills/cli-public/references/schema.md +++ b/skills/cli-public/references/schema.md @@ -9,7 +9,7 @@ CRUD operations for Schema records via csdk CLI ```bash csdk schema list csdk schema get --id -csdk schema create --databaseId --name --schemaName --label --description --smartTags --category --module --scope --tags --isPublic +csdk schema create --databaseId --name --schemaName [--label ] [--description ] [--smartTags ] [--category ] [--module ] [--scope ] [--tags ] [--isPublic ] csdk schema update --id [--databaseId ] [--name ] [--schemaName ] [--label ] [--description ] [--smartTags ] [--category ] [--module ] [--scope ] [--tags ] [--isPublic ] csdk schema delete --id ``` @@ -25,7 +25,7 @@ csdk schema list ### Create a schema ```bash -csdk schema create --databaseId "value" --name "value" --schemaName "value" --label "value" --description "value" --smartTags "value" --category "value" --module "value" --scope "value" --tags "value" --isPublic "value" +csdk schema create --databaseId --name --schemaName [--label ] [--description ] [--smartTags ] [--category ] [--module ] [--scope ] [--tags ] [--isPublic ] ``` ### Get a schema by id diff --git a/skills/cli-public/references/secrets-module.md b/skills/cli-public/references/secrets-module.md index f7cf86158..483d52806 100644 --- a/skills/cli-public/references/secrets-module.md +++ b/skills/cli-public/references/secrets-module.md @@ -9,7 +9,7 @@ CRUD operations for SecretsModule records via csdk CLI ```bash csdk secrets-module list csdk secrets-module get --id -csdk secrets-module create --databaseId --schemaId --tableId --tableName +csdk secrets-module create --databaseId [--schemaId ] [--tableId ] [--tableName ] csdk secrets-module update --id [--databaseId ] [--schemaId ] [--tableId ] [--tableName ] csdk secrets-module delete --id ``` @@ -25,7 +25,7 @@ csdk secrets-module list ### Create a secretsModule ```bash -csdk secrets-module create --databaseId "value" --schemaId "value" --tableId "value" --tableName "value" +csdk secrets-module create --databaseId [--schemaId ] [--tableId ] [--tableName ] ``` ### Get a secretsModule by id diff --git a/skills/cli-public/references/secure-table-provision.md b/skills/cli-public/references/secure-table-provision.md index be5de7d75..824683f78 100644 --- a/skills/cli-public/references/secure-table-provision.md +++ b/skills/cli-public/references/secure-table-provision.md @@ -9,7 +9,7 @@ CRUD operations for SecureTableProvision records via csdk CLI ```bash csdk secure-table-provision list csdk secure-table-provision get --id -csdk secure-table-provision create --databaseId --schemaId --tableId --tableName --nodeType --useRls --nodeData --grantRoles --grantPrivileges --policyType --policyPrivileges --policyRole --policyPermissive --policyName --policyData --outFields +csdk secure-table-provision create --databaseId [--schemaId ] [--tableId ] [--tableName ] [--nodeType ] [--useRls ] [--nodeData ] [--grantRoles ] [--grantPrivileges ] [--policyType ] [--policyPrivileges ] [--policyRole ] [--policyPermissive ] [--policyName ] [--policyData ] [--outFields ] csdk secure-table-provision update --id [--databaseId ] [--schemaId ] [--tableId ] [--tableName ] [--nodeType ] [--useRls ] [--nodeData ] [--grantRoles ] [--grantPrivileges ] [--policyType ] [--policyPrivileges ] [--policyRole ] [--policyPermissive ] [--policyName ] [--policyData ] [--outFields ] csdk secure-table-provision delete --id ``` @@ -25,7 +25,7 @@ csdk secure-table-provision list ### Create a secureTableProvision ```bash -csdk secure-table-provision create --databaseId "value" --schemaId "value" --tableId "value" --tableName "value" --nodeType "value" --useRls "value" --nodeData "value" --grantRoles "value" --grantPrivileges "value" --policyType "value" --policyPrivileges "value" --policyRole "value" --policyPermissive "value" --policyName "value" --policyData "value" --outFields "value" +csdk secure-table-provision create --databaseId [--schemaId ] [--tableId ] [--tableName ] [--nodeType ] [--useRls ] [--nodeData ] [--grantRoles ] [--grantPrivileges ] [--policyType ] [--policyPrivileges ] [--policyRole ] [--policyPermissive ] [--policyName ] [--policyData ] [--outFields ] ``` ### Get a secureTableProvision by id diff --git a/skills/cli-public/references/send-account-deletion-email.md b/skills/cli-public/references/send-account-deletion-email.md index e89c21d02..8f9014e27 100644 --- a/skills/cli-public/references/send-account-deletion-email.md +++ b/skills/cli-public/references/send-account-deletion-email.md @@ -7,7 +7,7 @@ Execute the sendAccountDeletionEmail mutation ## Usage ```bash -csdk send-account-deletion-email --input +csdk send-account-deletion-email --input.clientMutationId ``` ## Examples @@ -15,5 +15,5 @@ csdk send-account-deletion-email --input ### Run sendAccountDeletionEmail ```bash -csdk send-account-deletion-email --input +csdk send-account-deletion-email --input.clientMutationId ``` diff --git a/skills/cli-public/references/send-verification-email.md b/skills/cli-public/references/send-verification-email.md index c0e6e05ee..de04a0acd 100644 --- a/skills/cli-public/references/send-verification-email.md +++ b/skills/cli-public/references/send-verification-email.md @@ -7,7 +7,7 @@ Execute the sendVerificationEmail mutation ## Usage ```bash -csdk send-verification-email --input +csdk send-verification-email --input.clientMutationId --input.email ``` ## Examples @@ -15,5 +15,5 @@ csdk send-verification-email --input ### Run sendVerificationEmail ```bash -csdk send-verification-email --input +csdk send-verification-email --input.clientMutationId --input.email ``` diff --git a/skills/cli-public/references/sessions-module.md b/skills/cli-public/references/sessions-module.md index b6e1f091b..8a12a9d3b 100644 --- a/skills/cli-public/references/sessions-module.md +++ b/skills/cli-public/references/sessions-module.md @@ -9,7 +9,7 @@ CRUD operations for SessionsModule records via csdk CLI ```bash csdk sessions-module list csdk sessions-module get --id -csdk sessions-module create --databaseId --schemaId --sessionsTableId --sessionCredentialsTableId --authSettingsTableId --usersTableId --sessionsDefaultExpiration --sessionsTable --sessionCredentialsTable --authSettingsTable +csdk sessions-module create --databaseId [--schemaId ] [--sessionsTableId ] [--sessionCredentialsTableId ] [--authSettingsTableId ] [--usersTableId ] [--sessionsDefaultExpiration ] [--sessionsTable ] [--sessionCredentialsTable ] [--authSettingsTable ] csdk sessions-module update --id [--databaseId ] [--schemaId ] [--sessionsTableId ] [--sessionCredentialsTableId ] [--authSettingsTableId ] [--usersTableId ] [--sessionsDefaultExpiration ] [--sessionsTable ] [--sessionCredentialsTable ] [--authSettingsTable ] csdk sessions-module delete --id ``` @@ -25,7 +25,7 @@ csdk sessions-module list ### Create a sessionsModule ```bash -csdk sessions-module create --databaseId "value" --schemaId "value" --sessionsTableId "value" --sessionCredentialsTableId "value" --authSettingsTableId "value" --usersTableId "value" --sessionsDefaultExpiration "value" --sessionsTable "value" --sessionCredentialsTable "value" --authSettingsTable "value" +csdk sessions-module create --databaseId [--schemaId ] [--sessionsTableId ] [--sessionCredentialsTableId ] [--authSettingsTableId ] [--usersTableId ] [--sessionsDefaultExpiration ] [--sessionsTable ] [--sessionCredentialsTable ] [--authSettingsTable ] ``` ### Get a sessionsModule by id diff --git a/skills/cli-public/references/set-and-commit.md b/skills/cli-public/references/set-and-commit.md index b3c180d35..419777f6b 100644 --- a/skills/cli-public/references/set-and-commit.md +++ b/skills/cli-public/references/set-and-commit.md @@ -7,7 +7,7 @@ Execute the setAndCommit mutation ## Usage ```bash -csdk set-and-commit --input +csdk set-and-commit --input.clientMutationId --input.dbId --input.storeId --input.refname --input.path --input.data --input.kids --input.ktree ``` ## Examples @@ -15,5 +15,5 @@ csdk set-and-commit --input ### Run setAndCommit ```bash -csdk set-and-commit --input +csdk set-and-commit --input.clientMutationId --input.dbId --input.storeId --input.refname --input.path --input.data --input.kids --input.ktree ``` diff --git a/skills/cli-public/references/set-data-at-path.md b/skills/cli-public/references/set-data-at-path.md index efb3ba4b9..7fe032779 100644 --- a/skills/cli-public/references/set-data-at-path.md +++ b/skills/cli-public/references/set-data-at-path.md @@ -7,7 +7,7 @@ Execute the setDataAtPath mutation ## Usage ```bash -csdk set-data-at-path --input +csdk set-data-at-path --input.clientMutationId --input.dbId --input.root --input.path --input.data ``` ## Examples @@ -15,5 +15,5 @@ csdk set-data-at-path --input ### Run setDataAtPath ```bash -csdk set-data-at-path --input +csdk set-data-at-path --input.clientMutationId --input.dbId --input.root --input.path --input.data ``` diff --git a/skills/cli-public/references/set-field-order.md b/skills/cli-public/references/set-field-order.md index b0f60c686..d8d5132f8 100644 --- a/skills/cli-public/references/set-field-order.md +++ b/skills/cli-public/references/set-field-order.md @@ -7,7 +7,7 @@ Execute the setFieldOrder mutation ## Usage ```bash -csdk set-field-order --input +csdk set-field-order --input.clientMutationId --input.fieldIds ``` ## Examples @@ -15,5 +15,5 @@ csdk set-field-order --input ### Run setFieldOrder ```bash -csdk set-field-order --input +csdk set-field-order --input.clientMutationId --input.fieldIds ``` diff --git a/skills/cli-public/references/set-password.md b/skills/cli-public/references/set-password.md index df8a616d0..a53748330 100644 --- a/skills/cli-public/references/set-password.md +++ b/skills/cli-public/references/set-password.md @@ -7,7 +7,7 @@ Execute the setPassword mutation ## Usage ```bash -csdk set-password --input +csdk set-password --input.clientMutationId --input.currentPassword --input.newPassword ``` ## Examples @@ -15,5 +15,5 @@ csdk set-password --input ### Run setPassword ```bash -csdk set-password --input +csdk set-password --input.clientMutationId --input.currentPassword --input.newPassword ``` diff --git a/skills/cli-public/references/set-props-and-commit.md b/skills/cli-public/references/set-props-and-commit.md index 8767344e9..cdb7d15a0 100644 --- a/skills/cli-public/references/set-props-and-commit.md +++ b/skills/cli-public/references/set-props-and-commit.md @@ -7,7 +7,7 @@ Execute the setPropsAndCommit mutation ## Usage ```bash -csdk set-props-and-commit --input +csdk set-props-and-commit --input.clientMutationId --input.dbId --input.storeId --input.refname --input.path --input.data ``` ## Examples @@ -15,5 +15,5 @@ csdk set-props-and-commit --input ### Run setPropsAndCommit ```bash -csdk set-props-and-commit --input +csdk set-props-and-commit --input.clientMutationId --input.dbId --input.storeId --input.refname --input.path --input.data ``` diff --git a/skills/cli-public/references/sign-in-one-time-token.md b/skills/cli-public/references/sign-in-one-time-token.md index a525541e0..ff2410414 100644 --- a/skills/cli-public/references/sign-in-one-time-token.md +++ b/skills/cli-public/references/sign-in-one-time-token.md @@ -7,7 +7,7 @@ Execute the signInOneTimeToken mutation ## Usage ```bash -csdk sign-in-one-time-token --input +csdk sign-in-one-time-token --input.clientMutationId --input.token --input.credentialKind ``` ## Examples @@ -15,5 +15,5 @@ csdk sign-in-one-time-token --input ### Run signInOneTimeToken ```bash -csdk sign-in-one-time-token --input +csdk sign-in-one-time-token --input.clientMutationId --input.token --input.credentialKind ``` diff --git a/skills/cli-public/references/sign-in.md b/skills/cli-public/references/sign-in.md index 5b8fb1c9c..54fbe6864 100644 --- a/skills/cli-public/references/sign-in.md +++ b/skills/cli-public/references/sign-in.md @@ -7,7 +7,7 @@ Execute the signIn mutation ## Usage ```bash -csdk sign-in --input +csdk sign-in --input.clientMutationId --input.email --input.password --input.rememberMe --input.credentialKind --input.csrfToken ``` ## Examples @@ -15,5 +15,5 @@ csdk sign-in --input ### Run signIn ```bash -csdk sign-in --input +csdk sign-in --input.clientMutationId --input.email --input.password --input.rememberMe --input.credentialKind --input.csrfToken ``` diff --git a/skills/cli-public/references/sign-out.md b/skills/cli-public/references/sign-out.md index 717b8923d..f4a29351d 100644 --- a/skills/cli-public/references/sign-out.md +++ b/skills/cli-public/references/sign-out.md @@ -7,7 +7,7 @@ Execute the signOut mutation ## Usage ```bash -csdk sign-out --input +csdk sign-out --input.clientMutationId ``` ## Examples @@ -15,5 +15,5 @@ csdk sign-out --input ### Run signOut ```bash -csdk sign-out --input +csdk sign-out --input.clientMutationId ``` diff --git a/skills/cli-public/references/sign-up.md b/skills/cli-public/references/sign-up.md index fd17fb1e1..7b69210e2 100644 --- a/skills/cli-public/references/sign-up.md +++ b/skills/cli-public/references/sign-up.md @@ -7,7 +7,7 @@ Execute the signUp mutation ## Usage ```bash -csdk sign-up --input +csdk sign-up --input.clientMutationId --input.email --input.password --input.rememberMe --input.credentialKind --input.csrfToken ``` ## Examples @@ -15,5 +15,5 @@ csdk sign-up --input ### Run signUp ```bash -csdk sign-up --input +csdk sign-up --input.clientMutationId --input.email --input.password --input.rememberMe --input.credentialKind --input.csrfToken ``` diff --git a/skills/cli-public/references/site-metadatum.md b/skills/cli-public/references/site-metadatum.md index a639fdf4d..85485fd26 100644 --- a/skills/cli-public/references/site-metadatum.md +++ b/skills/cli-public/references/site-metadatum.md @@ -9,7 +9,7 @@ CRUD operations for SiteMetadatum records via csdk CLI ```bash csdk site-metadatum list csdk site-metadatum get --id -csdk site-metadatum create --databaseId --siteId --title --description --ogImage +csdk site-metadatum create --databaseId --siteId [--title ] [--description ] [--ogImage ] csdk site-metadatum update --id [--databaseId ] [--siteId ] [--title ] [--description ] [--ogImage ] csdk site-metadatum delete --id ``` @@ -25,7 +25,7 @@ csdk site-metadatum list ### Create a siteMetadatum ```bash -csdk site-metadatum create --databaseId "value" --siteId "value" --title "value" --description "value" --ogImage "value" +csdk site-metadatum create --databaseId --siteId [--title ] [--description ] [--ogImage ] ``` ### Get a siteMetadatum by id diff --git a/skills/cli-public/references/site-module.md b/skills/cli-public/references/site-module.md index cac17e245..af6716f72 100644 --- a/skills/cli-public/references/site-module.md +++ b/skills/cli-public/references/site-module.md @@ -25,7 +25,7 @@ csdk site-module list ### Create a siteModule ```bash -csdk site-module create --databaseId "value" --siteId "value" --name "value" --data "value" +csdk site-module create --databaseId --siteId --name --data ``` ### Get a siteModule by id diff --git a/skills/cli-public/references/site-theme.md b/skills/cli-public/references/site-theme.md index 27c2bb056..9cdfe5f12 100644 --- a/skills/cli-public/references/site-theme.md +++ b/skills/cli-public/references/site-theme.md @@ -25,7 +25,7 @@ csdk site-theme list ### Create a siteTheme ```bash -csdk site-theme create --databaseId "value" --siteId "value" --theme "value" +csdk site-theme create --databaseId --siteId --theme ``` ### Get a siteTheme by id diff --git a/skills/cli-public/references/site.md b/skills/cli-public/references/site.md index a36ea1b01..50ecef8da 100644 --- a/skills/cli-public/references/site.md +++ b/skills/cli-public/references/site.md @@ -9,7 +9,7 @@ CRUD operations for Site records via csdk CLI ```bash csdk site list csdk site get --id -csdk site create --databaseId --title --description --ogImage --favicon --appleTouchIcon --logo --dbname +csdk site create --databaseId [--title ] [--description ] [--ogImage ] [--favicon ] [--appleTouchIcon ] [--logo ] [--dbname ] csdk site update --id [--databaseId ] [--title ] [--description ] [--ogImage ] [--favicon ] [--appleTouchIcon ] [--logo ] [--dbname ] csdk site delete --id ``` @@ -25,7 +25,7 @@ csdk site list ### Create a site ```bash -csdk site create --databaseId "value" --title "value" --description "value" --ogImage "value" --favicon "value" --appleTouchIcon "value" --logo "value" --dbname "value" +csdk site create --databaseId [--title ] [--description ] [--ogImage ] [--favicon ] [--appleTouchIcon ] [--logo ] [--dbname ] ``` ### Get a site by id diff --git a/skills/cli-public/references/sql-migration.md b/skills/cli-public/references/sql-migration.md index 8a24b63a5..303714397 100644 --- a/skills/cli-public/references/sql-migration.md +++ b/skills/cli-public/references/sql-migration.md @@ -9,7 +9,7 @@ CRUD operations for SqlMigration records via csdk CLI ```bash csdk sql-migration list csdk sql-migration get --id -csdk sql-migration create --name --databaseId --deploy --deps --payload --content --revert --verify --action --actionId --actorId +csdk sql-migration create [--name ] [--databaseId ] [--deploy ] [--deps ] [--payload ] [--content ] [--revert ] [--verify ] [--action ] [--actionId ] [--actorId ] csdk sql-migration update --id [--name ] [--databaseId ] [--deploy ] [--deps ] [--payload ] [--content ] [--revert ] [--verify ] [--action ] [--actionId ] [--actorId ] csdk sql-migration delete --id ``` @@ -25,7 +25,7 @@ csdk sql-migration list ### Create a sqlMigration ```bash -csdk sql-migration create --name "value" --databaseId "value" --deploy "value" --deps "value" --payload "value" --content "value" --revert "value" --verify "value" --action "value" --actionId "value" --actorId "value" +csdk sql-migration create [--name ] [--databaseId ] [--deploy ] [--deps ] [--payload ] [--content ] [--revert ] [--verify ] [--action ] [--actionId ] [--actorId ] ``` ### Get a sqlMigration by id diff --git a/skills/cli-public/references/store.md b/skills/cli-public/references/store.md index 3ae73ddbc..6f1a7482e 100644 --- a/skills/cli-public/references/store.md +++ b/skills/cli-public/references/store.md @@ -9,7 +9,7 @@ CRUD operations for Store records via csdk CLI ```bash csdk store list csdk store get --id -csdk store create --name --databaseId --hash +csdk store create --name --databaseId [--hash ] csdk store update --id [--name ] [--databaseId ] [--hash ] csdk store delete --id ``` @@ -25,7 +25,7 @@ csdk store list ### Create a store ```bash -csdk store create --name "value" --databaseId "value" --hash "value" +csdk store create --name --databaseId [--hash ] ``` ### Get a store by id diff --git a/skills/cli-public/references/submit-invite-code.md b/skills/cli-public/references/submit-invite-code.md index da1be26f0..b61ec52a4 100644 --- a/skills/cli-public/references/submit-invite-code.md +++ b/skills/cli-public/references/submit-invite-code.md @@ -7,7 +7,7 @@ Execute the submitInviteCode mutation ## Usage ```bash -csdk submit-invite-code --input +csdk submit-invite-code --input.clientMutationId --input.token ``` ## Examples @@ -15,5 +15,5 @@ csdk submit-invite-code --input ### Run submitInviteCode ```bash -csdk submit-invite-code --input +csdk submit-invite-code --input.clientMutationId --input.token ``` diff --git a/skills/cli-public/references/submit-org-invite-code.md b/skills/cli-public/references/submit-org-invite-code.md index e09722277..93545f1a7 100644 --- a/skills/cli-public/references/submit-org-invite-code.md +++ b/skills/cli-public/references/submit-org-invite-code.md @@ -7,7 +7,7 @@ Execute the submitOrgInviteCode mutation ## Usage ```bash -csdk submit-org-invite-code --input +csdk submit-org-invite-code --input.clientMutationId --input.token ``` ## Examples @@ -15,5 +15,5 @@ csdk submit-org-invite-code --input ### Run submitOrgInviteCode ```bash -csdk submit-org-invite-code --input +csdk submit-org-invite-code --input.clientMutationId --input.token ``` diff --git a/skills/cli-public/references/table-grant.md b/skills/cli-public/references/table-grant.md index afd848986..b7a090ede 100644 --- a/skills/cli-public/references/table-grant.md +++ b/skills/cli-public/references/table-grant.md @@ -9,7 +9,7 @@ CRUD operations for TableGrant records via csdk CLI ```bash csdk table-grant list csdk table-grant get --id -csdk table-grant create --databaseId --tableId --privilege --granteeName --fieldIds --isGrant +csdk table-grant create --tableId --privilege --granteeName [--databaseId ] [--fieldIds ] [--isGrant ] csdk table-grant update --id [--databaseId ] [--tableId ] [--privilege ] [--granteeName ] [--fieldIds ] [--isGrant ] csdk table-grant delete --id ``` @@ -25,7 +25,7 @@ csdk table-grant list ### Create a tableGrant ```bash -csdk table-grant create --databaseId "value" --tableId "value" --privilege "value" --granteeName "value" --fieldIds "value" --isGrant "value" +csdk table-grant create --tableId --privilege --granteeName [--databaseId ] [--fieldIds ] [--isGrant ] ``` ### Get a tableGrant by id diff --git a/skills/cli-public/references/table-module.md b/skills/cli-public/references/table-module.md index b515c3b6e..aee74d880 100644 --- a/skills/cli-public/references/table-module.md +++ b/skills/cli-public/references/table-module.md @@ -9,7 +9,7 @@ CRUD operations for TableModule records via csdk CLI ```bash csdk table-module list csdk table-module get --id -csdk table-module create --databaseId --schemaId --tableId --tableName --nodeType --useRls --data --fields +csdk table-module create --databaseId --nodeType [--schemaId ] [--tableId ] [--tableName ] [--useRls ] [--data ] [--fields ] csdk table-module update --id [--databaseId ] [--schemaId ] [--tableId ] [--tableName ] [--nodeType ] [--useRls ] [--data ] [--fields ] csdk table-module delete --id ``` @@ -25,7 +25,7 @@ csdk table-module list ### Create a tableModule ```bash -csdk table-module create --databaseId "value" --schemaId "value" --tableId "value" --tableName "value" --nodeType "value" --useRls "value" --data "value" --fields "value" +csdk table-module create --databaseId --nodeType [--schemaId ] [--tableId ] [--tableName ] [--useRls ] [--data ] [--fields ] ``` ### Get a tableModule by id diff --git a/skills/cli-public/references/table-template-module.md b/skills/cli-public/references/table-template-module.md index 9b77f58b4..3f83caed9 100644 --- a/skills/cli-public/references/table-template-module.md +++ b/skills/cli-public/references/table-template-module.md @@ -9,7 +9,7 @@ CRUD operations for TableTemplateModule records via csdk CLI ```bash csdk table-template-module list csdk table-template-module get --id -csdk table-template-module create --databaseId --schemaId --privateSchemaId --tableId --ownerTableId --tableName --nodeType --data +csdk table-template-module create --databaseId --tableName --nodeType [--schemaId ] [--privateSchemaId ] [--tableId ] [--ownerTableId ] [--data ] csdk table-template-module update --id [--databaseId ] [--schemaId ] [--privateSchemaId ] [--tableId ] [--ownerTableId ] [--tableName ] [--nodeType ] [--data ] csdk table-template-module delete --id ``` @@ -25,7 +25,7 @@ csdk table-template-module list ### Create a tableTemplateModule ```bash -csdk table-template-module create --databaseId "value" --schemaId "value" --privateSchemaId "value" --tableId "value" --ownerTableId "value" --tableName "value" --nodeType "value" --data "value" +csdk table-template-module create --databaseId --tableName --nodeType [--schemaId ] [--privateSchemaId ] [--tableId ] [--ownerTableId ] [--data ] ``` ### Get a tableTemplateModule by id diff --git a/skills/cli-public/references/table.md b/skills/cli-public/references/table.md index a3c4903ed..2a91f0c41 100644 --- a/skills/cli-public/references/table.md +++ b/skills/cli-public/references/table.md @@ -9,7 +9,7 @@ CRUD operations for Table records via csdk CLI ```bash csdk table list csdk table get --id -csdk table create --databaseId --schemaId --name --label --description --smartTags --category --module --scope --useRls --timestamps --peoplestamps --pluralName --singularName --tags --inheritsId +csdk table create --schemaId --name [--databaseId ] [--label ] [--description ] [--smartTags ] [--category ] [--module ] [--scope ] [--useRls ] [--timestamps ] [--peoplestamps ] [--pluralName ] [--singularName ] [--tags ] [--inheritsId ] csdk table update --id [--databaseId ] [--schemaId ] [--name ] [--label ] [--description ] [--smartTags ] [--category ] [--module ] [--scope ] [--useRls ] [--timestamps ] [--peoplestamps ] [--pluralName ] [--singularName ] [--tags ] [--inheritsId ] csdk table delete --id ``` @@ -25,7 +25,7 @@ csdk table list ### Create a table ```bash -csdk table create --databaseId "value" --schemaId "value" --name "value" --label "value" --description "value" --smartTags "value" --category "value" --module "value" --scope "value" --useRls "value" --timestamps "value" --peoplestamps "value" --pluralName "value" --singularName "value" --tags "value" --inheritsId "value" +csdk table create --schemaId --name [--databaseId ] [--label ] [--description ] [--smartTags ] [--category ] [--module ] [--scope ] [--useRls ] [--timestamps ] [--peoplestamps ] [--pluralName ] [--singularName ] [--tags ] [--inheritsId ] ``` ### Get a table by id diff --git a/skills/cli-public/references/trigger-function.md b/skills/cli-public/references/trigger-function.md index 16b2996fe..d0b20ecbd 100644 --- a/skills/cli-public/references/trigger-function.md +++ b/skills/cli-public/references/trigger-function.md @@ -9,7 +9,7 @@ CRUD operations for TriggerFunction records via csdk CLI ```bash csdk trigger-function list csdk trigger-function get --id -csdk trigger-function create --databaseId --name --code +csdk trigger-function create --databaseId --name [--code ] csdk trigger-function update --id [--databaseId ] [--name ] [--code ] csdk trigger-function delete --id ``` @@ -25,7 +25,7 @@ csdk trigger-function list ### Create a triggerFunction ```bash -csdk trigger-function create --databaseId "value" --name "value" --code "value" +csdk trigger-function create --databaseId --name [--code ] ``` ### Get a triggerFunction by id diff --git a/skills/cli-public/references/trigger.md b/skills/cli-public/references/trigger.md index 3077a61c1..bc966aefc 100644 --- a/skills/cli-public/references/trigger.md +++ b/skills/cli-public/references/trigger.md @@ -9,7 +9,7 @@ CRUD operations for Trigger records via csdk CLI ```bash csdk trigger list csdk trigger get --id -csdk trigger create --databaseId --tableId --name --event --functionName --smartTags --category --module --scope --tags +csdk trigger create --tableId --name [--databaseId ] [--event ] [--functionName ] [--smartTags ] [--category ] [--module ] [--scope ] [--tags ] csdk trigger update --id [--databaseId ] [--tableId ] [--name ] [--event ] [--functionName ] [--smartTags ] [--category ] [--module ] [--scope ] [--tags ] csdk trigger delete --id ``` @@ -25,7 +25,7 @@ csdk trigger list ### Create a trigger ```bash -csdk trigger create --databaseId "value" --tableId "value" --name "value" --event "value" --functionName "value" --smartTags "value" --category "value" --module "value" --scope "value" --tags "value" +csdk trigger create --tableId --name [--databaseId ] [--event ] [--functionName ] [--smartTags ] [--category ] [--module ] [--scope ] [--tags ] ``` ### Get a trigger by id diff --git a/skills/cli-public/references/unique-constraint.md b/skills/cli-public/references/unique-constraint.md index ca721e2f2..ea04935b3 100644 --- a/skills/cli-public/references/unique-constraint.md +++ b/skills/cli-public/references/unique-constraint.md @@ -9,7 +9,7 @@ CRUD operations for UniqueConstraint records via csdk CLI ```bash csdk unique-constraint list csdk unique-constraint get --id -csdk unique-constraint create --databaseId --tableId --name --description --smartTags --type --fieldIds --category --module --scope --tags +csdk unique-constraint create --tableId --fieldIds [--databaseId ] [--name ] [--description ] [--smartTags ] [--type ] [--category ] [--module ] [--scope ] [--tags ] csdk unique-constraint update --id [--databaseId ] [--tableId ] [--name ] [--description ] [--smartTags ] [--type ] [--fieldIds ] [--category ] [--module ] [--scope ] [--tags ] csdk unique-constraint delete --id ``` @@ -25,7 +25,7 @@ csdk unique-constraint list ### Create a uniqueConstraint ```bash -csdk unique-constraint create --databaseId "value" --tableId "value" --name "value" --description "value" --smartTags "value" --type "value" --fieldIds "value" --category "value" --module "value" --scope "value" --tags "value" +csdk unique-constraint create --tableId --fieldIds [--databaseId ] [--name ] [--description ] [--smartTags ] [--type ] [--category ] [--module ] [--scope ] [--tags ] ``` ### Get a uniqueConstraint by id diff --git a/skills/cli-public/references/update-node-at-path.md b/skills/cli-public/references/update-node-at-path.md index 8374c33e7..289876550 100644 --- a/skills/cli-public/references/update-node-at-path.md +++ b/skills/cli-public/references/update-node-at-path.md @@ -7,7 +7,7 @@ Execute the updateNodeAtPath mutation ## Usage ```bash -csdk update-node-at-path --input +csdk update-node-at-path --input.clientMutationId --input.dbId --input.root --input.path --input.data --input.kids --input.ktree ``` ## Examples @@ -15,5 +15,5 @@ csdk update-node-at-path --input ### Run updateNodeAtPath ```bash -csdk update-node-at-path --input +csdk update-node-at-path --input.clientMutationId --input.dbId --input.root --input.path --input.data --input.kids --input.ktree ``` diff --git a/skills/cli-public/references/user-auth-module.md b/skills/cli-public/references/user-auth-module.md index 5158eb060..0822abd1f 100644 --- a/skills/cli-public/references/user-auth-module.md +++ b/skills/cli-public/references/user-auth-module.md @@ -9,7 +9,7 @@ CRUD operations for UserAuthModule records via csdk CLI ```bash csdk user-auth-module list csdk user-auth-module get --id -csdk user-auth-module create --databaseId --schemaId --emailsTableId --usersTableId --secretsTableId --encryptedTableId --sessionsTableId --sessionCredentialsTableId --auditsTableId --auditsTableName --signInFunction --signUpFunction --signOutFunction --setPasswordFunction --resetPasswordFunction --forgotPasswordFunction --sendVerificationEmailFunction --verifyEmailFunction --verifyPasswordFunction --checkPasswordFunction --sendAccountDeletionEmailFunction --deleteAccountFunction --signInOneTimeTokenFunction --oneTimeTokenFunction --extendTokenExpires +csdk user-auth-module create --databaseId [--schemaId ] [--emailsTableId ] [--usersTableId ] [--secretsTableId ] [--encryptedTableId ] [--sessionsTableId ] [--sessionCredentialsTableId ] [--auditsTableId ] [--auditsTableName ] [--signInFunction ] [--signUpFunction ] [--signOutFunction ] [--setPasswordFunction ] [--resetPasswordFunction ] [--forgotPasswordFunction ] [--sendVerificationEmailFunction ] [--verifyEmailFunction ] [--verifyPasswordFunction ] [--checkPasswordFunction ] [--sendAccountDeletionEmailFunction ] [--deleteAccountFunction ] [--signInOneTimeTokenFunction ] [--oneTimeTokenFunction ] [--extendTokenExpires ] csdk user-auth-module update --id [--databaseId ] [--schemaId ] [--emailsTableId ] [--usersTableId ] [--secretsTableId ] [--encryptedTableId ] [--sessionsTableId ] [--sessionCredentialsTableId ] [--auditsTableId ] [--auditsTableName ] [--signInFunction ] [--signUpFunction ] [--signOutFunction ] [--setPasswordFunction ] [--resetPasswordFunction ] [--forgotPasswordFunction ] [--sendVerificationEmailFunction ] [--verifyEmailFunction ] [--verifyPasswordFunction ] [--checkPasswordFunction ] [--sendAccountDeletionEmailFunction ] [--deleteAccountFunction ] [--signInOneTimeTokenFunction ] [--oneTimeTokenFunction ] [--extendTokenExpires ] csdk user-auth-module delete --id ``` @@ -25,7 +25,7 @@ csdk user-auth-module list ### Create a userAuthModule ```bash -csdk user-auth-module create --databaseId "value" --schemaId "value" --emailsTableId "value" --usersTableId "value" --secretsTableId "value" --encryptedTableId "value" --sessionsTableId "value" --sessionCredentialsTableId "value" --auditsTableId "value" --auditsTableName "value" --signInFunction "value" --signUpFunction "value" --signOutFunction "value" --setPasswordFunction "value" --resetPasswordFunction "value" --forgotPasswordFunction "value" --sendVerificationEmailFunction "value" --verifyEmailFunction "value" --verifyPasswordFunction "value" --checkPasswordFunction "value" --sendAccountDeletionEmailFunction "value" --deleteAccountFunction "value" --signInOneTimeTokenFunction "value" --oneTimeTokenFunction "value" --extendTokenExpires "value" +csdk user-auth-module create --databaseId [--schemaId ] [--emailsTableId ] [--usersTableId ] [--secretsTableId ] [--encryptedTableId ] [--sessionsTableId ] [--sessionCredentialsTableId ] [--auditsTableId ] [--auditsTableName ] [--signInFunction ] [--signUpFunction ] [--signOutFunction ] [--setPasswordFunction ] [--resetPasswordFunction ] [--forgotPasswordFunction ] [--sendVerificationEmailFunction ] [--verifyEmailFunction ] [--verifyPasswordFunction ] [--checkPasswordFunction ] [--sendAccountDeletionEmailFunction ] [--deleteAccountFunction ] [--signInOneTimeTokenFunction ] [--oneTimeTokenFunction ] [--extendTokenExpires ] ``` ### Get a userAuthModule by id diff --git a/skills/cli-public/references/user.md b/skills/cli-public/references/user.md index e3d28ef47..69d26e25e 100644 --- a/skills/cli-public/references/user.md +++ b/skills/cli-public/references/user.md @@ -9,7 +9,7 @@ CRUD operations for User records via csdk CLI ```bash csdk user list csdk user get --id -csdk user create --username --displayName --profilePicture --searchTsv --type --searchTsvRank +csdk user create --searchTsvRank [--username ] [--displayName ] [--profilePicture ] [--searchTsv ] [--type ] csdk user update --id [--username ] [--displayName ] [--profilePicture ] [--searchTsv ] [--type ] [--searchTsvRank ] csdk user delete --id ``` @@ -25,7 +25,7 @@ csdk user list ### Create a user ```bash -csdk user create --username "value" --displayName "value" --profilePicture "value" --searchTsv "value" --type "value" --searchTsvRank "value" +csdk user create --searchTsvRank [--username ] [--displayName ] [--profilePicture ] [--searchTsv ] [--type ] ``` ### Get a user by id diff --git a/skills/cli-public/references/users-module.md b/skills/cli-public/references/users-module.md index 9e2947da4..ccf2d0700 100644 --- a/skills/cli-public/references/users-module.md +++ b/skills/cli-public/references/users-module.md @@ -9,7 +9,7 @@ CRUD operations for UsersModule records via csdk CLI ```bash csdk users-module list csdk users-module get --id -csdk users-module create --databaseId --schemaId --tableId --tableName --typeTableId --typeTableName +csdk users-module create --databaseId [--schemaId ] [--tableId ] [--tableName ] [--typeTableId ] [--typeTableName ] csdk users-module update --id [--databaseId ] [--schemaId ] [--tableId ] [--tableName ] [--typeTableId ] [--typeTableName ] csdk users-module delete --id ``` @@ -25,7 +25,7 @@ csdk users-module list ### Create a usersModule ```bash -csdk users-module create --databaseId "value" --schemaId "value" --tableId "value" --tableName "value" --typeTableId "value" --typeTableName "value" +csdk users-module create --databaseId [--schemaId ] [--tableId ] [--tableName ] [--typeTableId ] [--typeTableName ] ``` ### Get a usersModule by id diff --git a/skills/cli-public/references/uuid-module.md b/skills/cli-public/references/uuid-module.md index aa96eadab..8d0701ab5 100644 --- a/skills/cli-public/references/uuid-module.md +++ b/skills/cli-public/references/uuid-module.md @@ -9,7 +9,7 @@ CRUD operations for UuidModule records via csdk CLI ```bash csdk uuid-module list csdk uuid-module get --id -csdk uuid-module create --databaseId --schemaId --uuidFunction --uuidSeed +csdk uuid-module create --databaseId --uuidSeed [--schemaId ] [--uuidFunction ] csdk uuid-module update --id [--databaseId ] [--schemaId ] [--uuidFunction ] [--uuidSeed ] csdk uuid-module delete --id ``` @@ -25,7 +25,7 @@ csdk uuid-module list ### Create a uuidModule ```bash -csdk uuid-module create --databaseId "value" --schemaId "value" --uuidFunction "value" --uuidSeed "value" +csdk uuid-module create --databaseId --uuidSeed [--schemaId ] [--uuidFunction ] ``` ### Get a uuidModule by id diff --git a/skills/cli-public/references/verify-email.md b/skills/cli-public/references/verify-email.md index 4a2a6b0d0..1f9aa7a34 100644 --- a/skills/cli-public/references/verify-email.md +++ b/skills/cli-public/references/verify-email.md @@ -7,7 +7,7 @@ Execute the verifyEmail mutation ## Usage ```bash -csdk verify-email --input +csdk verify-email --input.clientMutationId --input.emailId --input.token ``` ## Examples @@ -15,5 +15,5 @@ csdk verify-email --input ### Run verifyEmail ```bash -csdk verify-email --input +csdk verify-email --input.clientMutationId --input.emailId --input.token ``` diff --git a/skills/cli-public/references/verify-password.md b/skills/cli-public/references/verify-password.md index fa857e719..565a73c82 100644 --- a/skills/cli-public/references/verify-password.md +++ b/skills/cli-public/references/verify-password.md @@ -7,7 +7,7 @@ Execute the verifyPassword mutation ## Usage ```bash -csdk verify-password --input +csdk verify-password --input.clientMutationId --input.password ``` ## Examples @@ -15,5 +15,5 @@ csdk verify-password --input ### Run verifyPassword ```bash -csdk verify-password --input +csdk verify-password --input.clientMutationId --input.password ``` diff --git a/skills/cli-public/references/verify-totp.md b/skills/cli-public/references/verify-totp.md index 04b4f30be..1bff74409 100644 --- a/skills/cli-public/references/verify-totp.md +++ b/skills/cli-public/references/verify-totp.md @@ -7,7 +7,7 @@ Execute the verifyTotp mutation ## Usage ```bash -csdk verify-totp --input +csdk verify-totp --input.clientMutationId --input.totpValue ``` ## Examples @@ -15,5 +15,5 @@ csdk verify-totp --input ### Run verifyTotp ```bash -csdk verify-totp --input +csdk verify-totp --input.clientMutationId --input.totpValue ``` diff --git a/skills/cli-public/references/view-grant.md b/skills/cli-public/references/view-grant.md index 4ba67b2bd..9b47574dd 100644 --- a/skills/cli-public/references/view-grant.md +++ b/skills/cli-public/references/view-grant.md @@ -9,7 +9,7 @@ CRUD operations for ViewGrant records via csdk CLI ```bash csdk view-grant list csdk view-grant get --id -csdk view-grant create --databaseId --viewId --granteeName --privilege --withGrantOption --isGrant +csdk view-grant create --viewId --granteeName --privilege [--databaseId ] [--withGrantOption ] [--isGrant ] csdk view-grant update --id [--databaseId ] [--viewId ] [--granteeName ] [--privilege ] [--withGrantOption ] [--isGrant ] csdk view-grant delete --id ``` @@ -25,7 +25,7 @@ csdk view-grant list ### Create a viewGrant ```bash -csdk view-grant create --databaseId "value" --viewId "value" --granteeName "value" --privilege "value" --withGrantOption "value" --isGrant "value" +csdk view-grant create --viewId --granteeName --privilege [--databaseId ] [--withGrantOption ] [--isGrant ] ``` ### Get a viewGrant by id diff --git a/skills/cli-public/references/view-rule.md b/skills/cli-public/references/view-rule.md index b090cf38b..709d08ec8 100644 --- a/skills/cli-public/references/view-rule.md +++ b/skills/cli-public/references/view-rule.md @@ -9,7 +9,7 @@ CRUD operations for ViewRule records via csdk CLI ```bash csdk view-rule list csdk view-rule get --id -csdk view-rule create --databaseId --viewId --name --event --action +csdk view-rule create --viewId --name --event [--databaseId ] [--action ] csdk view-rule update --id [--databaseId ] [--viewId ] [--name ] [--event ] [--action ] csdk view-rule delete --id ``` @@ -25,7 +25,7 @@ csdk view-rule list ### Create a viewRule ```bash -csdk view-rule create --databaseId "value" --viewId "value" --name "value" --event "value" --action "value" +csdk view-rule create --viewId --name --event [--databaseId ] [--action ] ``` ### Get a viewRule by id diff --git a/skills/cli-public/references/view-table.md b/skills/cli-public/references/view-table.md index 6e0e8c410..e94f0623b 100644 --- a/skills/cli-public/references/view-table.md +++ b/skills/cli-public/references/view-table.md @@ -9,7 +9,7 @@ CRUD operations for ViewTable records via csdk CLI ```bash csdk view-table list csdk view-table get --id -csdk view-table create --viewId --tableId --joinOrder +csdk view-table create --viewId --tableId [--joinOrder ] csdk view-table update --id [--viewId ] [--tableId ] [--joinOrder ] csdk view-table delete --id ``` @@ -25,7 +25,7 @@ csdk view-table list ### Create a viewTable ```bash -csdk view-table create --viewId "value" --tableId "value" --joinOrder "value" +csdk view-table create --viewId --tableId [--joinOrder ] ``` ### Get a viewTable by id diff --git a/skills/cli-public/references/view.md b/skills/cli-public/references/view.md index 09b53621d..ac0eb8965 100644 --- a/skills/cli-public/references/view.md +++ b/skills/cli-public/references/view.md @@ -9,7 +9,7 @@ CRUD operations for View records via csdk CLI ```bash csdk view list csdk view get --id -csdk view create --databaseId --schemaId --name --tableId --viewType --data --filterType --filterData --securityInvoker --isReadOnly --smartTags --category --module --scope --tags +csdk view create --schemaId --name --viewType [--databaseId ] [--tableId ] [--data ] [--filterType ] [--filterData ] [--securityInvoker ] [--isReadOnly ] [--smartTags ] [--category ] [--module ] [--scope ] [--tags ] csdk view update --id [--databaseId ] [--schemaId ] [--name ] [--tableId ] [--viewType ] [--data ] [--filterType ] [--filterData ] [--securityInvoker ] [--isReadOnly ] [--smartTags ] [--category ] [--module ] [--scope ] [--tags ] csdk view delete --id ``` @@ -25,7 +25,7 @@ csdk view list ### Create a view ```bash -csdk view create --databaseId "value" --schemaId "value" --name "value" --tableId "value" --viewType "value" --data "value" --filterType "value" --filterData "value" --securityInvoker "value" --isReadOnly "value" --smartTags "value" --category "value" --module "value" --scope "value" --tags "value" +csdk view create --schemaId --name --viewType [--databaseId ] [--tableId ] [--data ] [--filterType ] [--filterData ] [--securityInvoker ] [--isReadOnly ] [--smartTags ] [--category ] [--module ] [--scope ] [--tags ] ``` ### Get a view by id