Allow multi-segment runtime REST/GraphQL paths (e.g. /api/v2) by Copilot · Pull Request #3684 · Azure/data-api-builder

Copilot · 2026-06-26T08:07:39Z

Why make this change?

Closes [Bug]: dab configure --runtime.rest.path rejects multi-segment paths #3336
dab configure --runtime.rest.path "/api/v2" (and the GraphQL equivalent) failed with contains one or more reserved characters. The path validator stripped the leading / and then rejected the whole remainder using a regex where / is itself reserved, so any multi-segment path was rejected even though routing supports them.

What is this change?

Segment-aware validation: Added RuntimeConfigValidatorUtil.DoesUriPathContainReservedChars, which splits the path (after the leading /) into /-separated segments and validates each one. / is now permitted as a separator; empty segments (leading/consecutive/trailing slashes) and reserved characters are still rejected. The root path / stays valid.
Shared validator updated: TryValidateUriComponent now uses the helper, so REST, GraphQL, MCP, and base-route all accept multi-segment paths while preserving existing error messages for genuinely invalid input.
CLI parity: IsURIComponentValid (used by dab init) now uses the same segment-aware check.
Tests: Updated existing E2E rows that asserted multi-segment paths fail; added positive /api/v2 cases and empty-segment/trailing-slash failure cases across configure, init, and config-validation tests.

How was this tested?

Integration Tests
Unit Tests

Sample Request(s)

# Previously rejected, now accepted
dab configure --runtime.rest.path "/api/v2" --config test.json
dab configure --runtime.graphql.path "/api/v2" --config test.json

# Still rejected
dab configure --runtime.rest.path "/api//v2"  --config test.json   # empty segment
dab configure --runtime.rest.path "/api/"      --config test.json   # trailing slash

Copilot

Pull request overview

This pull request fixes runtime path validation so multi-segment REST/GraphQL paths (e.g. /api/v2) are accepted while still rejecting empty segments and reserved characters, aligning CLI behavior (dab configure, dab init) with runtime routing capabilities.

Changes:

Added segment-aware runtime path validation (DoesUriPathContainReservedChars) and wired it into TryValidateUriComponent.
Updated CLI validation (IsURIComponentValid) to use the same segment-aware check for parity.
Updated/added tests to cover multi-segment success cases and empty-segment/trailing-slash failure cases.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
src/Core/Configurations/RuntimeConfigValidatorUtil.cs	Implements segment-aware runtime path validation and updates shared runtime validation to allow `/` as a segment separator.
src/Cli/Utils.cs	Aligns CLI URI component validation with the new segment-aware runtime validator.
src/Service.Tests/UnitTests/ConfigValidationUnitTests.cs	Adds positive and negative unit test cases for multi-segment runtime paths and empty-segment/trailing-slash scenarios.
src/Cli.Tests/EndToEndTests.cs	Updates E2E CLI tests to validate multi-segment paths succeed and empty segments fail.
src/Cli.Tests/ConfigureOptionsTests.cs	Adds configure-option test coverage for multi-segment REST paths.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

RubenCerna2079

LGTM! Approved assuming comments will be addressed.

RubenCerna2079 · 2026-06-30T19:53:49Z

    [DataRow("/updatedPath", true, DisplayName = "Success in updated GraphQL Path to /updatedPath.")]
    [DataRow("/updated-Path", true, DisplayName = "Success in updated GraphQL Path to /updated-Path.")]
    [DataRow("/updated_Path", true, DisplayName = "Success in updated GraphQL Path to /updated_Path.")]
+    [DataRow("/api/v2", true, DisplayName = "Success in updated GraphQL Path to multi-segment path /api/v2.")]


nit: Think it would be better to use a different name than api since that is the default we use for REST paths. I think it is better to use graphql

RubenCerna2079 · 2026-06-30T19:55:13Z

    [DataRow("/updated.Path", false, DisplayName = "Failure due to reserved char '.'.")]
    [DataRow("/updated@Path", false, DisplayName = "Failure due reserved chars '@'.")]
-    [DataRow("/updated/Path", false, DisplayName = "Failure due reserved chars '/'.")]
+    [DataRow("/api//v2", false, DisplayName = "Failure due to empty path segment.")]


Same as previous comment

RubenCerna2079 · 2026-06-30T19:55:32Z

            DisplayName = "REST path containing only a forward slash.")]
