Update schemas for new optional matching properties (#131)

reconciliation-api · Dec 11, 2023 · fb60668 · fb60668
1 parent c3c220a
commit fb60668
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 0 deletions.
diff --git a/draft/schemas/reconciliation-query-batch.json b/draft/schemas/reconciliation-query-batch.json
@@ -82,6 +82,23 @@
                       }
                     }
                   ]
+                },
+                "required": {
+                  "type": "boolean",
+                  "description": "A boolean indicating if a match for the property is required for an entity to enter the list of candidates"
+                },
+                "match_quantifier": {
+                  "type": "string",
+                  "description": "A string to indicate which of the values in v to match",
+                  "enum": [
+                    "any",
+                    "all",
+                    "none"
+                  ]
+                },
+                "match_qualifier": {
+                  "type": "string",
+                  "description": "A string to indicate how to match the values in v"
                 }
               },
               "required": [

diff --git a/draft/schemas/suggest-properties-response.json b/draft/schemas/suggest-properties-response.json
@@ -20,6 +20,27 @@
           "description": {
             "type": "string",
             "description": "An optional description which can be provided to disambiguate namesakes, providing more context."
+          },
+          "match_qualifiers": {
+            "type": "array",
+            "description": "An optional array of objects representing the match_qualifiers supported for the suggested property",
+            "items": {
+              "type": "object",
+              "properties": {
+                "id": {
+                  "type": "string",
+                  "description": "Identifier of the match_qualifier"
+                },
+                "name": {
+                  "type": "string",
+                  "description": "Name of the match_qualifier"
+                }
+              },
+              "required": [
+                "id",
+                "name"
+              ]
+            }
           }
         },
         "required": [