Skip to content

Commit 5893a67

Browse files
simonharrersimonharrer
authored
Merge branch 'dev' into dev-betterstatus
2 parents 67bad52 + 7966e0b commit 5893a67

File tree

3 files changed

+43
-27
lines changed

3 files changed

+43
-27
lines changed

‎docs/README.md

Lines changed: 30 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -64,21 +64,25 @@ tags: null
6464
6565
### Definitions
6666
67-
| Key | UX label | Required | Description |
68-
|-------------------------|------------------|----------|----------------------------------------------------------------------------------------------------------------------------|
69-
| apiVersion | Standard version | Yes | Version of the standard used to build data contract. Default value is `v3.0.0`. |
70-
| kind | Kind | Yes | The kind of file this is. Valid value is `DataContract`. |
71-
| id | ID | Yes | A unique identifier used to reduce the risk of dataset name collisions, such as a UUID. |
72-
| name | Name | No | Name of the data contract. |
73-
| version | Version | Yes | Current version of the data contract. |
74-
| status | Status | Yes | Current status of the data contract. Examples are "proposed", "draft", "active", "deprecated", "retired". |
75-
| tenant | Tenant | No | Indicates the property the data is primarily associated with. Value is case insensitive. |
76-
| domain | Domain | No | Name of the logical data domain. |
77-
| dataProduct | Data Product | No | Name of the data product. |
78-
| description | Description | No | Object containing the descriptions. |
79-
| description.purpose | Purpose | No | Intended purpose for the provided data. |
80-
| description.limitations | Limitations | No | Technical, compliance, and legal limitations for data use. |
81-
| description.usage | Usage | No | Recommended usage of the data. |
67+
| Key | UX label | Required | Description |
68+
|--------------------------------------|---------------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
69+
| apiVersion | Standard version | Yes | Version of the standard used to build data contract. Default value is `v3.0.0`. |
70+
| kind | Kind | Yes | The kind of file this is. Valid value is `DataContract`. |
71+
| id | ID | Yes | A unique identifier used to reduce the risk of dataset name collisions, such as a UUID. |
72+
| name | Name | No | Name of the data contract. |
73+
| version | Version | Yes | Current version of the data contract. |
74+
| status | Status | Yes | Current status of the data contract. Examples are "proposed", "draft", "active", "deprecated", "retired". |
75+
| tenant | Tenant | No | Indicates the property the data is primarily associated with. Value is case insensitive. |
76+
| domain | Domain | No | Name of the logical data domain. |
77+
| dataProduct | Data Product | No | Name of the data product. |
78+
| authoritativeDefinitions | Authoritative Definitions | No | List of links to sources that provide more details on the data contract. |
79+
| description | Description | No | Object containing the descriptions. |
80+
| description.purpose | Purpose | No | Intended purpose for the provided data. |
81+
| description.limitations | Limitations | No | Technical, compliance, and legal limitations for data use. |
82+
| description.usage | Usage | No | Recommended usage of the data. |
83+
| description.authoritativeDefinitions | Authoritative Definitions | No | List of links to sources that provide more details on the dataset; examples would be a link to privacy statement, terms and conditions, license agreements, data catalog, or another tool. |
84+
| description.customProperties | Custom Properties | No | Custom properties that are not part of the standard. |
85+
8286

8387

8488
## Schema
@@ -214,16 +218,16 @@ schema:
214218

215219
#### Applicable to Elements (either Objects or Properties)
216220

217-
| Key | UX label | Required | Description |
218-
|--------------------------|------------------------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
219-
| name | Name | Yes | Name of the element. |
220-
| physicalName | Physical Name | No | Physical name. |
221-
| description | Description | No | Description of the element. |
222-
| businessName | Business Name | No | The business name of the element. |
223-
| 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. |
224-
| quality | Quality | No | List of data quality attributes. |
225-
| 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. |
226-
| customProperties | Custom Properties | No | Custom properties that are not part of the standard. |
221+
| Key | UX label | Required | Description |
222+
|--------------------------|------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
223+
| name | Name | Yes | Name of the element. |
224+
| physicalName | Physical Name | No | Physical name. |
225+
| description | Description | No | Description of the element. |
226+
| businessName | Business Name | No | The business name of the element. |
227+
| 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 git repo, data catalog, or another tool. See `authoritativeDefinitions` below. |
228+
| quality | Quality | No | List of data quality attributes. |
229+
| 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. |
230+
| customProperties | Custom Properties | No | Custom properties that are not part of the standard. |
227231

228232
#### Applicable to Objects
229233

@@ -734,7 +738,7 @@ servers:
734738
- **description**: A description of the server.
735739
- **environment**: The environment where the server operates (e.g., `prod`, `dev`, `uat`). There are no set values.
736740
- **roles**: An optional array of roles that have access to the server.
737-
- **customProperties**: Any additional custom properties specific to the server.
741+
- **customProperties**: Any additional custom properties specific to the server that are not part of the standard.
738742

739743
### Specific Server Properties
740744

‎docs/examples/all/full-example.odcs.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ description:
1010
purpose: Views built on top of the seller tables.
1111
limitations: Data based on seller perspective, no buyer information
1212
usage: Predict sales over time
13+
authoritativeDefinitions:
14+
type: privacy-statement
15+
url: https://example.com/gdpr.pdf
1316
tenant: ClimateQuantumInc
1417

1518
kind: DataContract

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

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,12 @@
6868
"limitations": {
6969
"type": "string",
7070
"description": "Limitations of the dataset."
71+
},
72+
"authoritativeDefinitions": {
73+
"$ref": "#/$defs/AuthoritativeDefinitions"
74+
},
75+
"customProperties": {
76+
"$ref": "#/$defs/CustomProperties"
7177
}
7278
}
7379
},
@@ -113,6 +119,9 @@
113119
"$ref": "#/$defs/ServiceLevelAgreementProperty"
114120
}
115121
},
122+
"authoritativeDefinitions": {
123+
"$ref": "#/$defs/AuthoritativeDefinitions"
124+
},
116125
"customProperties": {
117126
"$ref": "#/$defs/CustomProperties"
118127
},
@@ -2108,7 +2117,7 @@
21082117
},
21092118
"AuthoritativeDefinitions": {
21102119
"type": "array",
2111-
"description": "List of links to sources that provide more details on the dataset; examples would be a link to an external definition, a training video, a GitHub repo, Collibra, or another tool. Authoritative definitions follow the same structure in the standard.",
2120+
"description": "List of links to sources that provide more details on the dataset; examples would be a link to an external definition, a training video, a git repo, data catalog, or another tool. Authoritative definitions follow the same structure in the standard.",
21122121
"items": {
21132122
"type": "object",
21142123
"properties": {

0 commit comments

Comments
 (0)