Skip to content

Commit 58d932e

Browse files
pflookypflooky
authored
Merge pull request #105 from bitol-io/issue-add-tags-to-readme
Issue add tags to readme
2 parents ccd12d8 + aa68783 commit 58d932e

File tree

7 files changed

+21
-17
lines changed

7 files changed

+21
-17
lines changed

‎docs/README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ description:
5959
limitations: null
6060
usage: null
6161

62-
tags: null
62+
tags: ['finance']
6363
```
6464
6565
### Definitions
@@ -116,7 +116,7 @@ schema:
116116
type: businessDefinition
117117
- url: https://youtu.be/jbY1BKFj9ec
118118
type: videoTutorial
119-
tags: null
119+
tags: ['finance']
120120
dataGranularityDescription: Aggregation on columns txn_ref_dt, pmt_txn_id
121121
properties:
122122
- name: txn_ref_dt
@@ -218,16 +218,17 @@ schema:
218218

219219
#### Applicable to Elements (either Objects or Properties)
220220

221-
| Key | UX label | Required | Description |
222-
|--------------------------|------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
223-
| name | Name | Yes | Name of the element. |
224-
| physicalName | Physical Name | No | Physical name. |
225-
| description | Description | No | Description of the element. |
226-
| businessName | Business Name | No | The business name of the element. |
227-
| 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 git repo, data catalog, or another tool. See `authoritativeDefinitions` below. |
228-
| quality | Quality | No | List of data quality attributes. |
229-
| 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. |
230-
| 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. |
231232

232233
#### Applicable to Objects
233234

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ schema:
3838
type: businessDefinition
3939
- url: https://youtu.be/jbY1BKFj9ec
4040
type: videoTutorial
41-
tags: [ ]
41+
tags: [ 'finance', 'payments']
4242
dataGranularityDescription: Aggregation on columns txn_ref_dt, pmt_txn_id
4343
properties:
4444
- name: txn_ref_dt
@@ -77,7 +77,7 @@ schema:
7777
partitioned: false
7878
partitionKeyPosition: -1
7979
criticalDataElement: false
80-
tags: [ ]
80+
tags: [ 'uid' ]
8181
classification: restricted
8282
- name: rcvr_cntry_code
8383
primaryKey: false

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ schema:
8282
criticalDataElement: false
8383
primaryKey: false
8484
required: false
85+
tags: ['sensitive']
8586
- name: "loginid"
8687
logicalType: "string"
8788
physicalType: "varchar[256]"
@@ -115,6 +116,7 @@ schema:
115116
criticalDataElement: false
116117
primaryKey: false
117118
required: false
119+
tags: ['sensitive']
118120
- name: "maritalstatus"
119121
logicalType: "string"
120122
physicalType: "bpchar"

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ schema:
1313
type: Reference definition on Data.gov
1414
dataGranularityDescription: Raw records
1515
physicalType: table
16+
tags: ['nyc', 'regional']
1617
properties:
1718
- name: UniqueID
1819
primaryKey: true

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ schema:
1515
type: businessDefinition
1616
- url: https://youtu.be/jbY1BKFj9ec
1717
type: videoTutorial
18-
tags: []
18+
tags: ['finance']
1919
dataGranularityDescription: Aggregation on columns txn_ref_dt, pmt_txn_id
2020
properties:
2121
- name: txn_ref_dt

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1912,7 +1912,7 @@
19121912
},
19131913
"Tags": {
19141914
"type": "array",
1915-
"description": "A list of tags that may be assigned to the elements (object or property); the tags keyword may appear at any level.",
1915+
"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`.",
19161916
"items": {
19171917
"type": "string"
19181918
}

‎schema/odcs-json-schema-v3.0.0.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1901,7 +1901,7 @@
19011901
},
19021902
"Tags": {
19031903
"type": "array",
1904-
"description": "A list of tags that may be assigned to the elements (object or property); the tags keyword may appear at any level.",
1904+
"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`.",
19051905
"items": {
19061906
"type": "string"
19071907
}

0 commit comments

Comments
 (0)