Update

Author: JamesNK

src/Grpc/JsonTranscoding/src/Microsoft.AspNetCore.Grpc.JsonTranscoding/GrpcJsonSettings.cs

@@ -34,9 +34,26 @@ public sealed class GrpcJsonSettings
     public bool WriteIndented { get; set; }
 
     /// <summary>
-    /// Gets or sets a value that indicates whether enum type name prefix on values should be stripped when
-    /// reading and writing enum values.
-    /// Default value is <see langword="false"/>.
+    /// Gets or sets a value indicating whether the enum type name prefix should be removed when reading and writing enum values.
+    /// The default value is <see langword="false"/>.
     /// </summary>
-    public bool StripEnumPrefix { get; set; }
+    /// <remarks>
+    /// <para>
+    /// In Protocol Buffers, enum value names are globally scoped, so they are often prefixed with the enum type name
+    /// to avoid name collisions. For example, the <c>Status</c> enum might define values like <c>STATUS_UNKNOWN</c>
+    /// and <c>STATUS_OK</c>.
+    /// </para>
+    /// <code>
+    /// enum Status {
+    ///   STATUS_UNKNOWN = 0;
+    ///   STATUS_OK = 1;
+    /// }
+    /// </code>
+    /// <para>
+    /// When <see cref="RemoveEnumPrefix"/> is set to <see langword="true"/>, the enum values above
+    /// will be read and written as <c>UNKNOWN</c> and <c>OK</c> instead of <c>STATUS_UNKNOWN</c>
+    /// and <c>STATUS_OK</c>.
+    /// </para>
+    /// </remarks>
+    public bool RemoveEnumPrefix { get; set; }
 }

src/Grpc/JsonTranscoding/src/Microsoft.AspNetCore.Grpc.JsonTranscoding/Internal/Json/EnumNameHelpers.cs

@@ -15,10 +15,10 @@ internal static class JsonNamingHelpers
     internal static EnumValueDescriptor? GetEnumFieldReadValue(EnumDescriptor enumDescriptor, string value, GrpcJsonSettings settings)
     {
         string resolvedName;
-        if (settings.StripEnumPrefix)
+        if (settings.RemoveEnumPrefix)
         {
             var nameMapping = GetEnumMapping(enumDescriptor);
-            if (!nameMapping.StripEnumPrefixMapping.TryGetValue(value, out var n))
+            if (!nameMapping.RemoveEnumPrefixMapping.TryGetValue(value, out var n))
             {
                 return null;
             }
@@ -43,7 +43,7 @@ internal static class JsonNamingHelpers
             return null;
         }
 
-        return settings.StripEnumPrefix ? mapping.StripEnumPrefixName : mapping.OriginalName;
+        return settings.RemoveEnumPrefix ? mapping.RemoveEnumPrefixName : mapping.OriginalName;
     }
 
     private static EnumMapping GetEnumMapping(EnumDescriptor enumDescriptor)
@@ -79,15 +79,15 @@ private static EnumMapping GetEnumMapping(string enumName, Type enumType)
                 return new NameMapping
                 {
                     OriginalName = fieldName,
-                    StripEnumPrefixName = GetEnumValueName(enumName, fieldName)
+                    RemoveEnumPrefixName = GetEnumValueName(enumName, fieldName)
                 };
             });
 
-        var stripEnumPrefixMapping = writeMapping.Values.ToDictionary(
-            m => m.StripEnumPrefixName,
+        var removeEnumPrefixMapping = writeMapping.Values.ToDictionary(
+            m => m.RemoveEnumPrefixName,
             m => m.OriginalName);
 
-        return new EnumMapping { WriteMapping = writeMapping, StripEnumPrefixMapping = stripEnumPrefixMapping };
+        return new EnumMapping { WriteMapping = writeMapping, RemoveEnumPrefixMapping = removeEnumPrefixMapping };
     }
 
     // Remove the prefix from the specified value. Ignore case and underscores in the comparison.
@@ -141,12 +141,12 @@ private static string GetEnumValueName(string enumName, string valueName)
     private sealed class EnumMapping
     {
         public required Dictionary<object, NameMapping> WriteMapping { get; init; }
-        public required Dictionary<string, string> StripEnumPrefixMapping { get; init; }
+        public required Dictionary<string, string> RemoveEnumPrefixMapping { get; init; }
     }
 
     private sealed class NameMapping
     {
         public required string OriginalName { get; init; }
-        public required string StripEnumPrefixName { get; init; }
+        public required string RemoveEnumPrefixName { get; init; }
     }
 }

src/Grpc/JsonTranscoding/src/Microsoft.AspNetCore.Grpc.JsonTranscoding/PublicAPI.Unshipped.txt

@@ -1,3 +1,3 @@
 #nullable enable
