Skip to content

Commit 4b45841

Browse files
pflookypflooky
authored
Merge branch 'dev' into issue-add-tags-to-readme
2 parents e6c89c7 + ccd12d8 commit 4b45841

21 files changed

+126
-50
lines changed

‎docs/README.md

Lines changed: 33 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ kind: DataContract
4949
id: 53581432-6c55-4ba2-a65f-72344a91553a
5050
name: seller_payments_v1
5151
version: 1.1.0 # Data Contract Version
52-
status: production
52+
status: active
5353
domain: seller
5454
dataProduct: payments
5555
tenant: ClimateQuantumInc
@@ -64,21 +64,25 @@ tags: ['finance']
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. Valid values are `production`, `test`, or `development`. |
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. Examples are "proposed", "draft", "active", "deprecated", "retired". |
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. |
85+
8286

8387

8488
## Schema
@@ -214,16 +218,17 @@ schema:
214218

215219
#### Applicable to Elements (either Objects or Properties)
216220

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. Tags may be used to better categorize an element. For example, `finance`, `sensitive`, `employee_record`. |
226-
| customProperties | Custom Properties | No | Custom properties that are not part of the standard. |
221+
222+
| Key | UX label | Required | Description |
223+
|--------------------------|------------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
224+
| name | Name | Yes | Name of the element. |
225+
| physicalName | Physical Name | No | Physical name. |
226+
| description | Description | No | Description of the element. |
227+
| 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. |
229+
| quality | Quality | No | List of data quality attributes. |
230+
| 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`. |
231+
| customProperties | Custom Properties | No | Custom properties that are not part of the standard. |
227232

228233
#### Applicable to Objects
229234

@@ -643,6 +648,7 @@ roles:
643648
| roles.access | Access | No | The type of access provided by the IAM role. |
644649
| roles.firstLevelApprovers | 1st Level Approvers | No | The name(s) of the first-level approver(s) of the role. |
645650
| 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. |
646652

647653

648654
## Service-Level Agreement (SLA)
@@ -733,7 +739,7 @@ servers:
733739
- **description**: A description of the server.
734740
- **environment**: The environment where the server operates (e.g., `prod`, `dev`, `uat`). There are no set values.
735741
- **roles**: An optional array of roles that have access to the server.
736-
- **customProperties**: Any additional custom properties specific to the server.
742+
- **customProperties**: Any additional custom properties specific to the server that are not part of the standard.
737743

738744
### Specific Server Properties
739745

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,17 @@
22
domain: seller # Domain
33
dataProduct: my quantum # Data product name
44
version: 1.1.0 # Version (follows semantic versioning)
5-
status: current
5+
status: active
66
id: 53581432-6c55-4ba2-a65f-72344a91553a
77

88
# Lots of information
99
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

‎docs/examples/all/postgresql-adventureworks-contract.odcs.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
version: "1.0.0"
22
apiVersion: "v3.0.0"
33
id: "6aeafdc1-ed62-4c8f-bf0a-da1061c98cdb"
4-
status: "Development"
4+
status: active
55
kind: "DataContract"
66
description: {}
7-
schema:
7+
schema:
88
- name: "department"
99
physicalName: "department"
1010
physicalType: "table"

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
version: 1.0.0
22
kind: DataContract
33
id: 53581432-6c55-4ba2-a65f-72344a91553a
4-
status: current
4+
status: active
55
name: my_table
66
dataProduct: my_quantum
77
apiVersion: v3.0.0

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
version: 1.0.0
22
kind: DataContract
33
id: 53581432-6c55-4ba2-a65f-72344a91553a
4-
status: current
4+
status: active
55
name: my_quantum
66
apiVersion: v3.0.0
77
schema:

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
version: 1.0.0
22
kind: DataContract
33
id: 53581432-6c55-4ba2-a65f-72344a91553a
4-
status: current
4+
status: active
55
name: my_table
66
dataProduct: my_quantum
77
apiVersion: v3.0.0

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ version: 1.0.0
22
apiVersion: v3.0.0
33
kind: DataContract
44
id: 53581432-6c55-4ba2-a65f-72344a91553a
5-
status: current
5+
status: active
66
name: my_table
77
dataProduct: my_quantum
88
schema:
@@ -26,4 +26,3 @@ schema:
2626
severity: error
2727
rule: nullCheck
2828
businessImpact: operational
29-

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ version: 1.0.0
22
apiVersion: v3.0.0
33
kind: DataContract
44
id: 53581432-6c55-4ba2-a65f-72344a91553a
5-
status: current
5+
status: active
66
name: my_table
77
dataProduct: my_quantum
88
schema:

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ version: 1.0.0
22
apiVersion: v3.0.0
33
kind: DataContract
44
id: 53581432-6c55-4ba2-a65f-72344a91553a
5-
status: current
5+
status: active
66
name: my_table
77
dataProduct: my_quantum
88
schema:

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
version: 1.0.0
22
kind: DataContract
33
id: 53581432-6c55-4ba2-a65f-72344a91553a
4-
status: current
4+
status: active
55
name: my_table
66
dataProduct: my_quantum
77
schema: []
@@ -22,4 +22,4 @@ roles:
2222
- role: bq_unica_user_opr
2323
access: write
2424
firstLevelApprovers: Reporting Manager
25-
secondLevelApprovers: 'mickey'
25+
secondLevelApprovers: 'mickey'

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
version: 1.0.0
22
kind: DataContract
33
id: 53581432-6c55-4ba2-a65f-72344a91553a
4-
status: current
4+
status: active
55
name: my_quantum
66
apiVersion: v3.0.0
77
schema:
@@ -99,4 +99,4 @@ schema:
9999
physicalType: VARCHAR(40)
100100
- name: zip
101101
logicalType: string
102-
physicalType: VARCHAR(15)
102+
physicalType: VARCHAR(15)

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

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
apiVersion: v3.0.0
2+
kind: DataContract
3+
id: orders
4+
status: development
5+
name: Orders Event Stream
6+
version: 0.0.1
7+
schema:
8+
- name: Orders
9+
physicalName: orders
10+
logicalType: object
11+
physicalType: topic
12+
description: Orders Kafka topic
13+
properties:
14+
- name: cust_id
15+
businessName: Customer ID
16+
logicalType: string
17+
physicalType: string
18+
required: true
19+
- name: prod_id
20+
businessName: Product ID
21+
logicalType: string
22+
physicalType: string
23+
required: true
24+
- name: qty
25+
businessName: Quantity
26+
logicalType: integer
27+
physicalType: int
28+
required: true
29+
servers:
30+
- server: my-kafka
31+
type: kafka
32+
format: avro
33+
host: kafkabroker1:9092

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

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
apiVersion: v3.0.0
2+
kind: DataContract
3+
id: orders
4+
status: production
5+
name: Orders Event Stream
6+
version: 0.0.1
7+
schema:
8+
- name: Orders
9+
physicalName: orders
10+
logicalType: object
11+
physicalType: topic
12+
description: Orders Kafka topic
13+
authoritativeDefinitions:
14+
- url: https://schema-registry:8081
15+
type: implementation
16+
servers:
17+
- server: my-kafka
18+
type: kafka
19+
format: avro
20+
host: kafkabroker1:9092

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
version: 1.0.0
22
kind: DataContract
33
id: 53581432-6c55-4ba2-a65f-72344a91553b
4-
status: current
4+
status: active
55
name: my_table
66
dataProduct: my_quantum
77
apiVersion: v3.0.0

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
version: 1.0.0
22
kind: DataContract
33
id: 53581432-6c55-4ba2-a65f-72344a91553c
4-
status: current
4+
status: active
55
name: my_table
66
dataProduct: my_quantum
77
apiVersion: v3.0.0

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ version: 1.0.0
22
apiVersion: v3.0.0
33
kind: DataContract
44
id: abc123
5-
status: pending
5+
status: in development
66
servers:
77
- server: my-azure
88
type: azure

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ version: 1.0.0
22
apiVersion: v3.0.0
33
kind: DataContract
44
id: abc123
5-
status: pending
5+
status: in development
66
schema:
77
- name: Orders
88
physicalName: orders.avro.v1

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ version: 1.0.0
22
apiVersion: v3.0.0
33
kind: DataContract
44
id: 53581432-6c55-4ba2-a65f-72344a91553a
5-
status: current
5+
status: active
66
name: my_table
77
dataProduct: my_quantum
88
schema: []

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ version: 1.0.0
22
apiVersion: v3.0.0
33
kind: DataContract
44
id: 53581432-6c55-4ba2-a65f-72344a91553a
5-
status: current
5+
status: active
66
name: my_table
77
dataProduct: my_quantum
88
schema: [ ]

0 commit comments

Comments
 (0)