Update model.py and schema.json to enhance quality checks; bump version to 1.2.1

Author: jochenchrist

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "datacontract-specification"
-version = "1.2.0" # in sync with spec
+version = "1.2.1" # in sync with spec
 description = "The Pydantic Model of the Data Contract Specification"
 readme = "README.md"
 authors = [

src/datacontract_specification/model.py

@@ -172,14 +172,16 @@ class Definition(pyd.BaseModel):
 class Quality(pyd.BaseModel):
     type: str | None = None
     description: str | None = None
+    metric: str | None = None
+    arguments: Dict[str, Any] | None = None
     query: str | None = None
     dialect: str | None = None
     mustBe: float | int | None = None
     mustNotBe: float | int | None = None
     mustBeGreaterThan: float | int | None = None
-    mustBeGreaterThanOrEqualTo: float | int | None = None
+    mustBeGreaterOrEqualTo: float | int | None = None
     mustBeLessThan: float | int | None = None
-    mustBeLessThanOrEqualTo: float | int | None = None
+    mustBeLessOrEqualTo: float | int | None = None
     mustBeBetween: List[float | int] = None
     mustNotBeBetween: List[float | int] = None
     engine: str | None = None

src/datacontract_specification/schema.json

@@ -7,6 +7,7 @@
       "type": "string",
       "title": "DataContractSpecificationVersion",
       "enum": [
+        "1.2.1",
         "1.2.0",
         "1.1.0",
         "0.9.3",
@@ -1816,13 +1817,21 @@
               "mustBeGreaterThan": {
                 "type": "number"
               },
-              "mustBeGreaterThanOrEqualTo": {
+              "mustBeGreaterOrEqualTo": {
                 "type": "number"
               },
+              "mustBeGreaterThanOrEqualTo": {
+                "type": "number",
+                "deprecated": true
+              },
               "mustBeLessThan": {
                 "type": "number"
               },
               "mustBeLessThanOrEqualTo": {
+                "type": "number",
+                "deprecated": true
+              },
+              "mustBeLessOrEqualTo": {
                 "type": "number"
               },
               "mustBeBetween": {
@@ -1849,18 +1858,42 @@
         },
         {
           "if": {
-            "properties": {
-              "type": {
-                "const": "library"
+            "anyOf": [
+              {
+                "properties": {
+                  "type": {
+                    "const": "library"
+                  }
+                }
+              },
+              {
+                "properties": {
+                  "metric": {
+                    "type": "string"
+                  }
+                },
+                "required": ["metric"]
               }
-            }
+            ]
           },
           "then": {
             "properties": {
+              "metric": {
+                "type": "string",
+                "description": "The DataQualityLibrary metric to use for the quality check.",
+                "enum": ["nullValues", "missingValues", "invalidValues", "duplicateValues", "rowCount"]
+              },
               "rule": {
                 "type": "string",
-                "description": "Define a data quality check based on the predefined rules as per ODCS.",
-                "examples": ["duplicateCount", "validValues", "rowCount"]
+                "deprecated": true,
+                "description": "Deprecated. Use metric instead"
+              },
+              "arguments": {
+                "type": "object",
+                "description": "Additional metric-specific parameters for the quality check.",
+                "additionalProperties": {
+                  "type": ["string", "number", "boolean", "array", "object"]
+                }
               },
               "mustBe": {
                 "description": "Must be equal to the value to be valid. When using numbers, it is equivalent to '='."
@@ -1906,7 +1939,7 @@
               }
             },
             "required": [
-              "rule"
+              "metric"
             ]
           }
         },
@@ -2022,4 +2055,4 @@
       ]
     }
   }
-}
+}