Skip to content

Updated spec and schema to add "id" matchType #195

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
saumier merged 1 commit into from
Nov 10, 2025
Merged

Updated spec and schema to add "id" matchType #195

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions 1.0-draft/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -549,12 +549,12 @@ <h3>Structure of a Reconciliation Query</h3>
by allowing clients to specify an attribute of entities that should match. It consists of:
<dl>
<dt><code>matchType</code></dt>
<dd>{{String}} (required) either <code>name</code> or <code>property</code>, depending on whether the condition relates to entity names or their properties.</dd>
<dd>{{String}} (required) either <code>name</code> or <code>id</code> or <code>property</code>, depending on whether the condition relates to entity names, entity ids or their properties.</dd>
Comment thread
saumier marked this conversation as resolved.
<dt><code>propertyId</code></dt>
<dd>{{String}} (required if the <code>matchType</code> is <code>property</code>) a <a href='#properties'>property</a> identifier.</dd>
<dt><code>propertyValue</code></dt>
<dd>{{String}} (required) one or more <a>property values</a>. If <code>matchType</code> is <code>name</code>, then this value is to
be matched to entity names, otherwise to the property values via the supplied <code>propertyId</code>. The specifics of how this similarity
be matched to entity names. If <code>matchType</code> is <code>id</code>, then this value is to be matched to entity ids, otherwise to the property values via the supplied <code>propertyId</code>. The specifics of how this similarity
is defined are determined by the service.</dd>
<dt><code>required</code></dt>
<dd>{{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)
Expand Down
5 changes: 3 additions & 2 deletions 1.0-draft/schemas/reconciliation-query-batch.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Comment thread
saumier marked this conversation as resolved.
"enum": [
"name",
"id",
"property"
]
},
Expand All @@ -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"
Expand Down