CSHARP-5326: Mark API as obsolete: Guids (#1495)

mongodb · Oct 14, 2024 · 0bf1089 · 0bf1089
1 parent 16ea688
commit 0bf1089
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 0 deletions.
diff --git a/MongoDB.ruleset b/MongoDB.ruleset
@@ -105,5 +105,6 @@
     <Rule Id="CA2242" Action="Warning" />
     <Rule Id="CA5350" Action="None" />
     <Rule Id="CA5351" Action="None" />
+    <Rule Id="CS0618" Action="None"/>
   </Rules>
 </RuleSet>
diff --git a/MongoDBLegacy.ruleset b/MongoDBLegacy.ruleset
@@ -97,5 +97,6 @@
     <Rule Id="CA2242" Action="Warning" />
     <Rule Id="CA5350" Action="None" />
     <Rule Id="CA5351" Action="None" />
+    <Rule Id="CS0618" Action="None"/>
   </Rules>
 </RuleSet>
diff --git a/MongoDBLegacyTest.ruleset b/MongoDBLegacyTest.ruleset
@@ -112,5 +112,6 @@
     <Rule Id="CA3075" Action="None" />
     <Rule Id="CA5350" Action="None" />
     <Rule Id="CA5351" Action="None" />
+    <Rule Id="CS0618" Action="None"/>
   </Rules>
 </RuleSet>
diff --git a/MongoDBTest.ruleset b/MongoDBTest.ruleset
@@ -111,5 +111,6 @@
     <Rule Id="CA2242" Action="Warning" />
     <Rule Id="CA5350" Action="None" />
     <Rule Id="CA5351" Action="None" />
+    <Rule Id="CS0618" Action="None"/>
   </Rules>
 </RuleSet>
diff --git a/src/MongoDB.Bson/ObjectModel/GuidRepresentationMode.cs b/src/MongoDB.Bson/ObjectModel/GuidRepresentationMode.cs
@@ -13,12 +13,15 @@
 * limitations under the License.
 */
 
+using System;
+
 namespace MongoDB.Bson
 {
     /// <summary>
     /// Whether to handle GuidRepresentation using the v2.x mode of the v3.x mode.
     /// See the reference documentation for details.
     /// </summary>
+    [Obsolete("This enum will be made removed in a later release, with V3 being the only representation mode.")]
     public enum GuidRepresentationMode
     {
         /// <summary>