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 YAML and JSON files to replace 'comment' with 'description' for user entries

Browse Source
This commit is contained in:
Simon Harrer
2025-03-25 15:40:45 +01:00
parent 01b617ae05
commit 9358c78950
5 changed files with 12 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@@ -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. * Added field `physicalName` for the properties in JSON schema.
* Explicitly specifies `YYYY-MM-DDTHH:mm:ss.SSSZ` for default date format. * Explicitly specifies `YYYY-MM-DDTHH:mm:ss.SSSZ` for default date format.
* Added field `name` team members in JSON schema and docs. * 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 # v3.0.1 - 2024-12-22 - APPROVED

3
docs/README.md
View File

@@ -642,7 +642,7 @@ team:
dateIn: 2022-10-01 dateIn: 2022-10-01
- username: daustin - username: daustin
role: Owner role: Owner
comment: Keeper of the grail description: Keeper of the grail
name: David Austin name: David Austin
dateIn: 2022-10-01 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 | Team | No | Object |
| team.username | Username | No | The user's username or email. | | team.username | Username | No | The user's username or email. |
| team.name | Name | No | The user's name. | | 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.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.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. | | team.dateOut | Date Out | No | The date when the user ceased to be part of the team. |

2
docs/examples/all/full-example.odcs.yaml
View File

@@ -154,7 +154,7 @@ team:
dateIn: "2022-10-01" dateIn: "2022-10-01"
- username: daustin - username: daustin
role: Owner role: Owner
comment: Keeper of the grail description: Keeper of the grail
dateIn: "2022-10-01" dateIn: "2022-10-01"

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

@@ -2214,6 +2214,10 @@
"Jane Doe" "Jane Doe"
] ]
}, },
"description": {
"type": "string",
"description": "The user's description."
},
"role": { "role": {
"type": "string", "type": "string",
"description": "The user's job role; Examples might be owner, data steward. There is no limit on the role." "description": "The user's job role; Examples might be owner, data steward. There is no limit on the role."

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

@@ -2214,6 +2214,10 @@
"Jane Doe" "Jane Doe"
] ]
}, },
"description": {
"type": "string",
"description": "The user's description."
},
"role": { "role": {
"type": "string", "type": "string",
"description": "The user's job role; Examples might be owner, data steward. There is no limit on the role." "description": "The user's job role; Examples might be owner, data steward. There is no limit on the role."