Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
souvikghosh04 wants to merge 6 commits into
base: main
Choose a base branch
from
+18 −18
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
980937a
fix: align CLI HelpText defaults and descriptions with JSON schema
souvikghosh04 Apr 7, 2026
2d9dcd3
Merge branch 'main' into Usr/sogh/grp2-schema-cli-mismatch
souvikghosh04 Apr 8, 2026
1f4dd75
fix consistency in CLI and schema
souvikghosh04 Apr 8, 2026
1154fbc
Merge branch 'Usr/sogh/grp2-schema-cli-mismatch' of https://github.co…
souvikghosh04 Apr 8, 2026
d62cc29
Merge branch 'main' into Usr/sogh/grp2-schema-cli-mismatch
souvikghosh04 Apr 14, 2026
830751d
Address Copilot review: fix depth-limit range, host.mode casing, remo…
souvikghosh04 Apr 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions schemas/dab.draft.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,32 +299,32 @@
"describe-entities": {
Comment thread
souvikghosh04 marked this conversation as resolved.
"$ref": "#/$defs/boolean-or-string",
"description": "Enable/disable the describe-entities tool.",
"default": false
"default": true
},
"create-record": {
"$ref": "#/$defs/boolean-or-string",
"description": "Enable/disable the create-record tool.",
"default": false
"default": true
},
"read-records": {
"$ref": "#/$defs/boolean-or-string",
"description": "Enable/disable the read-records tool.",
"default": false
"default": true
},
"update-record": {
"$ref": "#/$defs/boolean-or-string",
"description": "Enable/disable the update-record tool.",
"default": false
"default": true
},
"delete-record": {
"$ref": "#/$defs/boolean-or-string",
"description": "Enable/disable the delete-record tool.",
"default": false
"default": true
},
"execute-entity": {
"$ref": "#/$defs/boolean-or-string",
"description": "Enable/disable the execute-entity tool.",
"default": false
"default": true
},
"aggregate-records": {
"description": "Enable/disable or configure the aggregate-records MCP tool.",
Expand Down Expand Up @@ -353,7 +353,7 @@
}
}
],
"default": false
"default": true
}
}
}
Expand Down
8 changes: 4 additions & 4 deletions src/Cli/Commands/AddTelemetryOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ public AddTelemetryOptions(
public string? AppInsightsConnString { get; }

// To specify whether Application Insights telemetry should be enabled. This flag is optional and default value is false.
[Option("app-insights-enabled", Default = CliBool.False, Required = false, HelpText = "(Default: false) Enable/Disable Application Insights")]
[Option("app-insights-enabled", Default = CliBool.False, Required = false, HelpText = "Enable/Disable Application Insights.")]
public CliBool? AppInsightsEnabled { get; }

// Connection string for the Open Telemetry resource to which telemetry data should be sent.
Expand All @@ -53,19 +53,19 @@ public AddTelemetryOptions(
public string? OpenTelemetryEndpoint { get; }

// To specify whether Open Telemetry telemetry should be enabled. This flag is optional and default value is false.
[Option("otel-enabled", Default = CliBool.False, Required = false, HelpText = "(Default: false) Enable/Disable OTEL")]
[Option("otel-enabled", Default = CliBool.False, Required = false, HelpText = "Enable/Disable OTEL.")]
public CliBool? OpenTelemetryEnabled { get; }

// Headers for the Open Telemetry resource to which telemetry data should be sent.
[Option("otel-headers", Required = false, HelpText = "Headers for Open Telemetry for telemetry data")]
public string? OpenTelemetryHeaders { get; }

// Specify the Open Telemetry protocol. This flag is optional and default value is grpc.
[Option("otel-protocol", Default = OtlpExportProtocol.Grpc, Required = false, HelpText = "(Default: grpc) Accepted: grpc/httpprotobuf")]
[Option("otel-protocol", Default = OtlpExportProtocol.Grpc, Required = false, HelpText = "Accepted: grpc, httpprotobuf.")]
public OtlpExportProtocol? OpenTelemetryExportProtocol { get; }

// Service Name for the Open Telemetry resource to which telemetry data should be sent. This flag is optional and default value is dab.
[Option("otel-service-name", Default = "dab", Required = false, HelpText = "(Default: dab) Headers for Open Telemetry for telemetry data")]
[Option("otel-service-name", Default = "dab", Required = false, HelpText = "Service name for Open Telemetry.")]
public string? OpenTelemetryServiceName { get; }

public int Handler(ILogger logger, FileSystemRuntimeConfigLoader loader, IFileSystem fileSystem)
Expand Down
10 changes: 5 additions & 5 deletions src/Cli/Commands/ConfigureOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ public ConfigureOptions(
ShowEffectivePermissions = showEffectivePermissions;
}

[Option("data-source.database-type", Required = false, HelpText = "Database type. Allowed values: MSSQL, PostgreSQL, CosmosDB_NoSQL, MySQL.")]
[Option("data-source.database-type", Required = false, HelpText = "Database type. Allowed values: mssql, postgresql, cosmosdb_nosql, cosmosdb_postgresql, mysql.")]
public string? DataSourceDatabaseType { get; }

[Option("data-source.connection-string", Required = false, HelpText = "Connection string for the data source.")]
Expand All @@ -164,7 +164,7 @@ public ConfigureOptions(
[Option("data-source.options.schema", Required = false, HelpText = "Schema path for Cosmos DB for NoSql.")]
public string? DataSourceOptionsSchema { get; }

[Option("data-source.options.set-session-context", Required = false, HelpText = "Enable session context. Allowed values: true (default), false.")]
[Option("data-source.options.set-session-context", Required = false, HelpText = "Enable session context. Allowed values: true, false.")]
public bool? DataSourceOptionsSetSessionContext { get; }

[Option("data-source.health.name", Required = false, HelpText = "Identifier for data source in health check report.")]
Expand All @@ -176,7 +176,7 @@ public ConfigureOptions(
[Option("data-source.user-delegated-auth.database-audience", Required = false, HelpText = "Database resource identifier for token acquisition (e.g., https://database.windows.net for Azure SQL).")]
public string? DataSourceUserDelegatedAuthDatabaseAudience { get; }

[Option("runtime.graphql.depth-limit", Required = false, HelpText = "Max allowed depth of the nested query. Allowed values: (0,2147483647] inclusive. Default is infinity. Use -1 to remove limit.")]
[Option("runtime.graphql.depth-limit", Required = false, HelpText = "Max allowed depth of a nested query. Allowed values: -1 (no limit) or 1..2147483647. Default: null (no limit).")]
Copy link
Copy Markdown
Contributor

@RubenCerna2079 RubenCerna2079 Apr 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not following why we say default is null if the value for no limit is -1

public int? DepthLimit { get; }

[Option("runtime.graphql.enabled", Required = false, HelpText = "Enable DAB's GraphQL endpoint. Default: true (boolean).")]
Expand All @@ -188,7 +188,7 @@ public ConfigureOptions(
[Option("runtime.graphql.allow-introspection", Required = false, HelpText = "Allow/Deny GraphQL introspection requests in GraphQL Schema. Default: true (boolean).")]
public bool? RuntimeGraphQLAllowIntrospection { get; }

[Option("runtime.graphql.multiple-mutations.create.enabled", Required = false, HelpText = "Enable/Disable multiple-mutation create operations on DAB's generated GraphQL schema. Default: true (boolean).")]
[Option("runtime.graphql.multiple-mutations.create.enabled", Required = false, HelpText = "Enable/Disable multiple-mutation create operations on DAB's generated GraphQL schema. Default: false (boolean).")]
Copy link
Copy Markdown
Contributor

@RubenCerna2079 RubenCerna2079 Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see some places where we still write the default value in the HelpText but we change it in others so that it is in the Default parameter. I think all of them should be in one place for consistency.

public bool? RuntimeGraphQLMultipleMutationsCreateEnabled { get; }

[Option("runtime.rest.enabled", Required = false, HelpText = "Enable DAB's Rest endpoint. Default: true (boolean).")]
Expand Down Expand Up @@ -245,7 +245,7 @@ public ConfigureOptions(
[Option("runtime.compression.level", Required = false, HelpText = "Set the response compression level. Allowed values: optimal (default), fastest, none.")]
public CompressionLevel? RuntimeCompressionLevel { get; }

[Option("runtime.host.mode", Required = false, HelpText = "Set the host running mode of DAB in Development or Production. Default: Development.")]
[Option("runtime.host.mode", Required = false, HelpText = "Set the host running mode of DAB in Development or Production. Default: Production.")]
Copy link
Copy Markdown
Contributor

@RubenCerna2079 RubenCerna2079 Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as previous comment

public HostMode? RuntimeHostMode { get; }

[Option("runtime.host.cors.origins", Required = false, HelpText = "Overwrite Allowed Origins in CORS. Default: [] (Space separated array of strings).")]
Expand Down
4 changes: 2 additions & 2 deletions src/Cli/Commands/InitOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ public InitOptions(
McpAggregateRecordsQueryTimeout = mcpAggregateRecordsQueryTimeout;
}

[Option("database-type", Required = true, HelpText = "Type of database to connect. Supported values: mssql, cosmosdb_nosql, cosmosdb_postgresql, mysql, postgresql, dwsql")]
[Option("database-type", Required = true, HelpText = "Type of database to connect. Supported values: mssql, cosmosdb_nosql, cosmosdb_postgresql, mysql, postgresql")]
Copy link
Copy Markdown
Contributor

@RubenCerna2079 RubenCerna2079 Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am confused as to why we need to remove this type if in the documentation it says that we support it. And I thought we already supported this. Maybe I am just not aware of how this type is used.
https://learn.microsoft.com/en-us/azure/data-api-builder/configuration/data-source#data-source-1:~:text=2016-,dwsql,-Azure%20Synapse%20Analytics

public DatabaseType DatabaseType { get; }

[Option("connection-string", Required = false, HelpText = "(Default: '') Connection details to connect to the database.")]
Expand Down Expand Up @@ -136,7 +136,7 @@ public InitOptions(
public CliBool McpEnabled { get; }

// When true, DAB rejects extraneous/unmapped fields in the REST request body (strict mode). When false, extraneous fields are allowed and ignored.
[Option("rest.request-body-strict", Required = false, HelpText = "(Default: false) When true, rejects extraneous/unmapped fields in the REST request body. When false, allows and ignores them.")]
[Option("rest.request-body-strict", Required = false, HelpText = "When true, rejects extraneous/unmapped fields in the REST request body. When false, allows and ignores them.")]
Copy link
Copy Markdown
Contributor

@RubenCerna2079 RubenCerna2079 Apr 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this default to anything specifically?

public CliBool RestRequestBodyStrict { get; }

[Option("graphql.multiple-mutations.create.enabled", Required = false, HelpText = "(Default: false) Enables multiple create operation for GraphQL. Supported values: true, false.")]
Expand Down