reconciliation-api / specs

Specifications of the reconciliation API
https://reconciliation-api.github.io/specs/draft/
30 stars 9 forks source link

Clarify default value of 'required' and 'match_quantifier' field on matching conditions #155

Open wetneb opened 4 months ago

wetneb commented 4 months ago

In https://reconciliation-api.github.io/specs/draft/#structure-of-a-reconciliation-query, we currently have:

required A boolean indicating 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) or optional (i.e. only effecting the entity's rank in the list of candidates);

It would be useful to clarify the implied value of this parameter (if any) when it is not present, and similarly for match_quantifier.

I propose: