Skip to content

Commit 7966e0b

Browse files
simonharrersimonharrer
authored
Merge pull request #98 from bitol-io/dev-authoriativedefs
Add three new fields:
2 parents 43f43fc + 88611d5 commit 7966e0b

File tree

3 files changed

+42
-27
lines changed

3 files changed

+42
-27
lines changed

‎docs/README.md

+29-26
Original file line numberDiff line numberDiff line change
@@ -64,21 +64,24 @@ 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. |
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. |
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. |
8285

8386

8487
## Schema
@@ -214,16 +217,16 @@ schema:
214217

215218
#### Applicable to Elements (either Objects or Properties)
216219

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. |
220+
| Key | UX label | Required | Description |
221+
|--------------------------|------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
222+
| name | Name | Yes | Name of the element. |
223+
| physicalName | Physical Name | No | Physical name. |
224+
| description | Description | No | Description of the element. |
225+
| businessName | Business Name | No | The business name of the element. |
226+
| 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. |
227+
| quality | Quality | No | List of data quality attributes. |
228+
| 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. |
229+
| customProperties | Custom Properties | No | Custom properties that are not part of the standard. |
227230

228231
#### Applicable to Objects
229232

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

739742
### Specific Server Properties
740743

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

+3
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

+10-1
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,12 @@
6565
"limitations": {
6666
"type": "string",
6767
"description": "Limitations of the dataset."
68+
},
69+
"authoritativeDefinitions": {
70+
"$ref": "#/$defs/AuthoritativeDefinitions"
71+
},
72+
"customProperties": {
73+
"$ref": "#/$defs/CustomProperties"
6874
}
6975
}
7076
},
@@ -110,6 +116,9 @@
110116
"$ref": "#/$defs/ServiceLevelAgreementProperty"
111117
}
112118
},
119+
"authoritativeDefinitions": {
120+
"$ref": "#/$defs/AuthoritativeDefinitions"
121+
},
113122
"customProperties": {
114123
"$ref": "#/$defs/CustomProperties"
115124
},
@@ -2105,7 +2114,7 @@
21052114
},
21062115
"AuthoritativeDefinitions": {
21072116
"type": "array",
2108-
"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.",
2117+
"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.",
21092118
"items": {
21102119
"type": "object",
21112120
"properties": {

0 commit comments

Comments
 (0)