Skip to content

Commit d447868

Browse files
simonharrersimonharrer
committed
Introduce examples for status
1 parent 43f43fc commit d447868

18 files changed

+39
-36
lines changed

‎docs/README.md

Lines changed: 16 additions & 16 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,21 @@ tags: null
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. |
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", "in development", "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+
| 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. |
8282

8383

8484
## Schema

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
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

‎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 & 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-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/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: [ ]

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,10 @@
3737
},
3838
"status": {
3939
"type": "string",
40-
"description": "Current status of the dataset."
40+
"description": "Current status of the dataset.",
41+
"examples": [
42+
"proposed", "in development", "active", "deprecated", "retired"
43+
]
4144
},
4245
"servers": {
4346
"type": "array",

0 commit comments

Comments
 (0)