repo-mirrors/open-data-contract-standard
1
0
Fork 0
mirror of https://github.com/bitol-io/open-data-contract-standard.git synced 2025-05-28 19:34:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update JSON schema and documentation to include 'name' field for team members and increment apiVersion to v3.0.2

Browse Source
This commit is contained in:
Simon Harrer
2025-03-25 15:25:54 +01:00
parent ec43113b18
commit f8eedaee02
4 changed files with 32 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@@ -10,6 +10,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.
# v3.0.1 - 2024-12-22 - APPROVED

7
docs/README.md
View File

@@ -43,7 +43,7 @@ This section contains general information about the contract.
### Example
```YAML
apiVersion: v3.0.1 # Standard version
apiVersion: v3.0.2 # Standard version
kind: DataContract
id: 53581432-6c55-4ba2-a65f-72344a91553a
@@ -66,7 +66,7 @@ tags: ['finance']
| Key | UX label | Required | Description |
|--------------------------------------|---------------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| apiVersion | Standard version | Yes | Version of the standard used to build data contract. Default value is `v3.0.1`. |
| apiVersion | Standard version | Yes | Version of the standard used to build data contract. Default value is `v3.0.2`. |
| kind | Kind | Yes | The kind of file this is. Valid value is `DataContract`. |
| id | ID | Yes | A unique identifier used to reduce the risk of dataset name collisions, such as a UUID. |
| name | Name | No | Name of the data contract. |
@@ -299,7 +299,7 @@ kind: DataContract
id: 53581432-6c55-4ba2-a65f-72344a91553a
status: active
name: date_example
apiVersion: v3.0.1
apiVersion: v3.0.2
schema:
# Date Only
- name: event_date
@@ -654,6 +654,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.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. |

19
schema/odcs-json-schema-latest.json
View File

@@ -16,9 +16,9 @@
},
"apiVersion": {
"type": "string",
"default": "v3.0.1",
"description": "Version of the standard used to build data contract. Default value is v3.0.1.",
"enum": ["v3.0.1", "v3.0.0", "v2.2.2", "v2.2.1", "v2.2.0"]
"default": "v3.0.2",
"description": "Version of the standard used to build data contract. Default value is v3.0.2.",
"enum": ["v3.0.2","v3.0.1", "v3.0.0", "v2.2.2", "v2.2.1", "v2.2.0"]
},
"id": {
"type": "string",
@@ -2201,7 +2201,18 @@
"properties": {
"username": {
"type": "string",
"description": "The user's username or email."
"description": "The user's username or email.",
"examples": [
"mail@example.com",
"uid12345678"
]
},
"name": {
"type": "string",
"description": "The user's name.",
"examples": [
"Jane Doe"
]
},
"role": {
"type": "string",

13
schema/odcs-json-schema-v3.0.2.json
View File

@@ -2201,7 +2201,18 @@
"properties": {
"username": {
"type": "string",
"description": "The user's username or email."
"description": "The user's username or email.",
"examples": [
"mail@example.com",
"uid12345678"
]
},
"name": {
"type": "string",
"description": "The user's name.",
"examples": [
"Jane Doe"
]
},
"role": {
"type": "string",