Skip to content

Commit e98dc01

Browse files
fsteegfsteeg
authored
Merge pull request #192 from reconciliation-api/191-reconciliation-queries-consider-renaming-v-and-pid-properties
Renamed pid to propertyId and v to propertyValue. closes #191
2 parents e9d3e52 + 5d2a95c commit e98dc01

File tree

11 files changed

+51
-51
lines changed

11 files changed

+51
-51
lines changed

‎1.0-draft/examples/reconciliation-query-batch/invalid/misnamed-conditions.json‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@
55
"limit": 5,
66
"props": [
77
{
8-
"v": "Christel Hanewinckel"
8+
"propertyValue": "Christel Hanewinckel"
99
},
1010
{
11-
"pid": "professionOrOccupation",
12-
"v": "Politik*"
11+
"propertyId": "professionOrOccupation",
12+
"propertyValue": "Politik*"
1313
},
1414
{
15-
"pid": "affiliation",
16-
"v": "http://d-nb.info/gnd/2022139-3"
15+
"propertyId": "affiliation",
16+
"propertyValue": "http://d-nb.info/gnd/2022139-3"
1717
}
1818
]
1919
},
@@ -22,15 +22,15 @@
2222
"limit": 5,
2323
"props": [
2424
{
25-
"v": "Franz Thönnes"
25+
"propertyValue": "Franz Thönnes"
2626
},
2727
{
28-
"pid": "professionOrOccupation",
29-
"v": "Politik*"
28+
"propertyId": "professionOrOccupation",
29+
"propertyValue": "Politik*"
3030
},
3131
{
32-
"pid": "affiliation",
33-
"v": "http://d-nb.info/gnd/2022139-3"
32+
"propertyId": "affiliation",
33+
"propertyValue": "http://d-nb.info/gnd/2022139-3"
3434
}
3535
]
3636
}

‎1.0-draft/examples/reconciliation-query-batch/invalid/missing-match-type.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33
{
44
"conditions": [
55
{
6-
"v": "Hans-Eberhard Urbaniak"
6+
"propertyValue": "Hans-Eberhard Urbaniak"
77
}
88
]
99
},
1010
{
1111
"conditions": [
1212
{
13-
"v": "Ernst Schwanhold"
13+
"propertyValue": "Ernst Schwanhold"
1414
}
1515
]
1616
}

‎1.0-draft/examples/reconciliation-query-batch/invalid/multiple-types.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"conditions": [
55
{
66
"matchType": "name",
7-
"v": "Christel Hanewinckel"
7+
"propertyValue": "Christel Hanewinckel"
88
}
99
],
1010
"type": [

‎1.0-draft/examples/reconciliation-query-batch/invalid/no-root-object.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@
33
"conditions": [
44
{
55
"matchType": "property",
6-
"pid": "uid",
7-
"v": "27eb892afbb2"
6+
"propertyId": "uid",
7+
"propertyValue": "27eb892afbb2"
88
}
99
]
1010
},
1111
{
1212
"conditions": [
1313
{
1414
"matchType": "property",
15-
"pid": "uid",
16-
"v": "ab09da9dd37e"
15+
"propertyId": "uid",
16+
"propertyValue": "ab09da9dd37e"
1717
}
1818
]
1919
}

