Skip to content

Commit e645ae9

Browse files
pflookypflooky
authored
Merge pull request #104 from pflooky/prepare-release-v3.0.1
Create new JSON schema for v3.0.1, update changelog, update examples …
2 parents 58d932e + e375f66 commit e645ae9

24 files changed

+2404
-31
lines changed

‎.github/workflows/validate-examples.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
name: validate-examples
22
on:
3+
pull_request:
4+
branches: ["*"]
35
push:
46
branches: ["*"]
57

‎CHANGELOG.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,16 @@ image: "https://raw.githubusercontent.com/bitol-io/artwork/main/horizontal/color
66

77
This document tracks the history and evolution of the **Open Data Contract Standard**.
88

9+
# v3.0.1 - 2024-12-22 - APPROVED
10+
11+
* Added field `authoritativeDefinitions` into JSON schema
12+
* Added field `description.customProperties` into JSON schema
13+
* Added field `description.authoritativeDefinitions` into JSON schema
14+
* Added field `role.customProperties` into JSON schema
15+
* Updated `status` field to include examples
16+
* Updated `authoritativeDefinitions` description to be vendor agnostic
17+
* Updated `tags` description and included examples
18+
919
# v3.0.0 - 2024-10-21 - APPROVED
1020

1121
* **New section**: Support & communication channels.

‎docs/README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ This section contains general information about the contract.
4343
### Example
4444

