Updated changelog to reflect changes to JSON schema, moved tags updat…

…ed description from v3.0.0 to v3.0.1
bitol-io · Jan 3, 2025 · e375f66 · e375f66
1 parent ce76d0b
commit e375f66
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,12 +8,13 @@ This document tracks the history and evolution of the **Open Data Contract Stand
 
 # v3.0.1 - 2024-12-22 - APPROVED
 
-* Added field `authoritativeDefinitions`
-* Added field `description.customProperties`
-* Added field `description.authoritativeDefinitions`
-* Added field `role.customProperties`
+* Added field `authoritativeDefinitions` into JSON schema
+* Added field `description.customProperties`  into JSON schema
+* Added field `description.authoritativeDefinitions`  into JSON schema
+* Added field `role.customProperties`  into JSON schema
 * Updated `status` field to include examples
 * Updated `authoritativeDefinitions` description to be vendor agnostic
+* Updated `tags` description and included examples
 
 # v3.0.0 - 2024-10-21 - APPROVED
 

diff --git a/docs/README.md b/docs/README.md
@@ -224,7 +224,7 @@ schema:
 | physicalName             | Physical Name                | No       | Physical name.                                                                                                                                                                                                                |
 | description              | Description                  | No       | Description of the element.                                                                                                                                                                                                   |
 | businessName             | Business Name                | No       | The business name of the element.                                                                                                                                                                                             |
-| authoritativeDefinitions | Authoritative Definitions    | No       | 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. See `authoritativeDefinitions` below.        |
+| authoritativeDefinitions | Authoritative Definitions    | No       | List of links to sources that provide more details on the element; examples would be a link to privacy statement, terms and conditions, license agreements, data catalog, or another tool.                                    |
 | quality                  | Quality                      | No       | List of data quality attributes.                                                                                                                                                                                              |
 | tags                     | Tags                         | No       | A list of tags that may be assigned to the elements (object or property); the tags keyword may appear at any level. Tags may be used to better categorize an element. For example, `finance`, `sensitive`, `employee_record`. |
 | customProperties         | Custom Properties            | No       | Custom properties that are not part of the standard.                                                                                                                                                                          |

diff --git a/schema/odcs-json-schema-v3.0.0.json b/schema/odcs-json-schema-v3.0.0.json
@@ -1901,7 +1901,7 @@
     },
     "Tags": {
       "type": "array",
-      "description": "A list of tags that may be assigned to the elements (object or property); the tags keyword may appear at any level. Tags may be used to better categorize an element. For example, `finance`, `sensitive`, `employee_record`.",
+      "description": "A list of tags that may be assigned to the elements (object or property); the tags keyword may appear at any level.",
       "items": {
         "type": "string"
       }

diff --git a/schema/odcs-json-schema-v3.0.1.json b/schema/odcs-json-schema-v3.0.1.json
@@ -1912,7 +1912,8 @@
     },
     "Tags": {
       "type": "array",
-      "description": "A list of tags that may be assigned to the elements (object or property); the tags keyword may appear at any level.",
+      "description": "A list of tags that may be assigned to the elements (object or property); the tags keyword may appear at any level. Tags may be used to better categorize an element. For example, `finance`, `sensitive`, `employee_record`.",
+      "examples": ["finance", "sensitive", "employee_record"],
       "items": {
         "type": "string"
       }