repo-mirrors/open-data-contract-standard
1
0
Fork 0
mirror of https://github.com/bitol-io/open-data-contract-standard.git synced 2025-05-28 19:34:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'dev' into remove-top-level-quality

Browse Source
This commit is contained in:
Jean-Georges "jgp" Perrin
2024-10-15 07:24:43 -04:00
committed by GitHub
parent bd71d9b05e 9fa00b1449
commit 5d93a2ebf9
18 changed files with 134 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -25,12 +25,16 @@ Discover the [Open Data Contract Standard](docs/README.md). This file contains s
### The basics of a data contract
A data contract defines the agreement between a data producer and consumers. A data contract contains several sections:
* [Fundamentals](docs/README.md#demographics).
* [Schema](docs/README.md#dataset-and-schema).
* [Data quality](docs/README.md#data-quality-).
* [Service-level agreement (SLA)](docs/README.md#service-level-agreement).
* [Security & stakeholders](docs/README.md#stakeholders).
* [Custom properties](docs/README.md#other-properties).
* [Fundamentals](docs/README.md#fundamentals).
* [Schema](docs/README.md#schema).
* [Data quality](docs/README.md#data-quality).
* [Support & communication channels](docs/README.md#support)
* [Pricing](docs/README.md#pricing)
* [Team](docs/README.md#team)
* [Roles](docs/README.md#roles)
* [Service-level agreement (SLA)](docs/README.md#sla).
* [Infrastructures & servers](docs/README.md#servers)
* [Custom properties](docs/README.md#custom-properties).
![Data contract schema](docs/img/data-contract-diagram-latest.svg "Data contract schema")

61
docs/README.md
View File

@@ -7,7 +7,7 @@ image: "https://raw.githubusercontent.com/bitol-io/artwork/main/horizontal/color
# Open Data Contract Standard
## Executive Summary
This document describes the keys and values expected in a YAML data contract, per the **Open Data Contract Standard**. It is divided in multiple sections: [fundamentals (fka demographics)](#fundamentals), [schema](#schema), [data quality](#data-quality), [pricing](#pricing), [team](#team), [roles](#roles), [service-level agreement](#sla), and [other/custom properties](#custom-properties). Each section starts with at least an example followed by definition of each field/key.
This document describes the keys and values expected in a YAML data contract, per the **Open Data Contract Standard**. It is divided in multiple sections: [fundamentals (fka demographics)](#fundamentals), [schema](#schema), [data quality](#data-quality), [Support & communication channels](#support), [pricing](#pricing), [team](#team), [roles](#roles), [service-level agreement](#sla), [Infrastructures & servers](#servers) and [other/custom properties](#custom-properties). Each section starts with at least an example followed by definition of each field/key.
## Table of content
@@ -59,21 +59,21 @@ tags: null
### Definitions
| Key | UX label | Required | Description |
|-------------------------|------------------|----------|------------------------------------------------------------------------------------------|
| apiVersion | Standard version | Yes | Version of the standard used to build data contract. Default value is `v3.0.0`. |
| kind | Kind | Yes | The kind of file this is. Valid value is `DataContract`. |
| id | ID | Yes | A unique identifier used to reduce the risk of dataset name collisions, such as a UUID. |
| name | Name | No | Name of the data contract. |
| version | Version | Yes | Current version of the data contract. |
| status | Status | Yes | Current status of the data contract. |
| tenant | Tenant | No | Indicates the property the data is primarily associated with. Value is case insensitive. |
| domain | Domain | No | Name of the logical data domain. |
| dataProduct | Data Product | No | Name of the data product. |
| description | Description | No | Object containing the descriptions. |
| description.purpose | Purpose | No | Intended purpose for the provided data. |
| description.limitations | Limitations | No | Technical, compliance, and legal limitations for data use. |
| description.usage | Usage | No | Recommended usage of the data. |
| Key | UX label | Required | Description |
|-------------------------|------------------|----------|------------------------------------------------------------------------------------------------|
| apiVersion | Standard version | Yes | Version of the standard used to build data contract. Default value is `v3.0.0`. |
| kind | Kind | Yes | The kind of file this is. Valid value is `DataContract`. |
| id | ID | Yes | A unique identifier used to reduce the risk of dataset name collisions, such as a UUID. |
| name | Name | No | Name of the data contract. |
| version | Version | Yes | Current version of the data contract. |
| status | Status | Yes | Current status of the data contract. Valid values are `production`, `test`, or `development`. |
| tenant | Tenant | No | Indicates the property the data is primarily associated with. Value is case insensitive. |
| domain | Domain | No | Name of the logical data domain. |
| dataProduct | Data Product | No | Name of the data product. |
| description | Description | No | Object containing the descriptions. |
| description.purpose | Purpose | No | Intended purpose for the provided data. |
| description.limitations | Limitations | No | Technical, compliance, and legal limitations for data use. |
| description.usage | Usage | No | Recommended usage of the data. |
## <a id="schema"/> Schema
@@ -243,8 +243,9 @@ Some keys are more applicable when the described property is a column.
| unique | Unique | No | Indicates if the element contains unique values; possible values are true and false. Default is false. |
| partitioned | Partitioned | No | Indicates if the element is partitioned; possible values are true and false. |
| partitionKeyPosition | Partition Key Position | No | If element is used for partitioning, the position of the partition element. Starts from 1. Example of `country, year` being partition columns, `country` has partitionKeyPosition 1 and `year` partitionKeyPosition 2. Default to -1. |
| classification | Classification | No | Can be anything, like confidential, restricted, and public to more advanced categorization. Some companies like PayPal, use data classification indicating the class of data in the column; expected values are 1, 2, 3, 4, or 5. |
| authoritativeDefinitions | Authoritative Definitions | No | List of links to sources that provide more detail on element logic or values; examples would be URL to a GitHub repo, Collibra, on another tool. |
| classification | Classification | No | Can be anything, like confidential, restricted, and public to more advanced categorization.
|
| authoritativeDefinitions | Authoritative Definitions | No | List of links to sources that provide more detail on element logic or values; examples would be URL to a git repo, documentation, a data catalog or another tool. |
| encryptedName | Encrypted Name | No | The element name within the dataset that contains the encrypted element value. For example, unencrypted element `email_address` might have an encryptedName of `email_address_encrypt`. |
| transformSourceObjects | Transform Sources | No | List of objects in the data source used in the transformation. |
| transformLogic | Transform Logic | No | Logic used in the column transformation. |
@@ -283,11 +284,11 @@ Additional metadata options to more accurately define the data type.
### Authoritative definitions
Updated in ODCS (Open Data Contract Standard) v2.2.1.
Reference to an external definition on element logic or values.
| Key | UX label | Required | Description |
|------|-------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| type | Definition type | Yes | Type of definition for authority: v2.2.1 adds standard values: `businessDefinition`, `transformationImplementation`, `videoTutorial`, `tutorial`, and `implementation`. |
| type | Definition type | Yes | Type of definition for authority. Valid values are: `businessDefinition`, `transformationImplementation`, `videoTutorial`, `tutorial`, and `implementation`. |
| url | URL to definition | Yes | URL to the authority. |
@@ -545,7 +546,7 @@ support:
## Pricing
This section covers pricing when you bill your customer for using this data product. Pricing is experimental in v2.1.1 of the data contract.
This section covers pricing when you bill your customer for using this data product.
### Example
@@ -588,10 +589,16 @@ team:
```
### Definitions
The UX label is the label used in the UI and other user experiences. It is not limited to BlueRacket.
| Key | UX label | Required | Description |
The UX label is the label used in the UI and other user experiences.
| Key | UX label | Required | Description |
|-------------------------|----------------------|----------|--------------------------------------------------------------------------------------------|
| team | Team | No | Object |
| team.username | Username | No | The user's username or email. |
| team.role | Role | No | The user's job role; Examples might be owner, data steward. There is no limit on the role. |
| team.dateIn | Date In | No | The date when the user joined the team. |
| team.dateOut | Date Out | No | The date when the user ceased to be part of the team. |
| team.replacedByUsername | Replaced By Username | No | The username of the user who replaced the previous user. |
## Roles
This section lists the roles that a consumer may need to access the dataset depending on the type of access they require.
@@ -633,9 +640,9 @@ roles:
## <a id="sla"/> Service-Level Agreement (SLA)
This section describes the service-level agreements (SLA).
* Use the `Table.Column` to indicate the number to do the checks on, as in `SELECT txn_ref_dt FROM tab1`.
* Separate multiple table.columns by a comma, as in `table1.col1`, `table2.col1`, `table1.col2`.
* If there is only one table in the contract, the table name is not required.
* Use the `Object.Element` to indicate the number to do the checks on, as in `SELECT txn_ref_dt FROM tab1`.
* Separate multiple object.element by a comma, as in `table1.col1`, `table2.col1`, `table1.col2`.
* If there is only one object in the contract, the object name is not required.
### Example

3
docs/examples/all/full-example.odcs.yaml
View File

@@ -15,8 +15,6 @@ tenant: ClimateQuantumInc
kind: DataContract
apiVersion: v3.0.0 # Standard version (follows semantic versioning)
type: tables
# Infrastructure & servers
servers:
- server: my-postgres
@@ -30,6 +28,7 @@ servers:
schema:
- name: tbl
physicalName: tbl_1
physicalType: table
description: Provides core payment metrics
authoritativeDefinitions:
- url: https://catalog.data.gov/dataset/air-quality

69
docs/examples/all/postgresql-adventureworks-contract.odcs.yaml
View File

@@ -1,13 +1,13 @@
version: "1.0.0"
apiVersion: "v3.0.0"
id: "6aeafdc1-ed62-4c8f-bf0a-da1061c98cdb"
type: "tables"
status: "Development"
kind: "DataContract"
description: {}
schema:
- name: "department"
physicalName: "department"
physicalType: "table"
description: "Lookup table containing the departments within the Adventure Works\
\ Cycles company."
properties:
@@ -56,6 +56,7 @@ schema:
required: false
- name: "employee"
physicalName: "employee"
physicalType: "table"
description: "Employee information such as salary, department, and title."
properties:
- name: "businessentityid"
@@ -225,6 +226,7 @@ schema:
required: false
- name: "employeedepartmenthistory"
physicalName: "employeedepartmenthistory"
physicalType: "table"
description: "Employee department transfers."
properties:
- name: "businessentityid"
@@ -296,6 +298,7 @@ schema:
required: false
- name: "employeepayhistory"
physicalName: "employeepayhistory"
physicalType: "table"
description: "Employee pay history."
properties:
- name: "businessentityid"
@@ -354,6 +357,7 @@ schema:
required: false
- name: "jobcandidate"
physicalName: "jobcandidate"
physicalType: "table"
description: "Résumés submitted to Human Resources by job applicants."
properties:
- name: "jobcandidateid"
@@ -402,6 +406,7 @@ schema:
required: false
- name: "shift"
physicalName: "shift"
physicalType: "table"
description: "Work shift lookup table."
properties:
- name: "shiftid"
@@ -460,6 +465,7 @@ schema:
required: false
- name: "address"
physicalName: "address"
physicalType: "table"
description: "Street address information for customers, employees, and vendors."
properties:
- name: "addressid"
@@ -562,6 +568,7 @@ schema:
required: false
- name: "addresstype"
physicalName: "addresstype"
physicalType: "table"
description: "Types of addresses stored in the Address table."
properties:
- name: "addresstypeid"
@@ -608,6 +615,7 @@ schema:
required: false
- name: "businessentity"
physicalName: "businessentity"
physicalType: "table"
description: "Source of the ID that connects vendors, customers, and employees\
\ with address and contact information."
properties:
@@ -644,6 +652,7 @@ schema:
required: false
- name: "businessentityaddress"
physicalName: "businessentityaddress"
physicalType: "table"
description: "Cross-reference table mapping customers, vendors, and employees\
\ to their addresses."
properties:
@@ -702,6 +711,7 @@ schema:
required: false
- name: "businessentitycontact"
physicalName: "businessentitycontact"
physicalType: "table"
description: "Cross-reference table mapping stores, vendors, and employees to\
\ people"
properties:
@@ -760,6 +770,7 @@ schema:
required: false
- name: "contacttype"
physicalName: "contacttype"
physicalType: "table"
description: "Lookup table containing the types of business entity contacts."
properties:
- name: "contacttypeid"
@@ -796,6 +807,7 @@ schema:
required: false
- name: "countryregion"
physicalName: "countryregion"
physicalType: "table"
description: "Lookup table containing the ISO standard codes for countries and\
\ regions."
properties:
@@ -833,6 +845,7 @@ schema:
required: false
- name: "emailaddress"
physicalName: "emailaddress"
physicalType: "table"
description: "Where to send a person email."
properties:
- name: "businessentityid"
@@ -891,6 +904,7 @@ schema:
required: false
- name: "password"
physicalName: "password"
physicalType: "table"
description: "One way hashed authentication information"
properties:
- name: "businessentityid"
@@ -948,6 +962,7 @@ schema:
required: false
- name: "person"
physicalName: "person"
physicalType: "table"
description: "Human beings involved with AdventureWorks: employees, customer contacts,\
\ and vendor contacts."
properties:
@@ -1103,6 +1118,7 @@ schema:
required: false
- name: "personphone"
physicalName: "personphone"
physicalType: "table"
description: "Telephone number and type of a person."
properties:
- name: "businessentityid"
@@ -1150,6 +1166,7 @@ schema:
required: false
- name: "phonenumbertype"
physicalName: "phonenumbertype"
physicalType: "table"
description: "Type of phone number of a person."
properties:
- name: "phonenumbertypeid"
@@ -1186,6 +1203,7 @@ schema:
required: false
- name: "stateprovince"
physicalName: "stateprovince"
physicalType: "table"
description: "State and province lookup table."
properties:
- name: "stateprovinceid"
@@ -1278,6 +1296,7 @@ schema:
required: false
- name: "billofmaterials"
physicalName: "billofmaterials"
physicalType: "table"
description: "Items required to make bicycles and bicycle subassemblies. It identifies\
\ the heirarchical relationship between a parent product and its components."
properties:
@@ -1381,6 +1400,7 @@ schema:
required: false
- name: "culture"
physicalName: "culture"
physicalType: "table"
description: "Lookup table containing the languages in which some AdventureWorks\
\ data is stored."
properties:
@@ -1418,6 +1438,7 @@ schema:
required: false
- name: "document"
physicalName: "document"
physicalType: "table"
description: "Product maintenance documents."
properties:
- name: "title"
@@ -1566,6 +1587,7 @@ schema:
required: false
- name: "illustration"
physicalName: "illustration"
physicalType: "table"
description: "Bicycle assembly diagrams."
properties:
- name: "illustrationid"
@@ -1602,6 +1624,7 @@ schema:
required: false
- name: "location"
physicalName: "location"
physicalType: "table"
description: "Product inventory and manufacturing locations."
properties:
- name: "locationid"
@@ -1660,6 +1683,7 @@ schema:
required: false
- name: "product"
physicalName: "product"
physicalType: "table"
description: "Products sold or used in the manfacturing of sold products."
properties:
- name: "productid"
@@ -1938,6 +1962,7 @@ schema:
required: false
- name: "productcategory"
physicalName: "productcategory"
physicalType: "table"
description: "High-level product categorization."
properties:
- name: "productcategoryid"
@@ -1984,6 +2009,7 @@ schema:
required: false
- name: "productcosthistory"
physicalName: "productcosthistory"
physicalType: "table"
description: "Changes in the cost of a product over time."
properties:
- name: "productid"
@@ -2042,6 +2068,7 @@ schema:
required: false
- name: "productdescription"
physicalName: "productdescription"
physicalType: "table"
description: "Product descriptions in several languages."
properties:
- name: "productdescriptionid"
@@ -2088,6 +2115,7 @@ schema:
required: false
- name: "productdocument"
physicalName: "productdocument"
physicalType: "table"
description: "Cross-reference table mapping products to related product documents."
properties:
- name: "productid"
@@ -2124,6 +2152,7 @@ schema:
required: false
- name: "productinventory"
physicalName: "productinventory"
physicalType: "table"
description: "Product inventory information."
properties:
- name: "productid"
@@ -2203,6 +2232,7 @@ schema:
required: false
- name: "productlistpricehistory"
physicalName: "productlistpricehistory"
physicalType: "table"
description: "Changes in the list price of a product over time."
properties:
- name: "productid"
@@ -2261,6 +2291,7 @@ schema:
required: false
- name: "productmodel"
physicalName: "productmodel"
physicalType: "table"
description: "Product model classification."
properties:
- name: "productmodelid"
@@ -2329,6 +2360,7 @@ schema:
required: false
- name: "productmodelillustration"
physicalName: "productmodelillustration"
physicalType: "table"
description: "Cross-reference table mapping product models and illustrations."
properties:
- name: "productmodelid"
@@ -2365,6 +2397,7 @@ schema:
required: false
- name: "productmodelproductdescriptionculture"
physicalName: "productmodelproductdescriptionculture"
physicalType: "table"
description: "Cross-reference table mapping product descriptions and the language\
\ the description is written in."
properties:
@@ -2413,6 +2446,7 @@ schema:
required: false
- name: "productphoto"
physicalName: "productphoto"
physicalType: "table"
description: "Product images."
properties:
- name: "productphotoid"
@@ -2482,6 +2516,7 @@ schema:
required: false
- name: "productproductphoto"
physicalName: "productproductphoto"
physicalType: "table"
description: "Cross-reference table mapping products and product photos."
properties:
- name: "productid"
@@ -2530,6 +2565,7 @@ schema:
required: false
- name: "productreview"
physicalName: "productreview"
physicalType: "table"
description: "Customer reviews of products they have purchased."
properties:
- name: "productreviewid"
@@ -2622,6 +2658,7 @@ schema:
required: false
- name: "productsubcategory"
physicalName: "productsubcategory"
physicalType: "table"
description: "Product subcategories. See ProductCategory table."
properties:
- name: "productsubcategoryid"
@@ -2679,6 +2716,7 @@ schema:
required: false
- name: "scrapreason"
physicalName: "scrapreason"
physicalType: "table"
description: "Manufacturing failure reasons lookup table."
properties:
- name: "scrapreasonid"
@@ -2715,6 +2753,7 @@ schema:
required: false
- name: "transactionhistory"
physicalName: "transactionhistory"
physicalType: "table"
description: "Record of each purchase order, sales order, or work order transaction\
\ year to date."
properties:
@@ -2819,6 +2858,7 @@ schema:
required: false
- name: "transactionhistoryarchive"
physicalName: "transactionhistoryarchive"
physicalType: "table"
description: "Transactions for previous years."
properties:
- name: "transactionid"
@@ -2922,6 +2962,7 @@ schema:
required: false
- name: "unitmeasure"
physicalName: "unitmeasure"
physicalType: "table"
description: "Unit of measure lookup table."
properties:
- name: "unitmeasurecode"
@@ -2958,6 +2999,7 @@ schema:
required: false
- name: "workorder"
physicalName: "workorder"
physicalType: "table"
description: "Manufacturing work orders."
properties:
- name: "workorderid"
@@ -3060,6 +3102,7 @@ schema:
required: false
- name: "workorderrouting"
physicalName: "workorderrouting"
physicalType: "table"
description: "Work order details."
properties:
- name: "workorderid"
@@ -3196,6 +3239,7 @@ schema:
required: false
- name: "productvendor"
physicalName: "productvendor"
physicalType: "table"
description: "Cross-reference table mapping vendors with the products they supply."
properties:
- name: "productid"
@@ -3321,6 +3365,7 @@ schema:
required: false
- name: "purchaseorderdetail"
physicalName: "purchaseorderdetail"
physicalType: "table"
description: "Individual products associated with a specific purchase order. See\
\ PurchaseOrderHeader."
properties:
@@ -3424,6 +3469,7 @@ schema:
required: false
- name: "purchaseorderheader"
physicalName: "purchaseorderheader"
physicalType: "table"
description: "General purchase order information. See PurchaseOrderDetail."
properties:
- name: "purchaseorderid"
@@ -3563,6 +3609,7 @@ schema:
required: false
- name: "shipmethod"
physicalName: "shipmethod"
physicalType: "table"
description: "Shipping company lookup table."
properties:
- name: "shipmethodid"
@@ -3631,6 +3678,7 @@ schema:
required: false
- name: "vendor"
physicalName: "vendor"
physicalType: "table"
description: "Companies from whom Adventure Works Cycles purchases parts or other\
\ goods."
properties:
@@ -3725,6 +3773,7 @@ schema:
required: false
- name: "countryregioncurrency"
physicalName: "countryregioncurrency"
physicalType: "table"
description: "Cross-reference table mapping ISO currency codes to a country or\
\ region."
properties:
@@ -3762,6 +3811,7 @@ schema:
required: false
- name: "creditcard"
physicalName: "creditcard"
physicalType: "table"
description: "Customer credit card information."
properties:
- name: "creditcardid"
@@ -3831,6 +3881,7 @@ schema:
required: false
- name: "currency"
physicalName: "currency"
physicalType: "table"
description: "Lookup table containing standard ISO currencies."
properties:
- name: "currencycode"
@@ -3867,6 +3918,7 @@ schema:
required: false
- name: "currencyrate"
physicalName: "currencyrate"
physicalType: "table"
description: "Currency exchange rates."
properties:
- name: "currencyrateid"
@@ -3947,6 +3999,7 @@ schema:
required: false
- name: "customer"
physicalName: "customer"
physicalType: "table"
description: "Current customer information. Also see the Person and Store tables."
properties:
- name: "customerid"
@@ -4016,6 +4069,7 @@ schema:
required: false
- name: "personcreditcard"
physicalName: "personcreditcard"
physicalType: "table"
description: "Cross-reference table mapping people to their credit card information\
\ in the CreditCard table."
properties:
@@ -4053,6 +4107,7 @@ schema:
required: false
- name: "salesorderdetail"
physicalName: "salesorderdetail"
physicalType: "table"
description: "Individual products associated with a specific sales order. See\
\ SalesOrderHeader."
properties:
@@ -4166,6 +4221,7 @@ schema:
required: false
- name: "salesorderheader"
physicalName: "salesorderheader"
physicalType: "table"
description: "General sales order information."
properties:
- name: "salesorderid"
@@ -4445,6 +4501,7 @@ schema:
required: false
- name: "salesorderheadersalesreason"
physicalName: "salesorderheadersalesreason"
physicalType: "table"
description: "Cross-reference table mapping sales orders to sales reason codes."
properties:
- name: "salesorderid"
@@ -4481,6 +4538,7 @@ schema:
required: false
- name: "salesperson"
physicalName: "salesperson"
physicalType: "table"
description: "Sales representative current information."
properties:
- name: "businessentityid"
@@ -4582,6 +4640,7 @@ schema:
required: false
- name: "salespersonquotahistory"
physicalName: "salespersonquotahistory"
physicalType: "table"
description: "Sales performance tracking."
properties:
- name: "businessentityid"
@@ -4639,6 +4698,7 @@ schema:
required: false
- name: "salesreason"
physicalName: "salesreason"
physicalType: "table"
description: "Lookup table of customer purchase reasons."
properties:
- name: "salesreasonid"
@@ -4686,6 +4746,7 @@ schema:
required: false
- name: "salestaxrate"
physicalName: "salestaxrate"
physicalType: "table"
description: "Tax rate lookup table."
properties:
- name: "salestaxrateid"
@@ -4766,6 +4827,7 @@ schema:
required: false
- name: "salesterritory"
physicalName: "salesterritory"
physicalType: "table"
description: "Sales territory lookup table."
properties:
- name: "territoryid"
@@ -4878,6 +4940,7 @@ schema:
required: false
- name: "salesterritoryhistory"
physicalName: "salesterritoryhistory"
physicalType: "table"
description: "Sales representative transfers to other sales territories."
properties:
- name: "businessentityid"
@@ -4946,6 +5009,7 @@ schema:
required: false
- name: "shoppingcartitem"
physicalName: "shoppingcartitem"
physicalType: "table"
description: "Contains online customer orders until the order is submitted or\
\ cancelled."
properties:
@@ -5016,6 +5080,7 @@ schema:
required: false
- name: "specialoffer"
physicalName: "specialoffer"
physicalType: "table"
description: "Sale discounts lookup table."
properties:
- name: "specialofferid"
@@ -5139,6 +5204,7 @@ schema:
required: false
- name: "specialofferproduct"
physicalName: "specialofferproduct"
physicalType: "table"
description: "Cross-reference table mapping products to special offer discounts."
properties:
- name: "specialofferid"
@@ -5185,6 +5251,7 @@ schema:
required: false
- name: "store"
physicalName: "store"
physicalType: "table"
description: "Customers (resellers) of Adventure Works products."
properties:
- name: "businessentityid"

2
docs/examples/data-types/all-data-types.odcs.yaml
View File

@@ -1,7 +1,6 @@
version: 1.0.0
kind: DataContract
id: 53581432-6c55-4ba2-a65f-72344a91553a
type: tables
status: current
name: my_table
dataProduct: my_quantum
@@ -10,6 +9,7 @@ schema:
- name: transactions_tbl
description: Provides core payment metrics
dataGranularityDescription: Aggregation on names txn_ref_dt, pmt_txn_id
physicalType: table
properties:
- name: account_id
physicalType: string

2
docs/examples/fundamentals/table-column-description.odcs.yaml
View File

@@ -1,7 +1,6 @@
version: 1.0.0
kind: DataContract
id: 53581432-6c55-4ba2-a65f-72344a91553a
type: tables
status: current
name: my_quantum
apiVersion: v3.0.0
@@ -9,6 +8,7 @@ schema:
- name: tbl
description: Provides core payment metrics
dataGranularityDescription: Aggregation on columns txn_ref_dt, pmt_txn_id
physicalType: table
properties:
- name: txn_ref_dt
businessName: Transaction reference date

4
docs/examples/quality/column-accuracy.odcs.yaml
View File

@@ -1,7 +1,6 @@
version: 1.0.0
kind: DataContract
id: 53581432-6c55-4ba2-a65f-72344a91553a
type: tables
status: current
name: my_table
dataProduct: my_quantum
@@ -13,7 +12,8 @@ schema:
- url: https://catalog.data.gov/dataset/air-quality
type: Reference definition on Data.gov
dataGranularityDescription: Raw records
properties:
physicalType: table
properties:
- name: DataValue
businessName: Measured value
logicalType: number

2
docs/examples/quality/column-completeness.odcs.yaml
View File

@@ -2,7 +2,6 @@ version: 1.0.0
apiVersion: v3.0.0
kind: DataContract
id: 53581432-6c55-4ba2-a65f-72344a91553a
type: tables
status: current
name: my_table
dataProduct: my_quantum
@@ -13,6 +12,7 @@ schema:
- url: https://catalog.data.gov/dataset/air-quality
type: Reference definition on Data.gov
dataGranularityDescription: Raw records
physicalType: table
properties:
- name: UniqueID
primaryKey: true

2
docs/examples/quality/column-custom.odcs.yaml
View File

@@ -2,7 +2,6 @@ version: 1.0.0
apiVersion: v3.0.0
kind: DataContract
id: 53581432-6c55-4ba2-a65f-72344a91553a
type: tables
status: current
name: my_table
dataProduct: my_quantum
@@ -13,6 +12,7 @@ schema:
- url: https://catalog.data.gov/dataset/air-quality
type: Reference definition on Data.gov
dataGranularityDescription: Raw records
physicalType: table
properties:
- name: UniqueID
primaryKey: true

2
docs/examples/quality/column-validity.odcs.yaml
View File

@@ -2,7 +2,6 @@ version: 1.0.0
apiVersion: v3.0.0
kind: DataContract
id: 53581432-6c55-4ba2-a65f-72344a91553a
type: tables
status: current
name: my_table
dataProduct: my_quantum
@@ -13,6 +12,7 @@ schema:
- url: https://catalog.data.gov/dataset/air-quality
type: Reference definition on Data.gov
dataGranularityDescription: Raw records
physicalType: table
properties:
- name: UniqueID
primaryKey: true

1
docs/examples/roles/service-and-operational-roles.odcs.yaml
View File

@@ -1,7 +1,6 @@
version: 1.0.0
kind: DataContract
id: 53581432-6c55-4ba2-a65f-72344a91553a
type: tables
status: current
name: my_table
dataProduct: my_quantum

1
docs/examples/schema/all-schema-types.odcs.yaml
View File

@@ -1,7 +1,6 @@
version: 1.0.0
kind: DataContract
id: 53581432-6c55-4ba2-a65f-72344a91553a
type: tables
status: current
name: my_quantum
apiVersion: v3.0.0

2
docs/examples/schema/table-column.odcs.yaml
View File

@@ -1,13 +1,13 @@
version: 1.0.0
kind: DataContract
id: 53581432-6c55-4ba2-a65f-72344a91553b
type: tables
status: current
name: my_table
dataProduct: my_quantum
apiVersion: v3.0.0
schema:
- name: tbl
physicalType: table
properties:
- name: rcvr_cntry_code
businessName: Receiver country code

2
docs/examples/schema/table-columns-with-partition.odcs.yaml
View File

@@ -1,13 +1,13 @@
version: 1.0.0
kind: DataContract
id: 53581432-6c55-4ba2-a65f-72344a91553c
type: tables
status: current
name: my_table
dataProduct: my_quantum
apiVersion: v3.0.0
schema:
- name: tbl
physicalType: table
properties:
- name: rcvr_cntry_code
businessName: Receiver country code

1
docs/examples/sla/database-table-sla.odcs.yaml
View File

@@ -2,7 +2,6 @@ version: 1.0.0
apiVersion: v3.0.0
kind: DataContract
id: 53581432-6c55-4ba2-a65f-72344a91553a
type: tables
status: current
name: my_table
dataProduct: my_quantum

1
docs/examples/stakeholders/basic-four-dpo.odcs.yaml
View File

@@ -2,7 +2,6 @@ version: 1.0.0
apiVersion: v3.0.0
kind: DataContract
id: 53581432-6c55-4ba2-a65f-72344a91553a
type: tables
status: current
name: my_table
dataProduct: my_quantum

17
schema/odcs-json-schema-latest.json
View File

@@ -28,11 +28,6 @@
"type": "string",
"description": "Name of the data contract."
},
"type": {
"type": "string",
"description": "Identifies the types of objects in the dataset. For BigQuery or any other database, the expected value would be Tables.",
"examples": ["Tables"]
},
"tenant": {
"type": "string",
"description": "Indicates the property the data is primarily associated with. Value is case insensitive."
@@ -2133,7 +2128,7 @@
},
"AuthoritativeDefinitions": {
"type": "array",
"description": "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. Authoritative definitions follow the same structure in the standard.",
"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.",
"items": {
"type": "object",
"properties": {
@@ -2211,25 +2206,25 @@
"properties": {
"username": {
"type": "string",
"description": "The team's username or email."
"description": "The user's username or email."
},
"role": {
"type": "string",
"description": "The team's job role; Examples might be owner, data steward. There is no limit on the role."
"description": "The user's job role; Examples might be owner, data steward. There is no limit on the role."
},
"dateIn": {
"type": "string",
"format": "date",
"description": "The date when the user became a team."
"description": "The date when the user joined the team."
},
"dateOut": {
"type": "string",
"format": "date",
"description": "The date when the user ceased to be a team"
"description": "The date when the user ceased to be part of the team."
},
"replacedByUsername": {
"type": "string",
"description": "The username of the user who replaced the team"
"description": "The username of the user who replaced the previous user."
}
}
},

17
schema/odcs-json-schema-v3.0.0.json
View File

@@ -28,11 +28,6 @@
"type": "string",
"description": "Name of the data contract."
},
"type": {
"type": "string",
"description": "Identifies the types of objects in the dataset. For BigQuery or any other database, the expected value would be Tables.",
"examples": ["Tables"]
},
"tenant": {
"type": "string",
"description": "Indicates the property the data is primarily associated with. Value is case insensitive."
@@ -2133,7 +2128,7 @@
},
"AuthoritativeDefinitions": {
"type": "array",
"description": "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. Authoritative definitions follow the same structure in the standard.",
"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.",
"items": {
"type": "object",
"properties": {
@@ -2211,25 +2206,25 @@
"properties": {
"username": {
"type": "string",
"description": "The team's username or email."
"description": "The user's username or email."
},
"role": {
"type": "string",
"description": "The team's job role; Examples might be owner, data steward. There is no limit on the role."
"description": "The user's job role; Examples might be owner, data steward. There is no limit on the role."
},
"dateIn": {
"type": "string",
"format": "date",
"description": "The date when the user became a team."
"description": "The date when the user joined the team."
},
"dateOut": {
"type": "string",
"format": "date",
"description": "The date when the user ceased to be a team"
"description": "The date when the user ceased to be part of the team."
},
"replacedByUsername": {
"type": "string",
"description": "The username of the user who replaced the team"
"description": "The username of the user who replaced the previous user."
}
}
},