Merge pull request #518 from maxmind/greg/eng-1001-mark-metro-code-data-as-deprecated-in-our-libraries

Deprecate metro code

Author: horgh

CHANGELOG.md

@@ -1,6 +1,12 @@
 CHANGELOG
 =========
 
+4.3.0
+------------------
+
+* `getMetroCode` in the `Location` model has been deprecated. The code
+  values are no longer being maintained.
+
 4.2.1 (2024-09-20)
 ------------------
 

src/main/java/com/maxmind/geoip2/record/Location.java

@@ -119,12 +119,12 @@ public Integer getAccuracyRadius() {
     }
 
     /**
-     * @return The metro code of the location if the location is in the US.
-     * MaxMind returns the same metro codes as the <a href=
-     * "https://developers.google.com/adwords/api/docs/appendix/cities-DMAregions"
-     * >Google AdWords API</a>.
+     * @return The metro code is a no-longer-maintained code for targeting
+     * advertisements in Google.
+     * @deprecated Code values are no longer maintained.
      */
     @JsonProperty("metro_code")
+    @Deprecated
     public Integer getMetroCode() {
         return this.metroCode;
     }

src/test/java/com/maxmind/geoip2/WebServiceClientTest.java

@@ -67,6 +67,7 @@ public void test200WithInvalidJson() throws Exception {
         assertEquals("Received a 200 response but could not decode it as JSON", ex.getMessage());
     }
 
+    @SuppressWarnings("deprecation")
     @Test
     public void test200WithDefaultValues() throws Exception {
         WebServiceClient client = createSuccessClient("insights", "1.2.3.13",

src/test/java/com/maxmind/geoip2/model/InsightsResponseTest.java

@@ -105,6 +105,7 @@ public void leastSpecificSubdivision() {
         );
     }
 
+    @SuppressWarnings("deprecation")
     @Test
     public void testTraits() {
         Traits traits = this.insights.getTraits();
@@ -172,6 +173,7 @@ public void testTraits() {
         );
     }
 
+    @SuppressWarnings("deprecation")
     @Test
     public void testLocation() {