fix: align CLI HelpText defaults and descriptions with JSON schema (Group 2)#3417
Open
souvikghosh04 wants to merge 6 commits intomainfrom
Open
fix: align CLI HelpText defaults and descriptions with JSON schema (Group 2)#3417souvikghosh04 wants to merge 6 commits intomainfrom
souvikghosh04 wants to merge 6 commits intomainfrom
Conversation
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)
19 tasks
19 tasks
…m/Azure/data-api-builder into Usr/sogh/grp2-schema-cli-mismatch
souvikghosh04
requested review from
Aniruddh25,
JerryNixon,
RubenCerna2079,
aaronburtle,
anushakolan and
sourabh1007
as code owners
souvikghosh04
requested review from
Alekhya-Polavarapu,
rusamant,
stuartpa and
vadeveka
as code owners
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Aligns CLI --help output with the JSON schema and runtime defaults by correcting default values, descriptions, and enum/value lists.
Changes:
- Updated CLI option HelpText defaults/descriptions for
init,configure, andadd-telemetrycommands. - Corrected allowed/enum value lists (notably database type values/casing).
- Updated JSON schema defaults for MCP DML tools to reflect runtime behavior.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| src/Cli/Commands/InitOptions.cs | Adjusts --database-type supported values list and updates HelpText default for rest.request-body-strict. |
| src/Cli/Commands/ConfigureOptions.cs | Fixes HelpText for database type values/casing, removes misleading default text, and corrects GraphQL/host-mode defaults/description. |
| src/Cli/Commands/AddTelemetryOptions.cs | Removes duplicated default text (when Default= is present) and fixes OTEL service-name description. |
| schemas/dab.draft.schema.json | Changes MCP DML tool defaults to true to match runtime defaults. |
…ve hardcoded default, clarify otel-protocol - depth-limit: clarify allowed values as '-1 (no limit) or 1..2147483647' instead of contradictory range + -1 instruction - host.mode: use 'Default: Production' (title-case) to match the enum values shown in the same HelpText - rest.request-body-strict: remove hardcoded '(Default: true)' from HelpText since no Default= attribute is set on the option - otel-protocol: use 'grpc, httpprotobuf' instead of 'grpc/httpprotobuf' to avoid reading as a single token
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes 14 issues where CLI option
--helptext 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)
runtime.mcp.dml-tools.read-recordsruntime.mcp.dml-tools.create-recordruntime.mcp.dml-tools.describe-entitiesruntime.graphql.multiple-mutations.create.enabledruntime.host.modedata-source.options.set-session-contextruntime.rest.request-body-strictruntime.mcp.dml-tools.aggregate-records2b. Description/Display Bugs (3 issues)
--otel-service-namedab add-telemetryoptions(Default: X)from HelpText whereDefault=attribute already displays the valueruntime.graphql.depth-limit2c. Enum Mismatches (3 issues)
--database-type(init)dwsqlnot in schema--database-type(configure)--database-type(configure)Cross-group overlaps resolved
rest.request-body-strict) ? same fix as [Bug]: Schema/Cli mismatch runtime.rest.request-body-strict #3353host.mode) ? same fix as [Bug]: Schema/Cli mismatch runtime.host.mode #3351set-session-context) ? same fix as [Bug]: Schema/Cli mismatch data-source.options.set-session-context #3352multiple-mutations.create.enabled) ? same fix as [Bug]: Schema/Cli mismatch runtime.graphql.multiple-mutations.create.enabled #3350trueto match C# runtimeFiles Changed
src/Cli/Commands/ConfigureOptions.cssrc/Cli/Commands/InitOptions.cssrc/Cli/Commands/AddTelemetryOptions.csschemas/dab.draft.schema.jsonDmlToolsConfig.DEFAULT_ENABLED = true)Testing