Merge branch 'master' into 164-fix-data-extension-property-settings

reconciliation-api · Jun 13, 2024 · a55a27f · a55a27f
2 parents 79f6e8c + 55ce38e
commit a55a27f
Show file tree

Hide file tree

Showing 24 changed files with 263 additions and 197 deletions.
diff --git a/README.md b/README.md
@@ -8,12 +8,7 @@ https://reconciliation-api.github.io/specs/draft/
 
 General discussion about this protocol can be held on the [`public-reconciliation@w3.org` mailing list](https://lists.w3.org/Archives/Public/public-reconciliation/).
 
-Initially, the aim is to document the existing state of the API,
-as witnessed by the existing clients and servers, and the [original documentation
-on OpenRefine's wiki](https://github.com/OpenRefine/OpenRefine/wiki/Reconciliation-Service-API).
-Once the existing API is documented to a satisfactory level, we will incorporate improvements
-discussed in the [Community Group](https://www.w3.org/community/reconciliation/) in further versions
-of the document.
+Anyone can join our [W3C Entity Reconciliation Community Group](https://www.w3.org/community/reconciliation/) or read our past announcements.
 
 Feel free to contribute to this documentation effort by editing `draft/index.html`. Add yourself
 to the list of editors in the preamble of the document (see the [available options](https://github.com/w3c/respec/wiki/person)
@@ -22,6 +17,8 @@ for editor metadata).
 This specification is developed using [ReSpec](https://github.com/w3c/respec) and help about
 its markup can be found in its [user guide](https://github.com/w3c/respec/wiki/ReSpec-Editor's-Guide).
 
+Deploy previews on pull requests are provided by [Netlify](https://www.netlify.com/).
+
 Local setup
 -----------
 

diff --git a/draft/examples/data-extension-metadata/valid/example-full.json b/draft/examples/data-extension-metadata/valid/example-full.json
@@ -1,22 +1,19 @@
 {
-  "propose_properties": {
-    "service_url": "https://lobid.org",
-    "service_path": "/gnd/reconcile/properties"
-  },
-  "property_settings": [
+  "proposeProperties": true,
+  "propertySettings": [
     {
       "id": "limit",
       "name": "Limit",
       "type": "number",
       "default": 0,
-      "help_text": "Maximum number of values to return per row (0 for no limit)"
+      "helpText": "Maximum number of values to return per row (0 for no limit)"
     },
     {
       "id": "content",
       "name": "Content",
       "type": "select",
       "default": "literal",
-      "help_text": "Content type: ID or literal",
+      "helpText": "Content type: ID or literal",
       "choices": [
         {
           "value": "id",

diff --git a/draft/examples/manifest/invalid/feature-view.json b/draft/examples/manifest/invalid/feature-view.json
@@ -3,7 +3,7 @@
     "view": {
         "url": "https://viaf.org/viaf/{id}"
     },
-    "feature_view": {
+    "featureView": {
         "url": "https://vocab.getty.edu/recon/features/"
     }
 }
diff --git a/draft/examples/manifest/invalid/opencorporates.json b/draft/examples/manifest/invalid/opencorporates.json
@@ -9,16 +9,8 @@
     "height": 300
   },
   "suggest": {
-    "entity": {
-      "service_url": "https://opencorporates.com",
-      "service_path": "/reconcile/suggest",
-      "flyout_service_path": "/reconcile/flyout"
-    },
-    "property": {
-      "service_url": "https://opencorporates.com",
-      "service_path": "/reconcile/suggest/properties",
-      "flyout_service_path": "/reconcile/flyout/properties"
-    }
+    "entity": true,
+    "property": true
   },
   "defaultTypes": [
     {

diff --git a/draft/examples/manifest/invalid/ror-invalid-view-pattern.json b/draft/examples/manifest/invalid/ror-invalid-view-pattern.json
@@ -10,11 +10,7 @@
     "url": "https://reconcile.ror.org/reconcile"
   },
   "suggest": {
-    "entity": {
-      "flyout_service_path": "/flyout?id={id}",
-      "service_path": "/suggest",
-      "service_url": "https://reconcile.ror.org"
-    }
+    "entity": true
   },
   "preview": {
     "width": 400,

diff --git a/draft/examples/manifest/invalid/slub-invalid-property-setting.json b/draft/examples/manifest/invalid/slub-invalid-property-setting.json
@@ -38,26 +38,23 @@
     }
   ],
   "extend": {
-    "property_settings": [
+    "propertySettings": [
       {
         "default": 10,
         "help_text": "Maximum number of values to return per row (maximum: 1000)",
-        "name": "Limit",
-        "id": "limit",
+        "label": "Limit",
+        "name": "limit",
         "type": "number"
       },
       {
         "default": "geo,organizations,slub-resources,persons,events,topics,works, ",
         "help_text": "Which Entity-Type to use, allwed values: http://schema.org/CreativeWork, http://schema.org/Work, http://schema.org/Event, http://schema.org/Place, http://schema.org/Person, http://schema.org/Book, http://schema.org/Organization, http://schema.org/Topic, http://schema.org/CreativeWorkSeries",
-        "name": "Typ",
-        "id": "type",
+        "label": "Typ",
+        "name": "type",
         "type": "string"
       }
     ],
-    "propose_properties": {
-      "service_path": "/reconcile/properties",
-      "service_url": "http://data.slub-dresden.de"
-    }
+    "proposeProperties": true
   },
   "name": "SLUB LOD reconciliation for OpenRefine",
   "preview": {

diff --git a/draft/examples/manifest/valid/feature-view.json b/draft/examples/manifest/valid/feature-view.json
@@ -4,7 +4,7 @@
     "view": {
         "url": "https://viaf.org/viaf/{id}"
     },
-    "feature_view": {
+    "featureView": {
         "url": "https://vocab.getty.edu/recon/features/{id}"
     }
 }
diff --git a/draft/examples/manifest/valid/lobid-gnd.json b/draft/examples/manifest/valid/lobid-gnd.json
@@ -49,20 +49,20 @@
     "width": 320
   },
   "extend": {
-    "property_settings": [
+    "propertySettings": [
       {
         "id": "limit",
         "name": "Limit",
         "type": "number",
         "default": 0,
-        "help_text": "Maximum number of values to return per row (0 for no limit)"
+        "helpText": "Maximum number of values to return per row (0 for no limit)"
       },
       {
         "id": "content",
         "name": "Content",
         "type": "select",
         "default": "literal",
-        "help_text": "Content type: ID or literal",
+        "helpText": "Content type: ID or literal",
         "choices": [
           {
             "value": "id",
@@ -75,7 +75,7 @@
         ]
       }
     ],
-    "propose_properties": true
+    "proposeProperties": true
   },
   "suggest": {
     "property": true,

diff --git a/draft/examples/manifest/valid/wikidata.json b/draft/examples/manifest/valid/wikidata.json
@@ -9,10 +9,10 @@
   "logo": "https://tools.wmflabs.org/openrefine-wikidata/logo.png",
   "serviceVersion": "1.2.3",
   "extend": {
-    "property_settings": [
+    "propertySettings": [
       {
-        "id": "limit",
-        "name": "Limit",
+        "name": "limit",
+        "label": "Limit",
         "help_text": "Maximum number of values to return per row (0 for no limit)",
         "type": "number",
         "default": 0
@@ -21,7 +21,7 @@
         "id": "rank",
         "name": "Ranks",
         "type": "select",
-        "help_text": "Filter statements by rank",
+        "helpText": "Filter statements by rank",
         "choices": [
           {
             "name": "Any rank",
@@ -42,7 +42,7 @@
         "id": "references",
         "name": "References",
         "type": "select",
-        "help_text": "Filter statements by their references",
+        "helpText": "Filter statements by their references",
         "choices": [
           {
             "name": "Any statement",
@@ -60,14 +60,14 @@
         "default": "any"
       },
       {
-        "id": "count",
-        "name": "Return counts instead of values",
+        "name": "count",
+        "label": "Return counts instead of values",
         "help_text": "The number of values will be returned.",
         "type": "checkbox",
         "default": false
       }
     ],
-    "propose_properties": true
+    "proposeProperties": true
   },
   "defaultTypes": [
     {
@@ -82,5 +82,6 @@
     "type": true,
     "entity": true,
     "property": true
-  }
+  },
+  "standardizedScore": true
 }
diff --git a/...query-batch/invalid/empty-properties.json → ...query-batch/invalid/empty-conditions.json b/...query-batch/invalid/empty-properties.json → ...query-batch/invalid/empty-conditions.json
@@ -1,7 +1,7 @@
 {
   "queries": [
     {
-      "properties": []
+      "conditions": []
     }
   ]
 }
diff --git a/...uery-batch/invalid/misnamed-property.json → ...ry-batch/invalid/misnamed-conditions.json b/...uery-batch/invalid/misnamed-property.json → ...ry-batch/invalid/misnamed-conditions.json
@@ -1,10 +1,12 @@
 {
   "queries": [
     {
-      "query": "Christel Hanewinckel",
       "type": "DifferentiatedPerson",
       "limit": 5,
       "props": [
+        {
+          "v": "Christel Hanewinckel"
+        },
         {
           "pid": "professionOrOccupation",
           "v": "Politik*"
@@ -13,14 +15,15 @@
           "pid": "affiliation",
           "v": "http://d-nb.info/gnd/2022139-3"
         }
-      ],
-      "type_strict": "should"
+      ]
     },
     {
-      "query": "Franz Thönnes",
       "type": "DifferentiatedPerson",
       "limit": 5,
       "props": [
+        {
+          "v": "Franz Thönnes"
+        },
         {
           "pid": "professionOrOccupation",
           "v": "Politik*"
@@ -29,8 +32,7 @@
           "pid": "affiliation",
           "v": "http://d-nb.info/gnd/2022139-3"
         }
-      ],
-      "type_strict": "should"
+      ]
     }
   ]
 }
diff --git a/draft/examples/reconciliation-query-batch/invalid/missing-match-type.json b/draft/examples/reconciliation-query-batch/invalid/missing-match-type.json
@@ -0,0 +1,18 @@
+{
+  "queries": [
+    {
+      "conditions": [
+        {
+          "v": "Hans-Eberhard Urbaniak"
+        }
+      ]
+    },
+    {
+      "conditions": [
+        {
+          "v": "Ernst Schwanhold"
+        }
+      ]
+    }
+  ]
+}
diff --git a/draft/examples/reconciliation-query-batch/invalid/multiple-types.json b/draft/examples/reconciliation-query-batch/invalid/multiple-types.json
@@ -1,8 +1,16 @@
 {
   "queries": [
     {
-      "query": "Christel Hanewinckel",
-      "type": ["DifferentiatedPerson", "FictionalCharacter"],
+      "conditions": [
+        {
+          "matchType": "name",
+          "v": "Christel Hanewinckel"
+        }
+      ],
+      "type": [
+        "DifferentiatedPerson",
+        "FictionalCharacter"
+      ],
       "limit": 5
     }
   ]

diff --git a/draft/examples/reconciliation-query-batch/invalid/no-root-object.json b/draft/examples/reconciliation-query-batch/invalid/no-root-object.json
@@ -1,8 +1,20 @@
 [
   {
-    "properties": [{"pid":"uid", "v": "27eb892afbb2"}]
+    "conditions": [
+      {
+        "matchType": "property",
+        "pid": "uid",
+        "v": "27eb892afbb2"
+      }
+    ]
   },
   {
-    "properties": [{"pid":"uid", "v": "ab09da9dd37e"}]
+    "conditions": [
+      {
+        "matchType": "property",
+        "pid": "uid",
+        "v": "ab09da9dd37e"
+      }
+    ]
   }
 ]