Skip to content

Commit 280a1c4

Browse files
jgperrinjgperrin
authored
Merge pull request #1 from bitol-io/dev
v0.9.0 commit
2 parents c96141e + 37809e6 commit 280a1c4

File tree

9 files changed

+425
-0
lines changed

9 files changed

+425
-0
lines changed

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/.idea/

‎AUTHORS.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# List of contributors to this project
2+
3+
| Name | Company
4+
|----------------------------------------------------------------------------|----------------------------------------
5+
| [Jean-Georges Perrin](https://www.linkedin.com/in/jgperrin/) | Actian
6+
| [Peter Flook](https://www.linkedin.com/in/peter-flook-bbb20ab2/) | [Data Catering](https://data.catering/)
7+
| Andrea Gioia || Contributor |
8+
| Andrew Jones || Contributor |
9+
| Christian Foyer || Contributor |
10+
| Martin Meermeyer || Contributor |
11+
| Diego Carvallo || Contributor |
12+
| Manuel DESTOUESSE || Contributor |
13+
| Dirk Van de Poel || Contributor |
14+
| Gene Stakhov || Contributor |
15+
| Atanas Iliev || Contributor |
16+
| Jochen Christ || Contributor |
17+
| Todd Nemanich || Contributor |
18+
| Praveen Guduri || Contributor |
19+
| Dr. Simon Harrer || Contributor |
20+
| Tom De Wolf || Contributor |

‎CHANGELOG.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: "Changelog: Open Data Contract Standard (ODCS)"
3+
description: "Home of Open Data Contract Standard (ODCS) documentation."
4+
image: "https://raw.githubusercontent.com/bitol-io/artwork/main/horizontal/color/Bitol_Logo_color.svg"
5+
---
6+
7+
This document tracks the history and evolution of the **Open Data Product Standard**.
8+
9+
# v0.9.0 - 2025-07-15 - APPROVED
10+
11+
* Approved release as v0.9.0.
12+
13+
# v0.1.0 - 2023-09-01
14+
15+
* Very early draft, part of the discussions of creating Bitol within the Linux Foundation.

‎CONTRIBUTING.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Contributing: Open Data Contract Standard (ODCS)"
3+
description: "How you can contribute to the Open Data Contract Standard (ODCS)."
4+
image: "https://raw.githubusercontent.com/bitol-io/artwork/main/horizontal/color/Bitol_Logo_color.svg"
5+
---
6+
7+
# Contributing to Open Data Product Standard
8+
9+
Thank you for your interest in contributing to Open Data Product Standard (ODPS). Please refer to the [TSC contributing guidelines](https://github.com/bitol-io/tsc/blob/main/CONTRIBUTING.md).
10+

‎docs/README.md‎

Lines changed: 223 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/img/Bitol_Logo_icon_color.svg‎

Lines changed: 24 additions & 0 deletions
Loading

‎schema/README.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# ODPS JSON Schema
2+
3+
You will find all the versions of the Open Data Product Standard (ODPS) JSON Schema files here. Each version will be
4+
stored here for reference and to allow [SchemaStore](https://github.com/SchemaStore/schemastore) to keep track of each
5+
version.
6+
7+
If you want your files to be automatically detected as ODPS files, use the file extension `.odps.yaml`. For example,
8+
`my-big-data.odps.yaml`.
9+
10+
## SchemaStore
11+
12+
SchemaStore is a widely adopted repository of JSON schema files for integration with tools such as Intellij and VS Code.
13+
ODPS was onboarded to SchemaStore as part of [this pull request](https://github.com/SchemaStore/schemastore/pull/3868).
14+
15+
## Versioning
16+
17+
When a new version of ODPS JSON Schema is available, a pull request to SchemaStore should be created to update the
18+
following section:
19+
20+
```json
21+
{
22+
"name": "Open Data Product Standard (ODPS)",
23+
...,
24+
"versions": {
25+
"<new_version>": "https://github.com/bitol-io/open-data-product-standard/blob/main/schema/odps-json-schema-<new_version>.json",
26+
...
27+
"v0.9.0": "https://github.com/bitol-io/open-data-product-standard/blob/main/schema/odps-json-schema-v0.9.0.json"
28+
}
29+
},
30+
```
31+
32+
And the `odcs-json-schema-latest.json` should be updated with the latest version changes.

‎schema/odps-json-schema-latest.json‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
{
2+
"$schema": "https://json-schema.org/draft/2019-09/schema",
3+
"title": "Open Data Product Standard (ODPS)",
4+
"description": "An open data product standard descriptor to enable defining data products EARLY VERSION.",
5+
"type": "object",
6+
"properties": {
7+
"version": {
8+
"type": "string",
9+
"description": "Current version of the data product."
10+
},
11+
"kind": {
12+
"type": "string",
13+
"default": "DataProduct",
14+
"description": "The kind of file this is. Valid value is `DataProduct`.",
15+
"enum": ["DataProduct"]
16+
},
17+
"apiVersion": {
18+
"type": "string",
19+
"default": "v0.9.0",
20+
"description": "Version of the standard used to build data product. Default value is v0.9.0.",
21+
"enum": ["v0.9.0"]
22+
},
23+
"id": {
24+
"type": "string",
25+
"description": "A unique identifier used to reduce the risk of dataset name collisions, such as a UUID."
26+
},
27+
"name": {
28+
"type": "string",
29+
"description": "Name of the data product."
30+
},
31+
"tags": {
32+
"$ref": "#/$defs/Tags"
33+
},
34+
"status": {
35+
"type": "string",
36+
"description": "Current status of the data product.",
37+
"examples": [
38+
"proposed", "draft", "active", "deprecated", "retired"
39+
]
40+
},
41+
"Tags": {
42+
"type": "array",
43+
"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`.",
44+
"examples": ["finance", "sensitive", "employee_record"],
45+
"items": {
46+
"type": "string"
47+
}
48+
}
49+
}
50+
}

0 commit comments

Comments
 (0)