From 9358c78950136af238c8d291dbc5a2ce99a3a9f3 Mon Sep 17 00:00:00 2001
From: Simon Harrer <simon.harrer@gmail.com>
Date: Tue, 25 Mar 2025 15:40:45 +0100
Subject: [PATCH] Update YAML and JSON files to replace 'comment' with
 'description' for user entries

---
 CHANGELOG.md                             | 1 +
 docs/README.md                           | 3 ++-
 docs/examples/all/full-example.odcs.yaml | 2 +-
 schema/odcs-json-schema-latest.json      | 4 ++++
 schema/odcs-json-schema-v3.0.2.json      | 4 ++++
 5 files changed, 12 insertions(+), 2 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 497f34d..8a755c4 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -11,6 +11,7 @@ This document tracks the history and evolution of the **Open Data Contract Stand
 * Added field `physicalName` for the properties in JSON schema.
 * Explicitly specifies `YYYY-MM-DDTHH:mm:ss.SSSZ` for default date format.
 * Added field `name` team members in JSON schema and docs.
+* Added field `description` team members in JSON schema and docs.
 
 # v3.0.1 - 2024-12-22 - APPROVED
 
diff --git a/docs/README.md b/docs/README.md
index 9ce82f8..a8e859f 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -642,7 +642,7 @@ team:
     dateIn: 2022-10-01
   - username: daustin
     role: Owner
-    comment: Keeper of the grail
+    description: Keeper of the grail
     name: David Austin
     dateIn: 2022-10-01
 ```
@@ -655,6 +655,7 @@ The UX label is the label used in the UI and other user experiences.
 | team                    | Team                 | No       | Object                                                                                     |
 | team.username           | Username             | No       | The user's username or email.                                                              |
 | team.name               | Name                 | No       | The user's name.                                                                           |
+| team.description        | Description          | No       | The user's name.                                                                           |
 | team.role               | Role                 | No       | The user's job role; Examples might be owner, data steward. There is no limit on the role. |
 | team.dateIn             | Date In              | No       | The date when the user joined the team.                                                    |
 | team.dateOut            | Date Out             | No       | The date when the user ceased to be part of the team.                                      |
diff --git a/docs/examples/all/full-example.odcs.yaml b/docs/examples/all/full-example.odcs.yaml
index 07eab11..55be999 100644
--- a/docs/examples/all/full-example.odcs.yaml
+++ b/docs/examples/all/full-example.odcs.yaml
@@ -154,7 +154,7 @@ team:
     dateIn: "2022-10-01"
   - username: daustin
     role: Owner
-    comment: Keeper of the grail
+    description: Keeper of the grail
     dateIn: "2022-10-01"
 
 
diff --git a/schema/odcs-json-schema-latest.json b/schema/odcs-json-schema-latest.json
index 5e3a173..cb9bfb9 100644
--- a/schema/odcs-json-schema-latest.json
+++ b/schema/odcs-json-schema-latest.json
@@ -2214,6 +2214,10 @@
             "Jane Doe"
           ]
         },
+        "description": {
+          "type": "string",
+          "description": "The user's description."
+        },
         "role": {
           "type": "string",
           "description": "The user's job role; Examples might be owner, data steward. There is no limit on the role."
diff --git a/schema/odcs-json-schema-v3.0.2.json b/schema/odcs-json-schema-v3.0.2.json
index 5e3a173..cb9bfb9 100644
--- a/schema/odcs-json-schema-v3.0.2.json
+++ b/schema/odcs-json-schema-v3.0.2.json
@@ -2214,6 +2214,10 @@
             "Jane Doe"
           ]
         },
+        "description": {
+          "type": "string",
+          "description": "The user's description."
+        },
         "role": {
           "type": "string",
           "description": "The user's job role; Examples might be owner, data steward. There is no limit on the role."