+        [DataRow("/api/v2", null, ApiType.REST, false,
+            DisplayName = "REST path containing multiple segments.")]
+        [DataRow("/api/v2", null, ApiType.GraphQL, false,


Same as previous comment

Initial plan

b1ca3f3

Copilot AI assigned Copilot and souvikghosh04 Jun 26, 2026

Copilot started work on behalf of souvikghosh04 June 26, 2026 08:07 View session

Copilot AI linked an issue Jun 26, 2026 that may be closed by this pull request

[Bug]: dab configure --runtime.rest.path rejects multi-segment paths #3336

Open

Allow multi-segment runtime REST/GraphQL paths in validation

6d54ddc

Copilot AI changed the title ~~[WIP] Fix dab configure to accept multi-segment rest paths~~ Allow multi-segment runtime REST/GraphQL paths (e.g. /api/v2) Jun 26, 2026

Copilot finished work on behalf of souvikghosh04 June 26, 2026 08:23

Copilot AI requested a review from souvikghosh04 June 26, 2026 08:24

souvikghosh04 added this to Data API builder Jun 26, 2026

github-project-automation Bot moved this to Todo in Data API builder Jun 26, 2026

souvikghosh04 added the 2.1 label Jun 26, 2026

souvikghosh04 moved this from Todo to In Progress in Data API builder Jun 26, 2026

souvikghosh04 marked this pull request as ready for review June 26, 2026 09:57

Copilot AI review requested due to automatic review settings June 26, 2026 09:57

souvikghosh04 requested review from Alekhya-Polavarapu, Aniruddh25, JerryNixon, RubenCerna2079, aaronburtle, anushakolan, rusamant, sourabh1007, stuartpa and vadeveka as code owners June 26, 2026 09:57

souvikghosh04 added the assign-for-review label Jun 26, 2026

souvikghosh04 moved this from In Progress to Review In Progress in Data API builder Jun 26, 2026

Copilot started reviewing on behalf of souvikghosh04 June 26, 2026 10:00 View session

souvikghosh04 added assign-for-review and removed assign-for-review labels Jun 26, 2026

souvikghosh04 moved this from Review In Progress to In Progress in Data API builder Jun 26, 2026

souvikghosh04 added this to the June 2026 milestone Jun 26, 2026

github-actions Bot assigned Aniruddh25 Jun 26, 2026

github-actions Bot removed the assign-for-review label Jun 26, 2026

souvikghosh04 unassigned Aniruddh25 Jun 26, 2026

souvikghosh04 marked this pull request as draft June 26, 2026 10:01

Copilot AI reviewed Jun 26, 2026

View reviewed changes

Comment thread src/Core/Configurations/RuntimeConfigValidatorUtil.cs

github-actions Bot assigned RubenCerna2079 Jun 26, 2026

souvikghosh04 marked this pull request as ready for review June 29, 2026 08:04

souvikghosh04 unassigned RubenCerna2079 and souvikghosh04 Jun 29, 2026

souvikghosh04 moved this from In Progress to Review In Progress in Data API builder Jun 29, 2026

souvikghosh04 added the assign-for-review label Jun 29, 2026

github-actions Bot assigned Aniruddh25 and souvikghosh04 Jun 29, 2026

github-actions Bot removed the assign-for-review label Jun 29, 2026

RubenCerna2079 assigned RubenCerna2079 and unassigned souvikghosh04 Jun 29, 2026

souvikghosh04 and others added 2 commits June 30, 2026 11:18

Potential fix for pull request finding

5198315

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Merge branch 'main' into copilot/fix-multi-segment-paths

1ad1e2b

Aniruddh25 approved these changes Jun 30, 2026

View reviewed changes

RubenCerna2079 approved these changes Jun 30, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Allow multi-segment runtime REST/GraphQL paths (e.g. /api/v2)#3684

Allow multi-segment runtime REST/GraphQL paths (e.g. /api/v2)#3684
Copilot wants to merge 4 commits into
mainfrom
copilot/fix-multi-segment-paths

Copilot AI commented Jun 26, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

RubenCerna2079 left a comment

Uh oh!

RubenCerna2079 Jun 30, 2026

Uh oh!

RubenCerna2079 Jun 30, 2026

Uh oh!

RubenCerna2079 Jun 30, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Conversation

Copilot AI commented Jun 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Why make this change?

What is this change?

How was this tested?

Sample Request(s)

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

RubenCerna2079 left a comment

Choose a reason for hiding this comment

Uh oh!

RubenCerna2079 Jun 30, 2026

Choose a reason for hiding this comment

Uh oh!

RubenCerna2079 Jun 30, 2026

Choose a reason for hiding this comment

Uh oh!

RubenCerna2079 Jun 30, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Copilot AI commented Jun 26, 2026 •

edited

Loading