Fix 'descriptionription' mis-naming in dimension field

CHANGELOG.md

@@ -266,6 +266,11 @@ Current
 
 ### Fixed:
 
+- [Fix 'descriptionription' mis-naming in dimension field](https://github.com/yahoo/fili/pull/655)
+    * This is caused by a "desc" -> "description" string replacement. A string handling method has been added to
+      detect "desc" and transform it to "description". If it already comes with "description", no string transformation
+      is made
+
 - [Fix caching condition](https://github.com/yahoo/fili/pull/647)
     * We want to cache partial or volatile data when `cache_partial_data` is set to true. This is condition is currently
       reversed. This PR shall fix it

docs/end-user-api.md

@@ -58,9 +58,9 @@ aggregating, as well as filtering of data, and are a critical part of the system
 fields, as well as a collection of possible values for that dimension. These dimension fields and values serve two
 primary purposes: Filtering and Annotating data query results.
 
-All dimensions have an Id property (a natural key) and a Desc property (a human-readable description). Both of these
-fields can be used to filter rows reported on, and both of these fields are included in the data query result set for
-each dimension.
+All dimensions have an Id property (a natural key) and a Description property (a human-readable description). Both of
+these fields can be used to filter rows reported on, and both of these fields are included in the data query result set
+for each dimension.
 
 Get a [list of all dimensions](https://sampleapp.fili.org/v1/dimensions):
 

fili-core/src/main/java/com/yahoo/bard/webservice/data/dimension/impl/KeyValueStoreDimension.java

@@ -564,7 +564,7 @@ public DimensionField getKey() {
 
     @Override
     public DimensionRow parseDimensionRow(Map<String, String> fieldNameValueMap) {
-        // This rewrite need to be removed once description is normalized in legacy implementations
+        // TODO: This rewrite need to be removed once description is normalized in legacy implementations
         String desc = fieldNameValueMap.remove("description");
         if (desc != null) {
             fieldNameValueMap.put("desc", desc);

fili-core/src/main/java/com/yahoo/bard/webservice/web/endpoints/DimensionsServlet.java

@@ -311,7 +311,7 @@ public Response getDimensionRows(
                     .map(stream ->
                             stream.collect(
                                     StreamUtils.toLinkedMap(
-                                            entry -> entry.getKey().getName().replace("desc", "description"),
+                                            entry -> getDescriptionKey(entry.getKey().getName()),
                                             Map.Entry::getValue
                                     )
                             )
@@ -479,4 +479,19 @@ public static String getDimensionValuesUrl(Dimension dimension, final UriInfo ur
                 .build(dimension.getApiName())
                 .toASCIIString();
     }
+
+    /**
+     * If a description dimension fields has a name of "desc", transforms it to "description", otherwise returns the
+     * original without modification.
+     * <p>
+     * TODO: This rewrite need to be removed once description is normalized in legacy implementations, see
+     * {@link com.yahoo.bard.webservice.data.dimension.impl.KeyValueStoreDimension#parseDimensionRow(Map)}.
+     *
+     * @param fieldName  The name of the description field name
+     *
+     * @return a description dimension field with name "description"
+     */
+    private static String getDescriptionKey(String fieldName) {
+        return fieldName.contains("description") ? fieldName : fieldName.replace("desc", "description");
+    }
 }