Skip to content

feat: dab init defaults runtime.rest.request-body-strict to false #3166

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
Copilot wants to merge 3 commits into
base: main
Choose a base branch
from
+43 −43
Open

feat: dab init defaults runtime.rest.request-body-strict to false #3166

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fcb8b66
Initial plan
Copilot Feb 25, 2026
d9fe4f0
feat: change dab init default for request-body-strict to false
Copilot Feb 25, 2026
4ecd02f
Merge branch 'main' into copilot/update-dab-init-defaults
JerryNixon Feb 26, 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
2 changes: 1 addition & 1 deletion src/Cli.Tests/ConfigGeneratorTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ public void TestSpecialCharactersInConnectionString()
""rest"": {
""enabled"": true,
""path"": ""/api"",
""request-body-strict"": true
""request-body-strict"": false
},
""graphql"": {
""enabled"": true,
Expand Down
2 changes: 1 addition & 1 deletion src/Cli.Tests/EndToEndTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1223,7 +1223,7 @@ public void TestEnabledDisabledFlagsForApis(
[DataTestMethod]
[DataRow(true, false, DisplayName = "dab init command specifies --rest.request-body-strict as false - REST request body allows extraneous fields.")]
[DataRow(true, true, DisplayName = "dab init command specifies --rest.request-body-strict as true - REST request body doesn't allow extraneous fields.")]
[DataRow(false, true, DisplayName = "dab init command does not include --rest.request-body-strict flag. The default behavior is followed - REST request body doesn't allow extraneous fields.")]
[DataRow(false, false, DisplayName = "dab init command does not include --rest.request-body-strict flag. The default behavior is followed - REST request body allows extraneous fields.")]
public void TestRestRequestBodyStrictMode(bool includeRestRequestBodyStrictFlag, bool isRequestBodyStrict)
{
string[] initArgs = { "init", "-c", TEST_RUNTIME_CONFIG_FILE, "--host-mode", "development", "--database-type", "mssql",
Expand Down
2 changes: 1 addition & 1 deletion ...s/EndToEndTests.TestAddingStoredProcedureWithRestMethodsAndGraphQLOperations.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
Rest: {
Enabled: true,
Path: /api,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion ...ndToEndTests.TestConfigGeneratedAfterAddingEntityWithSourceAsStoredProcedure.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
Rest: {
Enabled: true,
Path: /api,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion .../EndToEndTests.TestConfigGeneratedAfterAddingEntityWithSourceWithDefaultType.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
Rest: {
Enabled: true,
Path: /api,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion ...pshots/EndToEndTests.TestConfigGeneratedAfterAddingEntityWithoutIEnumerables.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
Rest: {
Enabled: true,
Path: /api,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion src/Cli.Tests/Snapshots/EndToEndTests.TestInitForCosmosDBNoSql.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
Rest: {
Enabled: false,
Path: /api,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion ...Cli.Tests/Snapshots/EndToEndTests.TestUpdatingStoredProcedureWithRestMethods.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
Rest: {
Enabled: true,
Path: /api,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion ...EndToEndTests.TestUpdatingStoredProcedureWithRestMethodsAndGraphQLOperations.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
Rest: {
Enabled: true,
Path: /api,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion src/Cli.Tests/Snapshots/InitTests.CosmosDbNoSqlDatabase.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
Rest: {
Enabled: false,
Path: /api,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion src/Cli.Tests/Snapshots/InitTests.CosmosDbPostgreSqlDatabase.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
Rest: {
Enabled: true,
Path: /rest-endpoint,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion ...CorrectConfigGenerationWithDifferentAuthenticationProviders_171ea8114ff71814.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
Rest: {
Enabled: true,
Path: /api,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion ...CorrectConfigGenerationWithDifferentAuthenticationProviders_2df7a1794712f154.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
Rest: {
Enabled: true,
Path: /api,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion ...CorrectConfigGenerationWithDifferentAuthenticationProviders_59fe1a10aa78899d.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
Rest: {
Enabled: true,
Path: /api,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion ...CorrectConfigGenerationWithDifferentAuthenticationProviders_b95b637ea87f16a7.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
Rest: {
Enabled: true,
Path: /api,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion ...CorrectConfigGenerationWithDifferentAuthenticationProviders_daacbd948b7ef72f.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
Rest: {
Enabled: true,
Path: /api,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion ...Cli.Tests/Snapshots/InitTests.GraphQLPathWithoutStartingSlashWillHaveItAdded.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
Rest: {
Enabled: true,
Path: /api,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion src/Cli.Tests/Snapshots/InitTests.MsSQLDatabase.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
Rest: {
Enabled: true,
Path: /rest-api,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion src/Cli.Tests/Snapshots/InitTests.RestPathWithoutStartingSlashWillHaveItAdded.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
Rest: {
Enabled: true,
Path: /abc,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion src/Cli.Tests/Snapshots/InitTests.TestInitializingConfigWithoutConnectionString.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
Rest: {
Enabled: true,
Path: /api,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion src/Cli.Tests/Snapshots/InitTests.TestSpecialCharactersInConnectionString.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
Rest: {
Enabled: true,
Path: /api,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion ...ts.VerifyCorrectConfigGenerationWithMultipleMutationOptions_0546bef37027a950.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
Rest: {
Enabled: true,
Path: /rest-api,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion ...ts.VerifyCorrectConfigGenerationWithMultipleMutationOptions_0ac567dd32a2e8f5.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
Rest: {
Enabled: true,
Path: /rest-api,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion ...ts.VerifyCorrectConfigGenerationWithMultipleMutationOptions_0c06949221514e77.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
Rest: {
Enabled: true,
Path: /rest-api,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion ...ts.VerifyCorrectConfigGenerationWithMultipleMutationOptions_18667ab7db033e9d.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
Rest: {
Enabled: true,
Path: /rest-api,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion ...ts.VerifyCorrectConfigGenerationWithMultipleMutationOptions_2f42f44c328eb020.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
Rest: {
Enabled: true,
Path: /rest-api,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion ...ts.VerifyCorrectConfigGenerationWithMultipleMutationOptions_3243d3f3441fdcc1.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
Rest: {
Enabled: true,
Path: /rest-api,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion ...ts.VerifyCorrectConfigGenerationWithMultipleMutationOptions_53350b8b47df2112.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
Rest: {
Enabled: true,
Path: /rest-api,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion ...ts.VerifyCorrectConfigGenerationWithMultipleMutationOptions_6584e0ec46b8a11d.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
Rest: {
Enabled: false,
Path: /api,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion ...ts.VerifyCorrectConfigGenerationWithMultipleMutationOptions_81cc88db3d4eecfb.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
Rest: {
Enabled: true,
Path: /rest-api,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion ...ts.VerifyCorrectConfigGenerationWithMultipleMutationOptions_8ea187616dbb5577.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
Rest: {
Enabled: true,
Path: /rest-api,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion ...ts.VerifyCorrectConfigGenerationWithMultipleMutationOptions_905845c29560a3ef.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
Rest: {
Enabled: true,
Path: /rest-api,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion ...ts.VerifyCorrectConfigGenerationWithMultipleMutationOptions_b2fd24fab5b80917.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
Rest: {
Enabled: false,
Path: /api,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion ...ts.VerifyCorrectConfigGenerationWithMultipleMutationOptions_bd7cd088755287c9.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
Rest: {
Enabled: false,
Path: /api,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion ...ts.VerifyCorrectConfigGenerationWithMultipleMutationOptions_d2eccba2f836b380.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
Rest: {
Enabled: true,
Path: /rest-api,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion ...ts.VerifyCorrectConfigGenerationWithMultipleMutationOptions_d463eed7fe5e4bbe.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
Rest: {
Enabled: true,
Path: /rest-api,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion ...ts.VerifyCorrectConfigGenerationWithMultipleMutationOptions_d5520dd5c33f7b8d.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
Rest: {
Enabled: true,
Path: /rest-api,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion ...ts.VerifyCorrectConfigGenerationWithMultipleMutationOptions_eab4a6010e602b59.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
Rest: {
Enabled: true,
Path: /rest-api,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion ...ts.VerifyCorrectConfigGenerationWithMultipleMutationOptions_ecaa688829b4030e.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
Rest: {
Enabled: true,
Path: /rest-api,
RequestBodyStrict: true
RequestBodyStrict: false
},
GraphQL: {
Enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion src/Cli/Commands/InitOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ public InitOptions(

// Since the rest.request-body-strict option does not have a default value, it is required to specify a value for this option if it is
// included in the init command.
[Option("rest.request-body-strict", Required = false, HelpText = "(Default: true) Allow extraneous fields in the request body for REST.")]
[Option("rest.request-body-strict", Required = false, HelpText = "(Default: false) Allow extraneous fields in the request body for REST.")]
public CliBool RestRequestBodyStrict { get; }
Comment on lines 136 to 139
Copy link

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

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

The CLI help text for --rest.request-body-strict is misleading given the option name/behavior: when request-body-strict is true, DAB rejects unexpected/extraneous fields (strict mode), and when false it allows them. Consider updating the HelpText (and the preceding comment) to explicitly describe the true/false semantics so users don’t interpret it as "allow" when set to true.

Copilot uses AI. Check for mistakes.

[Option("graphql.multiple-create.enabled", Required = false, HelpText = "(Default: false) Enables multiple create operation for GraphQL. Supported values: true, false.")]
Expand Down
2 changes: 1 addition & 1 deletion src/Cli/ConfigGenerator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@ public static bool TryCreateRuntimeConfig(InitOptions options, FileSystemRuntime
Schema: dabSchemaLink,
DataSource: dataSource,
Runtime: new(
Rest: new(restEnabled, restPath ?? RestRuntimeOptions.DEFAULT_PATH, options.RestRequestBodyStrict is CliBool.False ? false : true),
Rest: new(restEnabled, restPath ?? RestRuntimeOptions.DEFAULT_PATH, options.RestRequestBodyStrict is CliBool.True ? true : false),
GraphQL: new(Enabled: graphQLEnabled, Path: graphQLPath, MultipleMutationOptions: multipleMutationOptions),
Mcp: new(mcpEnabled, mcpPath ?? McpRuntimeOptions.DEFAULT_PATH),
Host: new(
Expand Down
4 changes: 2 additions & 2 deletions src/Config/ObjectModel/RestRuntimeOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ namespace Azure.DataApiBuilder.Config.ObjectModel;
/// <param name="Path">The URL prefix path at which endpoints
/// for all entities will be exposed.</param>
/// <param name="RequestBodyStrict">Boolean property indicating whether extraneous fields are allowed in request body.
/// The default value is true - meaning we don't allow extraneous fields by default in the rest request body.
/// Changing the default value is a breaking change.</param>
/// The default value for existing configs (without this property set) is true - meaning we don't allow extraneous fields by default.
/// When dab init generates a new config, the default is false - allowing extraneous fields by default for a smoother development experience.</param>
Comment on lines 12 to +14
Copy link

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

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

The RequestBodyStrict XML doc is internally inconsistent: it says the property indicates whether extraneous fields are allowed, but then describes true as "we don't allow extraneous fields". Please reword to reflect the actual behavior (e.g., strict=true rejects extraneous/unmapped fields; strict=false ignores them) to avoid confusing readers and downstream doc generation.

Copilot uses AI. Check for mistakes.
public record RestRuntimeOptions(bool Enabled = true, string Path = RestRuntimeOptions.DEFAULT_PATH, bool RequestBodyStrict = true)
{
public const string DEFAULT_PATH = "/api";
Expand Down