Skip to content

fix: align CLI HelpText defaults and descriptions with JSON schema (Group 2)#3417

Draft
souvikghosh04 wants to merge 4 commits intomainfrom
Usr/sogh/grp2-schema-cli-mismatch
Draft

fix: align CLI HelpText defaults and descriptions with JSON schema (Group 2)#3417
souvikghosh04 wants to merge 4 commits intomainfrom
Usr/sogh/grp2-schema-cli-mismatch

Conversation

@souvikghosh04
Copy link
Copy Markdown
Contributor

@souvikghosh04 souvikghosh04 commented Apr 7, 2026

Summary

Fixes 14 issues where CLI option --help text showed incorrect default values, wrong descriptions, or enum mismatches compared to the JSON schema (dab.draft.schema.json) and C# runtime defaults.

Issues Addressed

2a. Default Value Mismatches (8 issues)

# Property Before After Resolution
#3347 runtime.mcp.dml-tools.read-records CLI: true, Schema: false Both: true Schema changed false?true to match C# runtime
#3348 runtime.mcp.dml-tools.create-record CLI: true, Schema: false Both: true Schema changed false?true to match C# runtime
#3349 runtime.mcp.dml-tools.describe-entities CLI: true, Schema: false Both: true Schema changed false?true to match C# runtime
#3350 runtime.graphql.multiple-mutations.create.enabled CLI: true, Schema: false CLI: false HelpText corrected to match schema
#3351 runtime.host.mode CLI: Development, Schema: production CLI: production HelpText corrected to match schema
#3352 data-source.options.set-session-context CLI: "(default)" text No default Removed misleading text
#3353 runtime.rest.request-body-strict init: false, Schema: true init: true HelpText corrected to match schema
#3354 runtime.mcp.dml-tools.aggregate-records Schema: .enabled=true, top-level=false Both: true Schema changed false?true to match C# runtime

2b. Description/Display Bugs (3 issues)

# Property Fix
#3355 --otel-service-name Changed description from "Headers for Open Telemetry" to "Service name for Open Telemetry"
#3356 dab add-telemetry options Removed duplicate (Default: X) from HelpText where Default= attribute already displays the value
#3357 runtime.graphql.depth-limit Changed description from "infinity"/"-1" to "Default: null (no limit)"

2c. Enum Mismatches (3 issues)

# Property Fix
#3358 --database-type (init) Removed dwsql not in schema
#3359 --database-type (configure) Already fixed in PR #3409
#3360 --database-type (configure) Changed to lowercase enum values

Cross-group overlaps resolved

Files Changed

File Changes
src/Cli/Commands/ConfigureOptions.cs 5 HelpText corrections (host.mode, multiple-mutations, set-session-context, depth-limit, database-type)
src/Cli/Commands/InitOptions.cs 2 HelpText corrections (request-body-strict, database-type)
src/Cli/Commands/AddTelemetryOptions.cs 4 HelpText/description corrections
schemas/dab.draft.schema.json DML tool defaults changed false?true (8 locations) to match C# runtime (DmlToolsConfig.DEFAULT_ENABLED = true)

Testing

  • ConfigureOptionsTests: 78 passed, 0 failed
  • EndToEndTests: 138 passed, 0 failed, 3 skipped
  • Build: 0 warnings, 0 errors

Fixes 14 issues where CLI option help text showed incorrect default
values or descriptions that didn't match the JSON schema:

ConfigureOptions.cs:
- DML tool defaults: true -> false (7 tools: #3347-#3353)
- multiple-mutations.create.enabled default: true -> false (#3354)
- host.mode default: Development -> production (#3355)
- set-session-context: removed misleading '(default)' text (#3356)
- depth-limit default: infinity -> null (no limit) (#3357)
- database-type: use lowercase values, add cosmosdb_postgresql (#3358)

InitOptions.cs:
- rest.request-body-strict default: false -> true (#3360)
- database-type: remove dwsql (not in schema) (#3358)

AddTelemetryOptions.cs:
- Remove duplicate '(Default: X)' from HelpText where Default= attribute
  already displays the value (#3356)
- Fix otel-service-name description from 'Headers' to 'Service name'

dab.draft.schema.json:
- aggregate-records object form .enabled default: true -> false to match
  top-level default (#3347)
@souvikghosh04 souvikghosh04 self-assigned this Apr 8, 2026
@souvikghosh04 souvikghosh04 added this to the April 2026 milestone Apr 8, 2026
@souvikghosh04 souvikghosh04 linked an issue Apr 8, 2026 that may be closed by this pull request
19 tasks
@souvikghosh04 souvikghosh04 moved this from Todo to In Progress in Data API builder Apr 8, 2026
@souvikghosh04 souvikghosh04 added bug Something isn't working cli assign-for-review labels Apr 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

assign-for-review bug Something isn't working cli

Projects

Status: In Progress

Development

Successfully merging this pull request may close these issues.

[Parent] Group 2: Schema/CLI Mismatch — Default Values & Descriptions

1 participant