fix(specs): highlight result map definition

algolia · Dec 1, 2023 · c68e864 · c68e864
1 parent 64da244
commit c68e864
Show file tree

Hide file tree

Showing 8 changed files with 52 additions and 30 deletions.
diff --git a/generators/src/main/java/com/algolia/codegen/AlgoliaJavaGenerator.java b/generators/src/main/java/com/algolia/codegen/AlgoliaJavaGenerator.java
@@ -111,6 +111,6 @@ public String toEnumVarName(String value, String datatype) {
 
   /** Convert a Seq type to a valid class name. */
   private String typeToName(String content) {
-    return content.trim().replace("<", "Of").replace(">", "");
+    return content.trim().replace("<", "Of").replace(">", "").replace(",", "").replace(" ", "");
   }
 }
diff --git a/generators/src/main/java/com/algolia/codegen/AlgoliaKotlinGenerator.java b/generators/src/main/java/com/algolia/codegen/AlgoliaKotlinGenerator.java
@@ -124,7 +124,7 @@ public void processOpts() {
 
   /** Convert a Seq type to a valid class name. */
   private String typeToName(String content) {
-    return content.trim().replace("<", "Of").replace(">", "");
+    return content.trim().replace("<", "Of").replace(">", "").replace(", ", "").replace(".", "");
   }
 
   private void hostForKotlin() {

diff --git a/generators/src/main/java/com/algolia/codegen/AlgoliaScalaGenerator.java b/generators/src/main/java/com/algolia/codegen/AlgoliaScalaGenerator.java
@@ -62,7 +62,7 @@ public void processOpts() {
 
   /** Convert a Seq type to a valid class name. */
   private String typeToName(String content) {
-    return content.trim().replace("[", "Of").replace("]", "");
+    return content.trim().replace("[", "Of").replace("]", "").replace(".", "").replace(", ", "");
   }
 
   @Override

diff --git a/specs/search/common/schemas/Hit.yml b/specs/search/common/schemas/Hit.yml
@@ -9,9 +9,9 @@ hit:
     objectID:
       $ref: '../../../common/parameters.yml#/objectID'
     _highlightResult:
-      $ref: '#/highlightResultMap'
+      $ref: '#/highlightResult'
     _snippetResult:
-      $ref: '#/snippetResultMap'
+      $ref: '#/snippetResult'
     _rankingInfo:
       $ref: '#/rankingInfo'
     _distinctSeqID:
@@ -21,10 +21,25 @@ hit:
 _distinctSeqID:
   type: integer
 
+highlightResultOptionMap:
+  type: object
+  description: Show highlighted section and words matched on a query.
+  additionalProperties:
+    $ref: '#/highlightResultOption'
+
+highlightResultOptionOneOf:
+  oneOf:
+    - $ref: '#/highlightResultOption'
+    - $ref: '#/highlightResultOptionMap'
+
 highlightResultOption:
   type: object
   description: Show highlighted section and words matched on a query.
   additionalProperties: false
+  x-discriminator-fields:
+    - matchLevel
+    - value
+    - matchedWords
   properties:
     value:
       $ref: '#/highlightedValue'
@@ -45,17 +60,10 @@ highlightResultOption:
     - matchedWords
 
 highlightResult:
-  oneOf:
-    - $ref: '#/highlightResultOption'
-    - type: array
-      items:
-        $ref: '#/highlightResultOption'
-
-highlightResultMap:
   type: object
   description: Show highlighted section and words matched on a query.
   additionalProperties:
-    $ref: '#/highlightResult'
+    $ref: '#/highlightResultOptionOneOf'
 
 snippetResultOption:
   type: object
@@ -70,18 +78,22 @@ snippetResultOption:
     - value
     - matchLevel
 
-snippetResult:
+snippetResultOptionMap:
+  type: object
+  description: Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
+  additionalProperties:
+    $ref: '#/snippetResultOption'
+
+snippetResultOptionOneOf:
   oneOf:
     - $ref: '#/snippetResultOption'
-    - type: array
-      items:
-        $ref: '#/snippetResultOption'
+    - $ref: '#/snippetResultOptionMap'
 
-snippetResultMap:
+snippetResult:
   type: object
   description: Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
   additionalProperties:
-    $ref: '#/snippetResult'
+    $ref: '#/snippetResultOptionOneOf'
 
 rankingInfo:
   type: object

diff --git a/specs/search/paths/multiclusters/searchUserIds.yml b/specs/search/paths/multiclusters/searchUserIds.yml
@@ -64,9 +64,9 @@ post:
                       type: object
                       properties:
                         userID:
-                          $ref: '../../common/schemas/Hit.yml#/highlightResultMap'
+                          $ref: '../../common/schemas/Hit.yml#/highlightResult'
                         clusterName:
-                          $ref: '../../common/schemas/Hit.yml#/highlightResultMap'
+                          $ref: '../../common/schemas/Hit.yml#/highlightResult'
                       required:
                         - userID
                         - clusterName

diff --git a/templates/java/oneof_interface.mustache b/templates/java/oneof_interface.mustache
@@ -82,7 +82,8 @@ public interface {{classname}} {
             JsonNode tree = jp.readValueAsTree();
             {{#composedSchemas.oneOf}}
             // deserialize {{{datatypeWithEnum}}}
-            if (tree.{{#isModel}}isObject(){{#vendorExtensions.x-discriminator-fields}} && tree.has("{{{.}}}"){{/vendorExtensions.x-discriminator-fields}}{{/isModel}}{{#isEnumRef}}isTextual(){{/isEnumRef}}{{#isArray}}isArray(){{/isArray}}{{#isInteger}}isInt(){{/isInteger}}{{#isLong}}isLong(){{/isLong}}{{#isDouble}}isDouble(){{/isDouble}}{{#isBoolean}}isBoolean(){{/isBoolean}}{{#isString}}isTextual(){{/isString}}){
+
+            if (tree.{{#isMap}}isObject(){{/isMap}}{{#isModel}}isObject(){{#vendorExtensions.x-discriminator-fields}} && tree.has("{{{.}}}"){{/vendorExtensions.x-discriminator-fields}}{{/isModel}}{{#isEnumRef}}isTextual(){{/isEnumRef}}{{#isArray}}isArray(){{/isArray}}{{#isInteger}}isInt(){{/isInteger}}{{#isLong}}isLong(){{/isLong}}{{#isDouble}}isDouble(){{/isDouble}}{{#isBoolean}}isBoolean(){{/isBoolean}}{{#isString}}isTextual(){{/isString}}){
                 try(JsonParser parser = tree.traverse(jp.getCodec())) {  
                     {{#isModel}}
                     return parser.readValueAs({{{datatypeWithEnum}}}.class);
@@ -94,10 +95,14 @@ public interface {{classname}} {
                     {{{datatypeWithEnum}}} value = parser.readValueAs(new TypeReference<{{{datatypeWithEnum}}}>(){});
                     return new {{classname}}.{{#lambda.type-to-name}}{{{datatypeWithEnum}}}{{/lambda.type-to-name}}Wrapper(value);
                     {{/isArray}}
-                    {{^isModel}}{{^isEnumRef}}{{^isArray}}
+                    {{^isModel}}{{^isEnumRef}}{{^isArray}}{{^isMap}}
                     {{{datatypeWithEnum}}} value = parser.readValueAs({{{datatypeWithEnum}}}.class);
                     return new {{classname}}.{{{datatypeWithEnum}}}Wrapper(value);
-                    {{/isArray}}{{/isEnumRef}}{{/isModel}}
+                    {{/isMap}}{{/isArray}}{{/isEnumRef}}{{/isModel}}
+                    {{#isMap}}
+                    {{{datatypeWithEnum}}} value = parser.readValueAs({{#lambda.type-to-name}}{{{datatypeWithEnum}}}{{/lambda.type-to-name}}.class);
+                    return new {{classname}}.{{#lambda.type-to-name}}{{{datatypeWithEnum}}}{{/lambda.type-to-name}}Wrapper(value);
+                    {{/isMap}}
                 } catch (Exception e) {
                     // deserialization failed, continue
                     LOGGER.finest("Failed to deserialize oneOf {{{datatypeWithEnum}}} (error: " + e.getMessage() + ") (type: {{{datatypeWithEnum}}})");
@@ -121,4 +126,3 @@ public interface {{classname}} {
         }
     }
 }
-
diff --git a/templates/kotlin/oneof_interface.mustache b/templates/kotlin/oneof_interface.mustache
@@ -69,6 +69,9 @@ internal class {{classname}}Serializer : JsonContentPolymorphicSerializer<{{clas
             {{#isModel}}
             element is JsonObject{{#vendorExtensions.x-discriminator-fields}} && element.containsKey("{{{.}}}"){{/vendorExtensions.x-discriminator-fields}} -> {{{datatypeWithEnum}}}.serializer()
             {{/isModel}}
+            {{#isMap}}
+            element is JsonObject -> {{#lambda.type-to-name}}{{{datatypeWithEnum}}}{{/lambda.type-to-name}}Value.serializer()
+            {{/isMap}}
             {{#isArray}}
             element{{#items}}{{#isModel}}.isJsonArrayOfObjects{{/isModel}}{{#isPrimitiveType}}.isJsonArrayOfPrimitives{{/isPrimitiveType}}{{#isModel}}{{#isPrimitiveType}} is JsonArray{{/isPrimitiveType}}{{/isModel}}{{/items}} -> {{{classname}}}.{{#lambda.type-to-name}}{{{datatypeWithEnum}}}{{/lambda.type-to-name}}Value.serializer()
             {{/isArray}}
@@ -94,4 +97,4 @@ internal class {{classname}}Serializer : JsonContentPolymorphicSerializer<{{clas
             else -> throw AlgoliaClientException("Failed to deserialize json element: $element")
         }
     }
-}
+}
diff --git a/templates/scala/oneof_trait.mustache b/templates/scala/oneof_trait.mustache
@@ -28,7 +28,7 @@ object {{classname}} {
   {{#composedSchemas.oneOf}}
   {{^isModel}}
   {{^isEnumRef}}
-  case class {{#isArray}}{{#lambda.type-to-name}}{{{datatypeWithEnum}}}{{/lambda.type-to-name}}{{/isArray}}{{^isArray}}{{{datatypeWithEnum}}}Value{{/isArray}}(value: {{{datatypeWithEnum}}}) extends {{classname}}
+  case class {{#isMap}}{{#lambda.type-to-name}}{{{datatypeWithEnum}}}{{/lambda.type-to-name}}{{/isMap}}{{#isArray}}{{#lambda.type-to-name}}{{{datatypeWithEnum}}}{{/lambda.type-to-name}}{{/isArray}}{{^isMap}}{{^isArray}}{{{datatypeWithEnum}}}Value{{/isArray}}{{/isMap}}(value: {{{datatypeWithEnum}}}) extends {{classname}}
   {{/isEnumRef}}
   {{/isModel}}
   {{/composedSchemas.oneOf}}
@@ -38,7 +38,7 @@ object {{classname}} {
   {{^isModel}}
   {{^isEnumRef}}
   def apply(value: {{{datatypeWithEnum}}}){{#isArray}}(implicit ev: {{classname}}Evidence.{{#lambda.type-to-name}}{{{datatypeWithEnum}}}{{/lambda.type-to-name}}Evidence.type){{/isArray}}: {{classname}} = {
-      {{classname}}.{{#isArray}}{{#lambda.type-to-name}}{{{datatypeWithEnum}}}{{/lambda.type-to-name}}{{/isArray}}{{^isArray}}{{{datatypeWithEnum}}}Value{{/isArray}}(value)
+      {{classname}}.{{#isMap}}{{#lambda.type-to-name}}{{{datatypeWithEnum}}}{{/lambda.type-to-name}}{{/isMap}}{{#isArray}}{{#lambda.type-to-name}}{{{datatypeWithEnum}}}{{/lambda.type-to-name}}{{/isArray}}{{^isMap}}{{^isArray}}{{{datatypeWithEnum}}}Value{{/isArray}}{{/isMap}}(value)
   }
   {{/isEnumRef}}
   {{/isModel}}
@@ -50,7 +50,7 @@ object {{classname}} {
   {{^isModel}}
   {{^isEnumRef}}
   def apply(value: {{{datatypeWithEnum}}}): {{classname}} = {
-      {{classname}}.{{#isArray}}{{#lambda.type-to-name}}{{{datatypeWithEnum}}}{{/lambda.type-to-name}}{{/isArray}}{{^isArray}}{{{datatypeWithEnum}}}Value{{/isArray}}(value)
+      {{classname}}.{{#isMap}}{{#lambda.type-to-name}}{{{datatypeWithEnum}}}{{/lambda.type-to-name}}{{/isMap}}{{#isArray}}{{#lambda.type-to-name}}{{{datatypeWithEnum}}}{{/lambda.type-to-name}}{{/isArray}}{{^isMap}}{{^isArray}}{{{datatypeWithEnum}}}Value{{/isArray}}{{/isMap}}(value)
   }
   {{/isEnumRef}}
   {{/isModel}}
@@ -67,6 +67,9 @@ object {{classname}}Serializer extends Serializer[{{classname}}] {
         {{#isModel}}
         case value: JObject {{#vendorExtensions.x-discriminator-fields}}{{#-first}}if{{/-first}}{{^-first}}&&{{/-first}} value.obj.contains("{{{.}}}"){{/vendorExtensions.x-discriminator-fields}} => Extraction.extract[{{{datatypeWithEnum}}}](value)
         {{/isModel}}
+        {{#isMap}}
+        case value: JObject => Extraction.extract[{{{datatypeWithEnum}}}](value)
+        {{/isMap}}
         {{#isEnumRef}}
         case value: JString => Extraction.extract[{{{datatypeWithEnum}}}](value)
         {{/isEnumRef}}
@@ -96,4 +99,4 @@ object {{classname}}Serializer extends Serializer[{{classname}}] {
   override def serialize(implicit format: Formats): PartialFunction[Any, JValue] = {
     case value => Extraction.decompose(value)(format - this)
   }
-}
+}