Use string objects in property proposals, update changelog (#138)

Also add `description` to spec and example (was in schema already)
reconciliation-api · Oct 9, 2024 · 1878f2b · 1878f2b
1 parent 1398197
commit 1878f2b
Show file tree

Hide file tree

Showing 3 changed files with 63 additions and 12 deletions.
diff --git a/draft/examples/data-extension-property-proposal/valid/response.json b/draft/examples/data-extension-property-proposal/valid/response.json
@@ -4,23 +4,68 @@
   "properties": [
     {
       "id": "affiliation",
-      "name": "Affiliation"
+      "name": [
+        {
+          "str": "Affiliation"
+        }
+      ],
+      "description": [
+        {
+          "str": "A corporate body associated with a person or group of persons."
+        }
+      ]
     },
     {
       "id": "geographicAreaCode",
-      "name": "Ländercode"
+      "name": [
+        {
+          "str": "Geographic Area Code",
+          "lang": "en"
+        },
+        {
+          "str": "Ländercode",
+          "lang": "de"
+        }
+      ]
     },
     {
       "id": "preferredName",
-      "name": "Bevorzugter Name"
+      "name": [
+        {
+          "str": "Preferred name",
+          "lang": "en"
+        },
+        {
+          "str": "Bevorzugter Name",
+          "lang": "de"
+        }
+      ]
     },
     {
       "id": "professionOrOccupation",
-      "name": "Beruf oder Beschäftigung"
+      "name": [
+        {
+          "str": "Profession or occupation",
+          "lang": "en"
+        },
+        {
+          "str": "Beruf oder Beschäftigung",
+          "lang": "de"
+        }
+      ]
     },
     {
       "id": "variantName",
-      "name": "Varianter Name"
+      "name": [
+        {
+          "str": "Variant name",
+          "lang": "en"
+        },
+        {
+          "str": "Varianter Name",
+          "lang": "de"
+        }
+      ]
     }
   ]
-}
+}
diff --git a/draft/index.html b/draft/index.html
@@ -242,7 +242,7 @@ <h4>This Draft</h4>
             <li><a href="https://github.com/reconciliation-api/specs/pull/149">Move the <code>query</code> field of reconciliation queries inside <code>properties</code> to allow for queries which do not provide entity names</a></li>
             <li><a href="https://github.com/reconciliation-api/specs/pull/156">Add optional <code>standardizedScore</code> field to the manifest</a></li>
             <li><a href="https://github.com/reconciliation-api/specs/pull/166">Unify naming to camelCase convention</a></li>
-            <li><a href="https://github.com/reconciliation-api/specs/pull/176">Change candidate <code>name</code> and <code>description</code> from string to array of objects with required <code>str</code>, optional <code>lang</code> and <code>dir</code> fields</a></li>
+            <li><a href="https://github.com/reconciliation-api/specs/pull/176">For objects selected by users (candidates, suggest responses, property proposals), change <code>name</code> and <code>description</code> from string to array of objects with required <code>str</code>, optional <code>lang</code> and <code>dir</code> fields</a></li>
           </ul>
         </section>
       </section>
@@ -868,7 +868,7 @@ <h3>Data Extension Property Proposals</h3>
           A <dfn>data extension property proposal response</dfn> consists of:
           <dl>
             <dt><code>properties</code></dt>
-            <dd>An array of proposed <a>properties</a>. These properties are suggested as fields that could be potentially fetched via data extension for entities of the type provided in the query;</dd>
+            <dd>An array of objects representing the proposed <a>properties</a>, each containing an <code>id</code> (as a string), a <code>name</code> and optionally a <code>description</code> (both as an array of <a>string objects</a>). These properties are suggested as fields that could be potentially fetched via data extension for entities of the type provided in the query;</dd>
             <dt><code>type</code></dt>
             <dd>The <a>type</a> identifier supplied in the query;</dd>
             <dt><code>limit</code></dt>

diff --git a/draft/schemas/data-extension-property-proposal.json b/draft/schemas/data-extension-property-proposal.json
@@ -14,12 +14,18 @@
             "description": "Identifier of the suggested property"
           },
           "name": {
-            "type": "string",
-            "description": "Name of the suggested property"
+            "type": "array",
+            "description": "Name of the suggested property",
+            "items": {
+              "$ref": "string-object.json"
+            }
           },
           "description": {
-            "type": "string",
-            "description": "An optional description which can be provided to disambiguate namesakes, providing more context."
+            "type": "array",
+            "description": "An optional description which can be provided to disambiguate namesakes, providing more context.",
+            "items": {
+              "$ref": "string-object.json"
+            }
           }
         },
         "required": [