Merge pull request #166 from pflooky/feature/update-teams

Feature/update teams

Author: jgperrin

CHANGELOG.md

@@ -35,6 +35,9 @@ This document tracks the history and evolution of the **Open Data Contract Stand
     * `slaProperties`
     * `support`
     * `team`
+  * Alter `team` to be an object instead of an array.
+    * Adds `name`, `description`, `members`, `tags`, `customProperties`, `authoritativeDefinitions` fields to `team`.
+    * Adds `tags`, `customProperties`, `authoritativeDefinitions` fields to `team.members`.
 * **Changes** to logicalType and logicalTypeOptions:
   * Add `timestamp` and `time` to `logicalType` options.
   * Add `timezone` and `defaultTimezone` to `logicalTypeOptions` options for `timestamp` and `time`.

docs/examples/all/full-example.odcs.yaml

@@ -5,6 +5,11 @@ version: 1.1.0 # Version (follows semantic versioning)
 status: active
 id: 53581432-6c55-4ba2-a65f-72344a91553a
 
+authoritativeDefinitions:
+- type: canonical
+  url: https://github.com/bitol-io/open-data-contract-standard/blob/main/docs/examples/all/full-example.odcs.yaml
+  description: Canonical URL to the latest version of the contract.
+  
 # Lots of information
 description:
   purpose: Views built on top of the seller tables.
@@ -27,7 +32,7 @@ servers:
     database: pypl-edw
     schema: pp_access_views
 
-# Dataset, schema and quality
+# Dataset, schema, and quality
 schema:
   - name: tbl
     physicalName: tbl_1
@@ -215,18 +220,21 @@ price:
 
 # Team
 team:
-  - username: ceastwood
-    role: Data Scientist
-    dateIn: "2022-08-02"
-    dateOut: "2022-10-01"
-    replacedByUsername: mhopper
-  - username: mhopper
-    role: Data Scientist
-    dateIn: "2022-10-01"
-  - username: daustin
-    role: Owner
-    description: Keeper of the grail
-    dateIn: "2022-10-01"
+  name: my-team
+  description: The team owning the data contract
+  members:
+    - username: ceastwood
+      role: Data Scientist
+      dateIn: "2022-08-02"
+      dateOut: "2022-10-01"
+      replacedByUsername: mhopper
+    - username: mhopper
+      role: Data Scientist
+      dateIn: "2022-10-01"
+    - username: daustin
+      role: Owner
+      description: Keeper of the grail
+      dateIn: "2022-10-01"
 
 
 # Roles

docs/examples/stakeholders/basic-four-dpo.odcs.yaml

@@ -7,22 +7,35 @@ name: my_table
 dataProduct: my_quantum
 schema: [ ]
 team:
-  - username: ceastwood
-    role: dpo
-    dateIn: "2014-08-02"
-    dateOut: "2014-10-01"
-    replacedByUsername: jwayne
-  - username: jwayne
-    role: dpo
-    dateIn: "2014-10-01"
-    dateOut: "2019-03-14"
-    replacedByUsername: cjane
-  - username: cjane
-    role: dpo
-    dateIn: "2019-03-14"
-    description: Minor interruption due to sabbatical, will be back by end of April 2021
-    dateOut: "2021-04-01"
-    replacedByUsername: bkid
-  - username: bkid
-    role: dpo
-    dateIn: "2021-04-01"
+  name: Data Protection Office
+  description: The Data Protection Office is responsible for the protection of data.
+  tags:
+    - data-protection
+    - dpo
+  customProperties:
+    - property: dpo-policy
+      value: "DPO policy"
+  authoritativeDefinitions:
+    - url: https://my-company-data-policy.com
+      type: businessDefinition
+      description: "Full definition of the data protection policy."
+  members:
+    - username: ceastwood
+      role: dpo
+      dateIn: "2014-08-02"
+      dateOut: "2014-10-01"
+      replacedByUsername: jwayne
+    - username: jwayne
+      role: dpo
+      dateIn: "2014-10-01"
+      dateOut: "2019-03-14"
+      replacedByUsername: cjane
+    - username: cjane
+      role: dpo
+      dateIn: "2019-03-14"
+      description: Minor interruption due to sabbatical, will be back by end of April 2021
+      dateOut: "2021-04-01"
+      replacedByUsername: bkid
+    - username: bkid
+      role: dpo
+      dateIn: "2021-04-01"

schema/odcs-json-schema-v3.1.0.json

@@ -96,10 +96,7 @@
         "$ref": "#/$defs/Pricing"
       },
       "team": {
-        "type": "array",
-        "items": {
-          "$ref": "#/$defs/Team"
-        }
+        "$ref": "#/$defs/Team"
       },
       "roles": {
         "type": "array",
@@ -2392,23 +2389,18 @@
         },
         "additionalProperties": false
       },
-      "Team": {
+      "TeamMember": {
         "type": "object",
+        "description": "Team member information.",
+        "additionalProperties": false,
         "properties": {
           "username": {
             "type": "string",
-            "description": "The user's username or email.",
-            "examples": [
-              "mail@example.com",
-              "uid12345678"
-            ]
+            "description": "The user's username or email."
           },
           "name": {
             "type": "string",
-            "description": "The user's name.",
-            "examples": [
-              "Jane Doe"
-            ]
+            "description": "The user's name."
           },
           "description": {
             "type": "string",
@@ -2431,9 +2423,57 @@
           "replacedByUsername": {
             "type": "string",
             "description": "The username of the user who replaced the previous user."
+          },
+          "tags": {
+            "$ref": "#/$defs/Tags"
+          },
+          "customProperties": {
+            "type": "array",
+            "description": "Custom properties block.",
+            "items": {
+              "$ref": "#/$defs/CustomProperty"
+            }
+          },
+          "authoritativeDefinitions": {
+            "$ref": "#/$defs/AuthoritativeDefinitions"
           }
         },
-        "additionalProperties": false
+        "required": ["username"]
+      },
+      "Team": {
+        "type": "object",
+        "description": "Team information.",
+        "additionalProperties": false,
+        "properties": {
+          "name": {
+            "type": "string",
+            "description": "Team name."
+          },
+          "description": {
+            "type": "string",
+            "description": "Team description."
+          },
+          "members": {
+            "type": "array",
+            "description": "List of members.",
+            "items": {
+              "$ref": "#/$defs/TeamMember"
+            }
+          },
+          "tags": {
+            "$ref": "#/$defs/Tags"
+          },
+          "customProperties": {
+            "type": "array",
+            "description": "Custom properties block.",
+            "items": {
+              "$ref": "#/$defs/CustomProperty"
+            }
+          },
+          "authoritativeDefinitions": {
+            "$ref": "#/$defs/AuthoritativeDefinitions"
+          }
+        }
       },
       "Role": {
         "type": "object",