4545
```YAML
46-
apiVersion: v3.0.0 # Standard version
46+
apiVersion: v3.0.1 # Standard version
4747
kind: DataContract
4848

4949
id: 53581432-6c55-4ba2-a65f-72344a91553a
@@ -66,16 +66,16 @@ tags: ['finance']
6666
6767
| Key | UX label | Required | Description |
6868
|--------------------------------------|---------------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
69-
| apiVersion | Standard version | Yes | Version of the standard used to build data contract. Default value is `v3.0.0`. |
69+
| apiVersion | Standard version | Yes | Version of the standard used to build data contract. Default value is `v3.0.1`. |
7070
| kind | Kind | Yes | The kind of file this is. Valid value is `DataContract`. |
7171
| id | ID | Yes | A unique identifier used to reduce the risk of dataset name collisions, such as a UUID. |
7272
| name | Name | No | Name of the data contract. |
7373
| 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". |
74+
| status | Status | Yes | Current status of the data contract. Examples are "proposed", "draft", "active", "deprecated", "retired". |
7575
| tenant | Tenant | No | Indicates the property the data is primarily associated with. Value is case insensitive. |
7676
| domain | Domain | No | Name of the logical data domain. |
7777
| 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. |
78+
| authoritativeDefinitions | Authoritative Definitions | No | List of links to sources that provide more details on the data contract. |
7979
| description | Description | No | Object containing the descriptions. |
8080
| description.purpose | Purpose | No | Intended purpose for the provided data. |
8181
| description.limitations | Limitations | No | Technical, compliance, and legal limitations for data use. |
@@ -218,14 +218,13 @@ schema:
218218

219219
#### Applicable to Elements (either Objects or Properties)
220220

221-
222221
| Key | UX label | Required | Description |
223222
|--------------------------|------------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
224223
| name | Name | Yes | Name of the element. |
225224
| physicalName | Physical Name | No | Physical name. |
226225
| description | Description | No | Description of the element. |
227226
| businessName | Business Name | No | The business name of the element. |
228-
| 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. |
227+
| authoritativeDefinitions | Authoritative Definitions | No | List of links to sources that provide more details on the element; examples would be a link to privacy statement, terms and conditions, license agreements, data catalog, or another tool. |
229228
| quality | Quality | No | List of data quality attributes. |
230229
| 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. Tags may be used to better categorize an element. For example, `finance`, `sensitive`, `employee_record`. |
231230
| customProperties | Custom Properties | No | Custom properties that are not part of the standard. |
@@ -648,7 +647,7 @@ roles:
648647
| roles.access | Access | No | The type of access provided by the IAM role. |
649648
| roles.firstLevelApprovers | 1st Level Approvers | No | The name(s) of the first-level approver(s) of the role. |
650649
| roles.secondLevelApprovers | 2nd Level Approvers | No | The name(s) of the second-level approver(s) of the role. |
651-
| roles.customProperties | Custom Properties | No | Any custom properties. |
650+
| roles.customProperties | Custom Properties | No | Any custom properties. |
652651

653652

654653
## Service-Level Agreement (SLA)

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ description:
1111
limitations: Data based on seller perspective, no buyer information
1212
usage: Predict sales over time
1313
authoritativeDefinitions:
14-
type: privacy-statement
15-
url: https://example.com/gdpr.pdf
14+
- type: privacy-statement
15+
url: https://example.com/gdpr.pdf
1616
tenant: ClimateQuantumInc
1717

1818
kind: DataContract
19-
apiVersion: v3.0.0 # Standard version (follows semantic versioning)
19+
apiVersion: v3.0.1 # Standard version (follows semantic versioning)
2020

2121
# Infrastructure & servers
2222
servers:

‎docs/examples/data-types/all-data-types.odcs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ id: 53581432-6c55-4ba2-a65f-72344a91553a
44
status: active
55
name: my_table
66
dataProduct: my_quantum
7-
apiVersion: v3.0.0
7+
apiVersion: v3.0.1
88
schema:
99
- name: transactions_tbl
1010
description: Provides core payment metrics

‎docs/examples/fundamentals/table-column-description.odcs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ kind: DataContract
33
id: 53581432-6c55-4ba2-a65f-72344a91553a
44
status: active
55
name: my_quantum
6-
apiVersion: v3.0.0
6+
apiVersion: v3.0.1
77
schema:
88
- name: tbl
99
description: Provides core payment metrics

‎docs/examples/quality/column-accuracy.odcs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ id: 53581432-6c55-4ba2-a65f-72344a91553a
44
status: active
55
name: my_table
66
dataProduct: my_quantum
7-
apiVersion: v3.0.0
7+
apiVersion: v3.0.1
88
schema:
99
- name: Air_Quality
1010
description: Air quality of the city of New York

‎docs/examples/quality/column-completeness.odcs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
version: 1.0.0
2-
apiVersion: v3.0.0
2+
apiVersion: v3.0.1
33
kind: DataContract
44
id: 53581432-6c55-4ba2-a65f-72344a91553a
55
status: active

‎docs/examples/quality/column-custom.odcs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
version: 1.0.0
2-
apiVersion: v3.0.0
2+
apiVersion: v3.0.1
33
kind: DataContract
44
id: 53581432-6c55-4ba2-a65f-72344a91553a
55
status: active

‎docs/examples/quality/column-validity.odcs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
version: 1.0.0
2-
apiVersion: v3.0.0
2+
apiVersion: v3.0.1
33
kind: DataContract
44
id: 53581432-6c55-4ba2-a65f-72344a91553a
55
status: active

‎docs/examples/roles/service-and-operational-roles.odcs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ status: active
55
name: my_table
66
dataProduct: my_quantum
77
schema: []
8-
apiVersion: v3.0.0
8+
apiVersion: v3.0.1
99
roles:
1010
- role: microstrategy_user_opr
1111
access: read

‎docs/examples/schema/all-schema-types.odcs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ kind: DataContract
33
id: 53581432-6c55-4ba2-a65f-72344a91553a
44
status: active
55
name: my_quantum
6-
apiVersion: v3.0.0
6+
apiVersion: v3.0.1
77
schema:
88
- name: tbl
99
logicalType: object

‎docs/examples/schema/kafka-schema.odcs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
apiVersion: v3.0.0
1+
apiVersion: v3.0.1
22
kind: DataContract
33
id: orders
44
status: development

‎docs/examples/schema/kafka-schemaregistry.odcs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
apiVersion: v3.0.0
1+
apiVersion: v3.0.1
22
kind: DataContract
33
id: orders
44
status: production

‎docs/examples/schema/table-column.odcs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ id: 53581432-6c55-4ba2-a65f-72344a91553b
44
status: active
55
name: my_table
66
dataProduct: my_quantum
7-
apiVersion: v3.0.0
7+
apiVersion: v3.0.1
88
schema:
99
- name: tbl
1010
physicalType: table

‎docs/examples/schema/table-columns-with-partition.odcs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ id: 53581432-6c55-4ba2-a65f-72344a91553c
44
status: active
55
name: my_table
66
dataProduct: my_quantum
7-
apiVersion: v3.0.0
7+
apiVersion: v3.0.1
88
schema:
99
- name: tbl
1010
physicalType: table

‎docs/examples/server/azure-server.odcs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
version: 1.0.0
2-
apiVersion: v3.0.0
2+
apiVersion: v3.0.1
33
kind: DataContract
44
id: abc123
55
status: in development

‎docs/examples/server/kafka-server.odcs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
version: 1.0.0
2-
apiVersion: v3.0.0
2+
apiVersion: v3.0.1
33
kind: DataContract
44
id: abc123
55
status: in development

‎docs/examples/sla/database-table-sla.odcs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
version: 1.0.0
2-
apiVersion: v3.0.0
2+
apiVersion: v3.0.1
33
kind: DataContract
44
id: 53581432-6c55-4ba2-a65f-72344a91553a
55
status: active

‎docs/examples/stakeholders/basic-four-dpo.odcs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
version: 1.0.0
2-
apiVersion: v3.0.0
2+
apiVersion: v3.0.1
33
kind: DataContract
44
id: 53581432-6c55-4ba2-a65f-72344a91553a
55
status: active

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@
1616
},
1717
"apiVersion": {
1818
"type": "string",
19-
"default": "v3.0.0",
20-
"description": "Version of the standard used to build data contract. Default value is v3.0.0.",
21-
"enum": ["v3.0.0", "v2.2.2", "v2.2.1", "v2.2.0"]
19+
"default": "v3.0.1",
20+
"description": "Version of the standard used to build data contract. Default value is v3.0.1.",
21+
"enum": ["v3.0.1", "v3.0.0", "v2.2.2", "v2.2.1", "v2.2.0"]
2222
},
2323
"id": {
2424
"type": "string",

‎schema/odcs-json-schema-v3.0.0.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1901,7 +1901,7 @@
19011901
},
19021902
"Tags": {
19031903
"type": "array",
1904-
"description": "A list of tags that may be assigned to the elements (object or property); the tags keyword may appear at any level. Tags may be used to better categorize an element. For example, `finance`, `sensitive`, `employee_record`.",
1904+
"description": "A list of tags that may be assigned to the elements (object or property); the tags keyword may appear at any level.",
19051905
"items": {
19061906
"type": "string"
19071907
}

0 commit comments

Comments
 (0)