Rename API members per API review feedback#38188
Merged
AndriySvyryd merged 3 commits intomainfrom Apr 30, 2026
Merged
Conversation
… JsonPath, JsonPathSegment, and Ordinals per API review Agent-Logs-Url: https://github.com/dotnet/efcore/sessions/56ecc586-e9c8-4c70-8a17-fbcaaed4a258 Co-authored-by: AndriySvyryd <6539701+AndriySvyryd@users.noreply.github.com>
…er rename Agent-Logs-Url: https://github.com/dotnet/efcore/sessions/56ecc586-e9c8-4c70-8a17-fbcaaed4a258 Co-authored-by: AndriySvyryd <6539701+AndriySvyryd@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
AndriySvyryd
April 29, 2026 01:27
View session
There was a problem hiding this comment.
Pull request overview
This PR applies a set of public API renames based on API review feedback across EFCore, EFCore.Relational, and EFCore.Cosmos, updating all usages, tests, and API baseline JSON accordingly.
Changes:
- Renames Cosmos bulk execution option APIs (
BulkExecutionEnabled→BulkExecutionAllowed) and updates Cosmos tests/baselines. - Renames migrations snapshot API (
LatestMigrationId→LastMigrationId) and updates generator/tests. - Renames compiled-model mismatch event payload member (
CompiledProviderName→MismatchedProviderName) and updates logging/baseline. - Renames JSON path APIs (
JsonPath→StructuredJsonPath,JsonPathSegment→StructuredJsonPathSegment,Ordinals→Indices), moves the segment type toMicrosoft.EntityFrameworkCore.Metadata, and updates CoreStrings resource + baselines + tests.
Reviewed changes
Copilot reviewed 31 out of 32 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| test/EFCore.Tests/Infrastructure/StructuredJsonPathTest.cs | Adds coverage for StructuredJsonPath/StructuredJsonPathSegment string formatting and basic behaviors. |
| test/EFCore.Tests/Infrastructure/JsonPathTest.cs | Removes tests for the old JsonPath/JsonPathSegment APIs. |
| test/EFCore.SqlServer.HierarchyId.Tests/TestModels/Migrations/TypedArraySeedContext.cs | Updates generated snapshot override to LastMigrationId. |
| test/EFCore.SqlServer.HierarchyId.Tests/TestModels/Migrations/AnonymousArraySeedContext.cs | Updates generated snapshot override to LastMigrationId. |
| test/EFCore.Design.Tests/Migrations/Design/CSharpMigrationsGeneratorTest.ModelSnapshot.cs | Updates assertions to LastMigrationId and validates generated snapshot code. |
| test/EFCore.Design.Tests/Design/OperationExecutorTest.cs | Updates embedded snapshot code to LastMigrationId. |
| test/EFCore.Cosmos.Tests/Extensions/CosmosDbContextOptionsExtensionsTests.cs | Updates Cosmos options builder test to BulkExecutionAllowed. |
| test/EFCore.Cosmos.FunctionalTests/Update/CosmosBulkWarningTest.cs | Updates functional test configuration to BulkExecutionAllowed. |
| test/EFCore.Cosmos.FunctionalTests/Update/CosmosBulkExecutionTest.cs | Updates functional tests to use BulkExecutionAllowed. |
| test/EFCore.Cosmos.FunctionalTests/Update/CosmosBulkEndToEndTestNoBatching.cs | Updates configuration to BulkExecutionAllowed. |
| test/EFCore.Cosmos.FunctionalTests/Update/CosmosBulkEndToEndTest.cs | Updates configuration to BulkExecutionAllowed. |
| test/EFCore.Cosmos.FunctionalTests/Update/CosmosBulkConcurrencyTest.cs | Updates configuration to BulkExecutionAllowed. |
| src/EFCore/Properties/CoreStrings.resx | Renames JSON-path count resource key/message to indices terminology. |
| src/EFCore/Properties/CoreStrings.Designer.cs | Updates generated accessor to InvalidStructuredJsonPathIndexCount. |
| src/EFCore/EFCore.baseline.json | Updates API baseline entries for renamed CoreStrings and diagnostics event data. |
| src/EFCore/Diagnostics/ProviderMismatchEventData.cs | Renames payload property/ctor parameter to MismatchedProviderName. |
| src/EFCore/Diagnostics/CoreLoggerExtensions.cs | Uses MismatchedProviderName when generating the mismatch log message. |
| src/EFCore.Relational/Update/ModificationCommand.cs | Switches JSON path construction to StructuredJsonPath. |
| src/EFCore.Relational/Update/IColumnModification.cs | Updates JsonPath property type to StructuredJsonPath?. |
| src/EFCore.Relational/Update/ColumnModificationParameters.cs | Updates JsonPath property/ctor parameter types to StructuredJsonPath. |
| src/EFCore.Relational/Update/ColumnModification.cs | Updates JsonPath property type to StructuredJsonPath?. |
| src/EFCore.Relational/Metadata/StructuredJsonPathSegment.cs | Renames/moves segment type to StructuredJsonPathSegment in Metadata namespace. |
| src/EFCore.Relational/Metadata/Internal/RelationalJsonObject.cs | Updates child-path construction to use StructuredJsonPathSegment. |
| src/EFCore.Relational/Metadata/Internal/RelationalJsonElement.cs | Updates path type and array placeholder segment to StructuredJsonPathSegment.Array. |
| src/EFCore.Relational/Metadata/IRelationalJsonElement.cs | Updates Path type to IReadOnlyList<StructuredJsonPathSegment>. |
| src/EFCore.Relational/Infrastructure/StructuredJsonPath.cs | Renames JsonPath → StructuredJsonPath and Ordinals → Indices, updates validation message. |
| src/EFCore.Relational/Infrastructure/ModelSnapshot.cs | Renames LatestMigrationId → LastMigrationId. |
| src/EFCore.Relational/EFCore.Relational.baseline.json | Updates relational API baseline entries for StructuredJsonPath* and LastMigrationId. |
| src/EFCore.Design/Migrations/Design/CSharpMigrationsGenerator.cs | Updates generated snapshot code to emit LastMigrationId. |
| src/EFCore.Cosmos/Infrastructure/Internal/CosmosDbOptionExtension.cs | Renames internal extension method to BulkExecutionAllowed. |
| src/EFCore.Cosmos/Infrastructure/CosmosDbContextOptionsBuilder.cs | Renames builder API to BulkExecutionAllowed. |
| src/EFCore.Cosmos/EFCore.Cosmos.baseline.json | Updates Cosmos API baseline for BulkExecutionAllowed. |
Files not reviewed (1)
- src/EFCore/Properties/CoreStrings.Designer.cs: Language not supported
Agent-Logs-Url: https://github.com/dotnet/efcore/sessions/4a245278-1478-40ef-83bd-57a2b44e7c0a Co-authored-by: AndriySvyryd <6539701+AndriySvyryd@users.noreply.github.com>
roji
approved these changes
Apr 30, 2026
Contributor
API review baseline changes for
|
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.
Part of #37993
Batch of API renames from API review.
CosmosDbContextOptionsBuilder.BulkExecutionEnabled→BulkExecutionAllowedModelSnapshot.LatestMigrationId→LastMigrationIdProviderMismatchEventData.CompiledProviderName→MismatchedProviderNameJsonPath→StructuredJsonPath;JsonPathSegment→StructuredJsonPathSegment(moved toMicrosoft.EntityFrameworkCore.Metadatanamespace)JsonPath.Ordinals→IndicesCoreStrings resource
InvalidJsonPathOrdinalCountrenamed toInvalidStructuredJsonPathIndexCountaccordingly. All baseline JSON files updated. All API baseline tests (14/14) pass.