Merge pull request #165 from reconciliation-api/164-fix-data-extensio…

…n-property-settings Fix inconsistency of field names in data extension settings
reconciliation-api · Jun 13, 2024 · ea08452 · ea08452
2 parents 55ce38e + b9cfd4f
commit ea08452
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 32 deletions.
diff --git a/draft/examples/data-extension-metadata/valid/example-full.json b/draft/examples/data-extension-metadata/valid/example-full.json
@@ -2,15 +2,15 @@
   "proposeProperties": true,
   "propertySettings": [
     {
-      "name": "limit",
-      "label": "Limit",
+      "id": "limit",
+      "name": "Limit",
       "type": "number",
       "default": 0,
       "helpText": "Maximum number of values to return per row (0 for no limit)"
     },
     {
-      "name": "content",
-      "label": "Content",
+      "id": "content",
+      "name": "Content",
       "type": "select",
       "default": "literal",
       "helpText": "Content type: ID or literal",

diff --git a/draft/examples/manifest/invalid/slub-invalid-property-setting.json b/draft/examples/manifest/invalid/slub-invalid-property-setting.json
@@ -42,15 +42,15 @@
       {
         "default": 10,
         "helpText": "Maximum number of values to return per row (maximum: 1000)",
-        "label": "Limit",
-        "name": "limit",
+        "name": "Limit",
+        "id": "limit",
         "type": "number"
       },
       {
         "default": "geo,organizations,slub-resources,persons,events,topics,works, ",
         "helpText": "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",
-        "label": "Typ",
-        "name": "type",
+        "name": "Typ",
+        "id": "type",
         "type": "string"
       }
     ],

diff --git a/draft/examples/manifest/valid/lobid-gnd.json b/draft/examples/manifest/valid/lobid-gnd.json
@@ -51,15 +51,15 @@
   "extend": {
     "propertySettings": [
       {
-        "name": "limit",
-        "label": "Limit",
+        "id": "limit",
+        "name": "Limit",
         "type": "number",
         "default": 0,
         "helpText": "Maximum number of values to return per row (0 for no limit)"
       },
       {
-        "name": "content",
-        "label": "Content",
+        "id": "content",
+        "name": "Content",
         "type": "select",
         "default": "literal",
         "helpText": "Content type: ID or literal",

diff --git a/draft/examples/manifest/valid/wikidata.json b/draft/examples/manifest/valid/wikidata.json
@@ -11,15 +11,15 @@
   "extend": {
     "propertySettings": [
       {
-        "name": "limit",
-        "label": "Limit",
+        "id": "limit",
+        "name": "Limit",
         "helpText": "Maximum number of values to return per row (0 for no limit)",
         "type": "number",
         "default": 0
       },
       {
-        "name": "rank",
-        "label": "Ranks",
+        "id": "rank",
+        "name": "Ranks",
         "type": "select",
         "helpText": "Filter statements by rank",
         "choices": [
@@ -39,8 +39,8 @@
         "default": "best"
       },
       {
-        "name": "references",
-        "label": "References",
+        "id": "references",
+        "name": "References",
         "type": "select",
         "helpText": "Filter statements by their references",
         "choices": [
@@ -60,8 +60,8 @@
         "default": "any"
       },
       {
-        "name": "count",
-        "label": "Return counts instead of values",
+        "id": "count",
+        "name": "Return counts instead of values",
         "helpText": "The number of values will be returned.",
         "type": "checkbox",
         "default": false

diff --git a/draft/index.html b/draft/index.html
@@ -818,10 +818,10 @@ <h3>Data Extension Metadata</h3>
         <p>
           A <dfn>data extension property setting</dfn> consists of:
           <dl>
-	    <dt><code>name</code></dt>
-            <dd>A name for the setting, which identifies the setting uniquely;</dd>
-            <dt><code>label</code></dt>
-	    <dd>A human-readable label, which is used when presenting the setting to the user in a form;</dd>
+	    <dt><code>id</code></dt>
+            <dd>A unique identifier for the setting;</dd>
+            <dt><code>name</code></dt>
+	    <dd>A human-readable name, which is used when presenting the setting to the user in a form;</dd>
 	    <dt><code>type</code></dt>
             <dd>A data type, which can be one of the strings <code>"number"</code>, <code>"text"</code>, <code>"checkbox"</code>, or <code>"select"</code>. This determines which type of value the property setting is expected to store: clients SHOULD render this setting with the corresponding HTML element;</li>
 	    <dt><code>default</code></dt>

diff --git a/draft/schemas/manifest.json b/draft/schemas/manifest.json
@@ -128,7 +128,7 @@
                   "default": {
                     "type": "number"
                   },
-                  "label": {
+                  "id": {
                     "type": "string"
                   },
                   "name": {
@@ -140,7 +140,7 @@
                 },
                 "required": [
                   "type",
-                  "label",
+                  "id",
                   "name"
                 ]
               },
@@ -157,7 +157,7 @@
                   "default": {
                     "type": "string"
                   },
-                  "label": {
+                  "id": {
                     "type": "string"
                   },
                   "name": {
@@ -169,7 +169,7 @@
                 },
                 "required": [
                   "type",
-                  "label",
+                  "id",
                   "name"
                 ]
               },
@@ -186,7 +186,7 @@
                   "default": {
                     "type": "boolean"
                   },
-                  "label": {
+                  "id": {
                     "type": "string"
                   },
                   "name": {
@@ -198,7 +198,7 @@
                 },
                 "required": [
                   "type",
-                  "label",
+                  "id",
                   "name"
                 ]
               },
@@ -215,7 +215,7 @@
                   "default": {
                     "type": "string"
                   },
-                  "label": {
+                  "id": {
                     "type": "string"
                   },
                   "name": {
@@ -245,7 +245,7 @@
                 },
                 "required": [
                   "type",
-                  "label",
+                  "id",
                   "name",
                   "choices"
                 ]