‎1.0-draft/examples/reconciliation-query-batch/valid/example-full.json‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,20 @@
66
"conditions": [
77
{
88
"matchType": "name",
9-
"v": "Christel Hanewinckel"
9+
"propertyValue": "Christel Hanewinckel"
1010
},
1111
{
1212
"matchType": "property",
13-
"pid": "professionOrOccupation",
14-
"v": "Politik*",
13+
"propertyId": "professionOrOccupation",
14+
"propertyValue": "Politik*",
1515
"required": false,
1616
"matchQuantifier": "any",
1717
"matchQualifier": "WildcardMatch"
1818
},
1919
{
2020
"matchType": "property",
21-
"pid": "affiliation",
22-
"v": "http://d-nb.info/gnd/2022139-3",
21+
"propertyId": "affiliation",
22+
"propertyValue": "http://d-nb.info/gnd/2022139-3",
2323
"required": false,
2424
"matchQuantifier": "any",
2525
"matchQualifier": "ExactMatch"
@@ -32,20 +32,20 @@
3232
"conditions": [
3333
{
3434
"matchType": "name",
35-
"v": "Franz Thönnes"
35+
"propertyValue": "Franz Thönnes"
3636
},
3737
{
3838
"matchType": "property",
39-
"pid": "professionOrOccupation",
40-
"v": "Politik*",
39+
"propertyId": "professionOrOccupation",
40+
"propertyValue": "Politik*",
4141
"required": false,
4242
"matchQuantifier": "any",
4343
"matchQualifier": "WildcardMatch"
4444
},
4545
{
4646
"matchType": "property",
47-
"pid": "affiliation",
48-
"v": "http://d-nb.info/gnd/2022139-3",
47+
"propertyId": "affiliation",
48+
"propertyValue": "http://d-nb.info/gnd/2022139-3",
4949
"required": false,
5050
"matchQuantifier": "any",
5151
"matchQualifier": "ExactMatch"

‎1.0-draft/examples/reconciliation-query-batch/valid/example-min.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44
"conditions": [
55
{
66
"matchType": "name",
7-
"v": "Hans-Eberhard Urbaniak"
7+
"propertyValue": "Hans-Eberhard Urbaniak"
88
}
99
]
1010
},
1111
{
1212
"conditions": [
1313
{
1414
"matchType": "name",
15-
"v": "Ernst Schwanhold"
15+
"propertyValue": "Ernst Schwanhold"
1616
}
1717
]
1818
}

‎1.0-draft/examples/reconciliation-query-batch/valid/multi-values.json‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@
66
"conditions": [
77
{
88
"matchType": "name",
9-
"v": "Christel Hanewinckel"
9+
"propertyValue": "Christel Hanewinckel"
1010
},
1111
{
1212
"matchType": "property",
13-
"pid": "professionOrOccupation",
14-
"v": [
13+
"propertyId": "professionOrOccupation",
14+
"propertyValue": [
1515
"Politik*",
1616
{
1717
"id": "wissenschaftler",

‎1.0-draft/examples/reconciliation-query-batch/valid/no-query-string.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@
44
"conditions": [
55
{
66
"matchType": "property",
7-
"pid": "uid",
8-
"v": "27eb892afbb2"
7+
"propertyId": "uid",
8+
"propertyValue": "27eb892afbb2"
99
}
1010
]
1111
},
1212
{
1313
"conditions": [
1414
{
1515
"matchType": "property",
16-
"pid": "uid",
17-
"v": "ab09da9dd37e"
16+
"propertyId": "uid",
17+
"propertyValue": "ab09da9dd37e"
1818
}
1919
]
2020
}

‎1.0-draft/examples/reconciliation-query-batch/valid/text-processing-language.json‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@
55
"conditions": [
66
{
77
"matchType": "name",
8-
"v": "Deng Shuping"
8+
"propertyValue": "Deng Shuping"
99
},
1010
{
1111
"matchType": "property",
12-
"pid": "professionOrOccupation",
13-
"v": "art historian"
12+
"propertyId": "professionOrOccupation",
13+
"propertyValue": "art historian"
1414
},
1515
{
1616
"matchType": "property",
17-
"pid": "variantName",
18-
"v": "鄧淑蘋",
17+
"propertyId": "variantName",
18+
"propertyValue": "鄧淑蘋",
1919
"lang": "zh-Hant"
2020
}
2121
]

‎1.0-draft/index.html‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -524,19 +524,19 @@ <h3>Structure of a Reconciliation Query</h3>
524524
<dl>
525525
<dt><code>matchType</code></dt>
526526
<dd>Either <code>name</code> or <code>property</code>, depending on whether the condition relates to entity names or their properties.</dd>
527-
<dt><code>pid</code></dt>
527+
<dt><code>propertyId</code></dt>
528528
<dd>A <a href='#properties'>property</a> identifier, to be provided if and only if the <code>matchType</code> is <code>property</code>.</dd>
529-
<dt><code>v</code></dt>
529+
<dt><code>propertyValue</code></dt>
530530
<dd>one or more <a>property values</a>. If <code>matchType</code> is <code>name</code>, then this value is to
531-
be matched to entity names, otherwise to the property values via the supplied <code>pid</code>. The specifics of how this similarity
531+
be matched to entity names, otherwise to the property values via the supplied <code>propertyId</code>. The specifics of how this similarity
532532
is defined are determined by the service.</dd>
533533
<dt><code>required</code></dt>
534534
<dd>An optional 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)
535535
or optional (i.e. only effecting the entity's rank in the list of candidates). If omitted, the service SHOULD assume the requested value to be <code>false</code>;</dd>
536536
<dt><code>matchQuantifier</code></dt>
537-
<dd>An optional string to indicate which of the values in <code>v</code> to match. MUST be <code>any</code> (equivalent to boolean OR), <code>all</code> (equivalent to boolean AND), or <code>none</code> (equivalent to boolean NOT). If omitted, the service SHOULD assume the requested value to be <code>any</code>;</dd>
537+
<dd>An optional string to indicate which of the values in <code>propertyValue</code> to match. MUST be <code>any</code> (equivalent to boolean OR), <code>all</code> (equivalent to boolean AND), or <code>none</code> (equivalent to boolean NOT). If omitted, the service SHOULD assume the requested value to be <code>any</code>;</dd>
538538
<dt><code>matchQualifier</code></dt>
539-
<dd>An optional string to indicate how to match the values in <code>v</code>.
539+
<dd>An optional string to indicate how to match the values in <code>propertyValue</code>.
540540
This can be used for general matching relations like "skos:exactMatch", "skos:closeMatch", etc. or for specific features like spatial matching with geo data
541541
(e.g. containment search with "schema:containsPlace" etc.) or custom matching on date fields (e.g. services supporting the [[EDTF]] specification could use "EDTF:Level-0" etc.
542542
To allow discovery of supported qualifiers by clients, services that support <code>matchQualifier</code> MUST return the supported <code>matchQualifiers</code> for each property
@@ -965,7 +965,7 @@ <h3>Text-processing language</h3>
965965

966966
<p>All objects used in this protocol (entities, types, properties, queries, candidates, features, etc.) MAY declare an explicit <a>text-processing language</a> in a <code>lang</code> field.
967967
The <code>lang</code> value MUST be a single valid (i.e. found in the [[IANA Language Subtag Registry]]) [[BCP 47]] language tag. This text-processing language applies to the natural language fields of the object: <code>name</code>, <code>description</code>,
968-
<code>query</code> (for <a>reconciliation queries</a>), <code>v</code> and <code>str</code> (for <a>property values</a>), <code>helpText</code> (for <a>data extension property settings</a>). Nested objects inherit the text-processing language of their parent, and can override it by setting their own <code>lang</code> value
968+
<code>query</code> (for <a>reconciliation queries</a>), <code>propertyValue</code> and <code>str</code> (for <a>property values</a>), <code>helpText</code> (for <a>data extension property settings</a>). Nested objects inherit the text-processing language of their parent, and can override it by setting their own <code>lang</code> value
969969
(see example below). A default text-processing language for any natural language string returned or processed by a service MAY be set in the <code>lang</code> field of the <a href="#service-manifest">service manifest</a>.
970970
Client and service implementors SHOULD consider the text-processing language to ensure correct processing of natural language content.</p>
971971

@@ -981,7 +981,7 @@ <h3>Text direction</h3>
981981

982982
<p>All objects returned by reconciliation services (entities, types, properties, candidates, features, etc.) MAY declare an explicit text <a href="https://www.w3.org/International/articles/inline-bidi-markup/uba-basics">
983983
base direction</a> in a <code>dir</code> field. The <code>dir</code> value MUST be <code>ltr</code> for left-to-right, <code>rtl</code> for right-to-left, or <code>auto</code> for determining the direction by examining the content of each JSON field.
984-
This base direction applies to the natural language fields of the object: <code>name</code> and <code>description</code> (for candidates etc.), <code>v</code> and <code>str</code> (for <a>property values</a>), <code>helpText</code> (for <a>data extension property settings</a>).
984+
This base direction applies to the natural language fields of the object: <code>name</code> and <code>description</code> (for candidates etc.), <code>propertyValue</code> and <code>str</code> (for <a>property values</a>), <code>helpText</code> (for <a>data extension property settings</a>).
985985
Nested objects inherit the base direction of their parent, and can override it by setting their own <code>dir</code> value. A default base direction for any natural language string returned or processed by a service MAY be set in the <code>dir</code> field of the
986986
<a href="#service-manifest">service manifest</a>. If no explicit base direction is given, left-to-right is considered the default base direction. Clients SHOULD consider the base direction to ensure correct rendering of content, e.g. by setting corresponding <code>dir</code> attributes when rendering JSON responses in HTML.
987987
For instance, rendering a Persian label for 'Yahoo!' like <code>یاهو!</code> right-to-left will correctly display as <code dir="rtl">یاهو!</code>.</p>

0 commit comments

Comments
 (0)