Merge pull request #24 from pflooky/dev-authoritative-fix

Add in missing changelog notes, fix for authoritativeDefinitions

Author: jgperrin

CHANGELOG.md

@@ -1,10 +1,11 @@
 This document tracks the history and evolution of the **Open Data Contract Standard**.
 
-# v2.2.1 - 2023-10-03 - OPEN
+# v2.2.1 - 2023-12-15 - OPEN
 
-* Reformat Markdown tables.
-* Reformat quality examples to be valid YAML.
-* Added JSON schema for v2.2.1.
+* Reformat Markdown tables
+* Reformat quality examples to be valid YAML
+* Add in isUnique, primaryKeyPosition, partitionKeyPosition and clusterKeyPosition to `column` definition
+* Add [JSON schema](schema/odcs-json-schema.json) to validate YAML files for v2.2.1.
 * Integrated as part of [Bitol](https://lfaidata.foundation/projects/bitol/).
 
 # v2.2.0 - 2023-07-27 - APPROVED

schema/odcs-json-schema.json

@@ -130,7 +130,7 @@
     "datasetDomain": {
       "type": "string",
       "description": "Name of the logical domain dataset the contract describes. This field is only required for output data contracts.",
-      "examples": ["imdb_ds_aggregate", "receiver_profile_out",  "transaction_profile_out"]
+      "examples": ["imdb_ds_aggregate", "receiver_profile_out", "transaction_profile_out"]
     },
     "database": {
       "type": "string",
@@ -196,23 +196,7 @@
           }
         },
         "authoritativeDefinitions": {
-          "type": "array",
-          "description": "List of links to sources that provide more details on the table; examples would be a link to an external definition, a training video, a GitHub repo, Collibra, or another tool. Authoritative definitions follow the same structure in the standard.",
-          "items": {
-            "type": "object",
-            "properties": {
-              "url": {
-                "type": "string",
-                "description": "URL to the authority."
-              },
-              "type": {
-                "type": "string",
-                "description": "Type of definition for authority: v2.3 adds standard values: `businessDefinition`, `transformationImplementation`, `videoTutorial`, `tutorial`, and `implementation`.",
-                "examples": ["businessDefinition", "transformationImplementation", "videoTutorial", "tutorial", "implementation"]
-              }
-            },
-            "required": ["url", "type"]
-          }
+          "$ref": "#/$defs/AuthoritativeDefinitions"
         },
         "dataGranularity": {
           "type": "string",
@@ -304,8 +288,7 @@
           "examples": ["confidential", "restricted", "public"]
         },
         "authoritativeDefinitions": {
-          "type": "string",
-          "description": "List of links to sources that provide more detail on column logic or values; examples would be URL to a GitHub repo, Collibra, on another tool."
+          "$ref": "#/$defs/AuthoritativeDefinitions"
         },
         "encryptedColumnName": {
           "type": "string",
@@ -409,6 +392,25 @@
       },
       "required": ["templateName", "toolName"]
     },
+    "AuthoritativeDefinitions": {
+      "type": "array",
+      "description": "List of links to sources that provide more details on the table; examples would be a link to an external definition, a training video, a GitHub repo, Collibra, or another tool. Authoritative definitions follow the same structure in the standard.",
+      "items": {
+        "type": "object",
+        "properties": {
+          "url": {
+            "type": "string",
+            "description": "URL to the authority."
+          },
+          "type": {
+            "type": "string",
+            "description": "Type of definition for authority: v2.3 adds standard values: `businessDefinition`, `transformationImplementation`, `videoTutorial`, `tutorial`, and `implementation`.",
+            "examples": ["businessDefinition", "transformationImplementation", "videoTutorial", "tutorial", "implementation"]
+          }
+        },
+        "required": ["url", "type"]
+      }
+    },
     "Pricing": {
       "type": "object",
       "properties": {