-Microsoft.AspNetCore.Grpc.JsonTranscoding.GrpcJsonSettings.StripEnumPrefix.get -> bool
-Microsoft.AspNetCore.Grpc.JsonTranscoding.GrpcJsonSettings.StripEnumPrefix.set -> void
+Microsoft.AspNetCore.Grpc.JsonTranscoding.GrpcJsonSettings.RemoveEnumPrefix.get -> bool
+Microsoft.AspNetCore.Grpc.JsonTranscoding.GrpcJsonSettings.RemoveEnumPrefix.set -> void

src/Grpc/JsonTranscoding/test/Microsoft.AspNetCore.Grpc.JsonTranscoding.Tests/ConverterTests/JsonConverterReadTests.cs

@@ -247,14 +247,14 @@ public void Enum_ReadString(string value, HelloRequest.Types.DataTypes.Types.Nes
     [InlineData("UNSPECIFIED", PrefixEnumType.Types.PrefixEnum.Unspecified)]
     [InlineData("FOO", PrefixEnumType.Types.PrefixEnum.Foo)]
     [InlineData("BAR", PrefixEnumType.Types.PrefixEnum.Bar)]
-    public void Enum_StripPrefix_ReadString(string value, PrefixEnumType.Types.PrefixEnum expectedValue)
+    public void Enum_RemovePrefix_ReadString(string value, PrefixEnumType.Types.PrefixEnum expectedValue)
     {
         var serviceDescriptorRegistry = new DescriptorRegistry();
         serviceDescriptorRegistry.RegisterFileDescriptor(JsonTranscodingGreeter.Descriptor.File);
 
         var json = @$"{{ ""singleEnum"": ""{value}"" }}";
 
-        var result = AssertReadJson<PrefixEnumType>(json, descriptorRegistry: serviceDescriptorRegistry, serializeOld: false, settings: new GrpcJsonSettings { StripEnumPrefix = true });
+        var result = AssertReadJson<PrefixEnumType>(json, descriptorRegistry: serviceDescriptorRegistry, serializeOld: false, settings: new GrpcJsonSettings { RemoveEnumPrefix = true });
         Assert.Equal(expectedValue, result.SingleEnum);
     }
 

src/Grpc/JsonTranscoding/test/Microsoft.AspNetCore.Grpc.JsonTranscoding.Tests/ConverterTests/JsonConverterWriteTests.cs

@@ -475,36 +475,23 @@ public void FieldMask_Root()
     [InlineData(PrefixEnumType.Types.PrefixEnum.Baz, @"""BAZ""")]
     [InlineData(PrefixEnumType.Types.PrefixEnum._123, @"""_123""")]
     [InlineData((PrefixEnumType.Types.PrefixEnum)100, "100")]
-    public void Enum_StripPrefix(PrefixEnumType.Types.PrefixEnum value, string expectedString)
+    public void Enum_RemovePrefix(PrefixEnumType.Types.PrefixEnum value, string expectedString)
     {
         var dataTypes = new PrefixEnumType
         {
             SingleEnum = value
         };
 
-        var json = AssertWrittenJson(dataTypes, settings: new GrpcJsonSettings { StripEnumPrefix = true }, compareOldNew: false);
+        var json = AssertWrittenJson(dataTypes, settings: new GrpcJsonSettings { RemoveEnumPrefix = true }, compareOldNew: false);
         Assert.Equal(@$"{{""singleEnum"":{expectedString}}}", json);
     }
 
-    /*
-    [Fact]
-    public void Enum_StripPrefix_Collision_Error()
-    {
-        var dataTypes = new CollisionPrefixEnumType
-        {
-            SingleEnum = CollisionPrefixEnumType.Types.CollisionPrefixEnum.Foo
-        };
-
-        AssertWrittenJson(dataTypes, settings: new GrpcJsonSettings { StripEnumPrefix = true }, compareOldNew: false);
-    }
-    */
-
     [Theory]
     [InlineData(PrefixEnumType.Types.PrefixEnum.Unspecified, @"""PREFIX_ENUM_UNSPECIFIED""")]
     [InlineData(PrefixEnumType.Types.PrefixEnum.Foo, @"""PREFIX_ENUM_FOO""")]
     [InlineData(PrefixEnumType.Types.PrefixEnum.Bar, @"""BAR""")]
     [InlineData(PrefixEnumType.Types.PrefixEnum._123, @"""PREFIX_ENUM_123""")]
-    public void Enum_NoStripPrefix(PrefixEnumType.Types.PrefixEnum value, string expectedString)
+    public void Enum_NoRemovePrefix(PrefixEnumType.Types.PrefixEnum value, string expectedString)
     {
         var dataTypes = new PrefixEnumType
         {