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

Status is not related to dev/prod

Browse Source
This commit is contained in:
Simon Harrer
2024-11-04 10:21:52 +01:00
parent 180217d161
commit 7e6a312a7a
4 changed files with 17 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/README.md
View File

@@ -64,21 +64,21 @@ tags: null
### Definitions
| Key | UX label | Required | Description |
|-------------------------|------------------|----------|------------------------------------------------------------------------------------------------|
| apiVersion | Standard version | Yes | Version of the standard used to build data contract. Default value is `v3.0.0`. |
| 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. |
| version | Version | Yes | Current version of the data contract. |
| status | Status | Yes | Current status of the data contract. Valid values are `production`, `test`, or `development`. |
| tenant | Tenant | No | Indicates the property the data is primarily associated with. Value is case insensitive. |
| domain | Domain | No | Name of the logical data domain. |
| dataProduct | Data Product | No | Name of the data product. |
| description | Description | No | Object containing the descriptions. |
| description.purpose | Purpose | No | Intended purpose for the provided data. |
| description.limitations | Limitations | No | Technical, compliance, and legal limitations for data use. |
| description.usage | Usage | No | Recommended usage of the data. |
| Key | UX label | Required | Description |
|-------------------------|------------------|----------|-----------------------------------------------------------------------------------------------|
| apiVersion | Standard version | Yes | Version of the standard used to build data contract. Default value is `v3.0.0`. |
| 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. |
| version | Version | Yes | Current version of the data contract. |
| status | Status | Yes | Current status of the data contract. |
| tenant | Tenant | No | Indicates the property the data is primarily associated with. Value is case insensitive. |
| domain | Domain | No | Name of the logical data domain. |
| dataProduct | Data Product | No | Name of the data product. |
| description | Description | No | Object containing the descriptions. |
| description.purpose | Purpose | No | Intended purpose for the provided data. |
| description.limitations | Limitations | No | Technical, compliance, and legal limitations for data use. |
| description.usage | Usage | No | Recommended usage of the data. |
## Schema

2
docs/examples/quality/column-completeness.odcs.yaml
View File

@@ -24,4 +24,4 @@ schema:
dimension: completeness
severity: error
rule: nullCheck
businessImpact: operational
businessImpact: operational

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

@@ -37,8 +37,7 @@
},
"status": {
"type": "string",
"description": "Current status of the dataset. Valid values are `production`, `test`, or `development`.",
"examples": ["production", "test", "development"]
"description": "Current status of the dataset."
},
"servers": {
"type": "array",

3
schema/odcs-json-schema-v3.0.0.json
View File

@@ -2228,9 +2228,6 @@
"secondLevelApprovers": {
"type": "string",
"description": "The name(s) of the second-level approver(s) of the role."
},
"customProperties": {
"$ref": "#/$defs/CustomProperties"
}
},
"required": ["role"]