Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit f8eedae

Browse files
committedMar 25, 2025
Update JSON schema and documentation to include 'name' field for team members and increment apiVersion to v3.0.2
1 parent ec43113 commit f8eedae

File tree

4 files changed

+32
-8
lines changed

4 files changed

+32
-8
lines changed
 

‎CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ This document tracks the history and evolution of the **Open Data Contract Stand
1010

1111
* Added field `physicalName` for the properties in JSON schema.
1212
* Explicitly specifies `YYYY-MM-DDTHH:mm:ss.SSSZ` for default date format.
13+
* Added field `name` team members in JSON schema and docs.
1314

1415
# v3.0.1 - 2024-12-22 - APPROVED
1516

‎docs/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ This section contains general information about the contract.
4343
### Example
4444

4545
```YAML
46-
apiVersion: v3.0.1 # Standard version
46+
apiVersion: v3.0.2 # Standard version
4747
kind: DataContract
4848

4949
id: 53581432-6c55-4ba2-a65f-72344a91553a
@@ -66,7 +66,7 @@ tags: ['finance']
6666
6767
| Key | UX label | Required | Description |
6868
|--------------------------------------|---------------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
69-
| apiVersion | Standard version | Yes | Version of the standard used to build data contract. Default value is `v3.0.1`. |
69+
| apiVersion | Standard version | Yes | Version of the standard used to build data contract. Default value is `v3.0.2`. |
7070
| kind | Kind | Yes | The kind of file this is. Valid value is `DataContract`. |
7171
| id | ID | Yes | A unique identifier used to reduce the risk of dataset name collisions, such as a UUID. |
7272
| name | Name | No | Name of the data contract. |
@@ -299,7 +299,7 @@ kind: DataContract
299299
id: 53581432-6c55-4ba2-a65f-72344a91553a
300300
status: active
301301
name: date_example
302-
apiVersion: v3.0.1
302+
apiVersion: v3.0.2
303303
schema:
304304
# Date Only
305305
- name: event_date
@@ -654,6 +654,7 @@ The UX label is the label used in the UI and other user experiences.
654654
|-------------------------|----------------------|----------|--------------------------------------------------------------------------------------------|
655655
| team | Team | No | Object |
656656
| team.username | Username | No | The user's username or email. |
657+
| team.name | Name | No | The user's name. |
657658
| team.role | Role | No | The user's job role; Examples might be owner, data steward. There is no limit on the role. |
658659
| team.dateIn | Date In | No | The date when the user joined the team. |
659660
| team.dateOut | Date Out | No | The date when the user ceased to be part of the team. |

‎schema/odcs-json-schema-latest.json

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@
1616
},
1717
"apiVersion": {
1818
"type": "string",
19-
"default": "v3.0.1",
20-
"description": "Version of the standard used to build data contract. Default value is v3.0.1.",
21-
"enum": ["v3.0.1", "v3.0.0", "v2.2.2", "v2.2.1", "v2.2.0"]
19+
"default": "v3.0.2",
20+
"description": "Version of the standard used to build data contract. Default value is v3.0.2.",
21+
"enum": ["v3.0.2","v3.0.1", "v3.0.0", "v2.2.2", "v2.2.1", "v2.2.0"]
2222
},
2323
"id": {
2424
"type": "string",
@@ -2201,7 +2201,18 @@
22012201
"properties": {
22022202
"username": {
22032203
"type": "string",
2204-
"description": "The user's username or email."
2204+
"description": "The user's username or email.",
2205+
"examples": [
2206+
"mail@example.com",
2207+
"uid12345678"
2208+
]
2209+
},
2210+
"name": {
2211+
"type": "string",
2212+
"description": "The user's name.",
2213+
"examples": [
2214+
"Jane Doe"
2215+
]
22052216
},
22062217
"role": {
22072218
"type": "string",

‎schema/odcs-json-schema-v3.0.2.json

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2201,7 +2201,18 @@
22012201
"properties": {
22022202
"username": {
22032203
"type": "string",
2204-
"description": "The user's username or email."
2204+
"description": "The user's username or email.",
2205+
"examples": [
2206+
"mail@example.com",
2207+
"uid12345678"
2208+
]
2209+
},
2210+
"name": {
2211+
"type": "string",
2212+
"description": "The user's name.",
2213+
"examples": [
2214+
"Jane Doe"
2215+
]
22052216
},
22062217
"role": {
22072218
"type": "string",

0 commit comments

Comments
 (0)