Skip to content

Commit 26bd62d

Browse files
committed
Merge remote-tracking branch 'aida/dev' into dev-examples-fix-schema
# Conflicts: # CHANGELOG.md
2 parents d4b2a78 + ddb68a1 commit 26bd62d

File tree

6 files changed

+6148
-17
lines changed

6 files changed

+6148
-17
lines changed

CHANGELOG.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,14 @@ This document tracks the history and evolution of the **Open Data Contract Stand
1010
* Update [examples](examples) to adhere to JSON schema
1111
* Full example from README directs to [full-example.yaml](examples/all/full-example.yaml)
1212

13-
# v2.2.1 - 2023-10-03 - APPROVED
13+
# v2.2.1 - 2023-12-18 - APPROVED
1414

15-
* Reformat Markdown tables
16-
* Reformat quality examples to be valid YAML
17-
* Add in isUnique, primaryKeyPosition, partitionKeyPosition and clusterKeyPosition to `column` definition
18-
* Add [JSON schema](schema/odcs-json-schema.json) to validate YAML files
15+
* Reformat quality examples to be valid YAML.
16+
* Type of definition for authority have standard values: `businessDefinition`, `transformationImplementation`, `videoTutorial`, `tutorial`, and `implementation`.
17+
* Add in `isUnique`, `primaryKeyPosition`, `partitionKeyPosition`, and `clusterKeyPosition` to `column` definition.
18+
* Add [JSON schema](schema/odcs-json-schema.json) to validate YAML files for v2.2.1.
19+
* Integrated as part of [Bitol](https://lfaidata.foundation/projects/bitol/).
20+
* Reformat Markdown tables.
1921

2022
# v2.2.0 - 2023-07-27 - APPROVED
2123

@@ -111,4 +113,4 @@ Removed the weight for system ratings from the data contract. Their default valu
111113
* Data quality.
112114
* System rating weightage.
113115
* Ratings:
114-
* System, user, etc.
116+
* System, user, etc.

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
1-
# Open Data Contract Standard
1+
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/8149/badge)](https://www.bestpractices.dev/projects/8149)
2+
3+
# Open Data Contract Standard (ODCS)
24

35
Welcome!
46

57
Thanks for your interest and for taking the time to come here! ❤️
68

79
## Executive summary
8-
This standard describes a structure for a **data contract**. It's current version is 2.2.0. It is available for you as an Apache 2.0 license. Contributions are welcome!
10+
This standard describes a structure for a **data contract**. It's current version is 2.2.1. It is available for you as an Apache 2.0 license. Contributions are welcome!
911

1012
## Discover the open standard
11-
Discover the [Open Data Contract Standard](./docs/README.md). This file contains some explanations and several examples. More [examples](./examples/README.md) have been added to v2.2.
13+
Discover the [Open Data Contract Standard](./docs/README.md). This file contains some explanations and several examples. More [examples](./examples/README.md) have been added to v2.2.1.
1214

1315
## What is a Data Contract?
1416

@@ -21,7 +23,7 @@ A data contract defines the agreement between a data producer and consumers. A d
2123
* Security & stakeholders.
2224
* Custom properties.
2325

24-
![Data contract schema](./docs/img/data-contract-v2.2-schema.png "Data contract schema")
26+
![Data contract schema](./docs/img/data-contract-v2.2.1-schema.svg "Data contract schema")
2527

2628
*Figure 1: illustration of a data contract, its principal contributors, sections, and usage.*
2729

@@ -30,14 +32,16 @@ A data contract defines the agreement between a data producer and consumers. A d
3032
JSON Schema for ODCS can be found [here](schema/odcs-json-schema.json). You can import this schema into your IDE for
3133
validation of your YAML files. Links below show how you can import the schema:
3234

33-
- [Intellij](https://www.jetbrains.com/help/idea/json.html#ws_json_schema_add_custom)
34-
- [VSCode](https://code.visualstudio.com/docs/languages/json#_json-schemas-and-settings)
35+
- [IntelliJ](https://www.jetbrains.com/help/idea/json.html#ws_json_schema_add_custom)
36+
- [VS Code](https://code.visualstudio.com/docs/languages/json#_json-schemas-and-settings)
3537

3638
## Contributing to the project
3739
Check out the [CONTRIBUTING](./CONTRIBUTING.md) file.
3840

3941
## Articles
40-
42+
* 2023-11-30 - [Linux Foundation AI & Data - Bitol Joins LF AI & Data as New Sandbox Project](https://lfaidata.foundation/blog/2023/11/30/bitol-joins-lf-ai-data-as-new-sandbox-project/)
43+
* 2023-11-30 - [AIDAUG - Bitol Joins LF AI & Data as New Sandbox Project](https://aidausergroup.org/2023/11/30/bitol-joins-lf-ai-data-as-new-sandbox-project/)
44+
* 2023-10-01 - [Data Contracts: A Bridge Connecting Two Worlds](https://medium.com/@atanas.iliev.ai/data-contracts-a-bridge-connecting-two-worlds-404eff1d970d)
4145
* 2023-09-10 - [Data Contracts 101](https://medium.com/p/568a9adbf9a9)
4246
* 2023-08-10 - [Welcome to the Open Data Contract Standard](https://jgp.ai/2023/08/09/welcome-to-the-open-data-contract-standard/)
4347
* 2023-05-11 - [Data Contracts – Everything You Need to Know](https://www.montecarlodata.com/blog-data-contracts-explained/)
@@ -51,7 +55,7 @@ If you spot an article about the Open Data Contract Standard, make a pull reques
5155
## More
5256

5357
### History
54-
Formerly known as the data contract template, this standard is used to implement Data Mesh at [PayPal](https://about.pypl.com/). Today, starting with v2.2.0, it is maintained by a 501c6 non-profit organization called AIDA User Group (Artificial Intelligence, Data, and Analytics User Group).
58+
Formerly known as the data contract template, this standard is used to implement Data Mesh at [PayPal](https://about.pypl.com/). Today, starting with v2.2.0, it is maintained by a 501c6 non-profit organization called AIDA User Group (Artificial Intelligence, Data, and Analytics User Group). On November 30th, 2023, [AIDA User Group](https://aidaug.org) and the [Linux Foundation AI & Data](https://lfaidata.foundation/) joined forces to create [Bitol](https://bitol.io). Bitol englobes ODCS and future standards & tools.
5559

5660
### How does PayPal use Data Contracts?
5761
PayPal uses data contracts in many ways, but this [article](https://medium.com/paypal-tech/the-next-generation-of-data-platforms-is-the-data-mesh-b7df4b825522) from the [PayPal Technology blog](https://medium.com/paypal-tech) gives a good introduction.

docs/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ dataset:
143143
- table_name_2
144144
- table_name_3
145145
transformLogic: sel t1.txn_dt as txn_ref_dt from table_name_1 as t1, table_name_2 as t2, table_name_3 as t3 where t1.txn_dt=date-3
146-
transformDescription: defines the logic in business terms; logic for dummies
146+
transformDescription: Defines the logic in business terms.
147147
sampleValues:
148148
- 2022-10-03
149149
- 2020-01-28
@@ -225,11 +225,11 @@ dataset:
225225

226226
### Authorative definitions
227227

228-
Updated in ODCS (Open Data Contract Standard) v2.3.0.
228+
Updated in ODCS (Open Data Contract Standard) v2.2.1.
229229

230230
| Key | UX label | Required | Description |
231231
|------|-------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
232-
| type | Definition type | Yes | Type of definition for authority: v2.3 adds standard values: `businessDefinition`, `transformationImplementation`, `videoTutorial`, `tutorial`, and `implementation`. |
232+
| type | Definition type | Yes | Type of definition for authority: v2.2.1 adds standard values: `businessDefinition`, `transformationImplementation`, `videoTutorial`, `tutorial`, and `implementation`. |
233233
| url | URL to definition | Yes | URL to the authority. |
234234

235235
## Data quality
769 KB
Loading

0 commit comments

Comments
 (0)