From 1b58debb0bf3195c24bf45d3384595b94a5c4e70 Mon Sep 17 00:00:00 2001 From: Gregory Saumier-Finch Date: Wed, 8 Oct 2025 19:01:17 -0400 Subject: [PATCH] Updated spec and schema to add "id" as an explicit matchType option for reconciliation queries. --- 1.0-draft/index.html | 4 ++-- 1.0-draft/schemas/reconciliation-query-batch.json | 5 +++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/1.0-draft/index.html b/1.0-draft/index.html index 39886f2..2f2a0ee 100644 --- a/1.0-draft/index.html +++ b/1.0-draft/index.html @@ -549,12 +549,12 @@

Structure of a Reconciliation Query

by allowing clients to specify an attribute of entities that should match. It consists of:
matchType
-
{{String}} (required) either name or property, depending on whether the condition relates to entity names or their properties.
+
{{String}} (required) either name or id or property, depending on whether the condition relates to entity names, entity ids or their properties.
propertyId
{{String}} (required if the matchType is property) a property identifier.
propertyValue
{{String}} (required) one or more property values. If matchType is name, then this value is to - be matched to entity names, otherwise to the property values via the supplied propertyId. The specifics of how this similarity + be matched to entity names. If matchType is id, then this value is to be matched to entity ids, otherwise to the property values via the supplied propertyId. The specifics of how this similarity is defined are determined by the service.
required
{{Boolean}} (optional) to indicate if a match for the property is required for an entity to enter the list of candidates (i.e. acting like a filter or a WHERE clause in SQL) diff --git a/1.0-draft/schemas/reconciliation-query-batch.json b/1.0-draft/schemas/reconciliation-query-batch.json index f332512..ebe409f 100644 --- a/1.0-draft/schemas/reconciliation-query-batch.json +++ b/1.0-draft/schemas/reconciliation-query-batch.json @@ -72,9 +72,10 @@ "properties": { "matchType": { "type": "string", - "description": "A string to indicate whether to match the supplied value to entity names or property values", + "description": "A string to indicate whether to match the supplied value to entity names, entity ids or property values", "enum": [ "name", + "id", "property" ] }, @@ -83,7 +84,7 @@ "description": "The identifier of the property, whose values will be compared to the values supplied. Required if 'matchType' is 'property'." }, "propertyValue": { - "description": "A value (or array of values) to match against the entity names or property values associated with the property on each candidate", + "description": "A value (or array of values) to match against the entity names, entity ids, or property values associated with the property on each candidate", "oneOf": [ { "$ref": "#/definitions/property_value"