Skip to content

Commit

Permalink
Merge pull request #105 from bitol-io/issue-add-tags-to-readme
Browse files Browse the repository at this point in the history 
Issue add tags to readme
  • Loading branch information
@pflooky
pflooky authored Dec 27, 2024
2 parents ccd12d8 + aa68783 commit 58d932e
Show file tree
Hide file tree
Showing 7 changed files with 21 additions and 17 deletions.
25 changes: 13 additions & 12 deletions docs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ description:
limitations: null
usage: null

tags: null
tags: ['finance']
```
### Definitions
Expand Down Expand Up @@ -116,7 +116,7 @@ schema:
type: businessDefinition
- url: https://youtu.be/jbY1BKFj9ec
type: videoTutorial
tags: null
tags: ['finance']
dataGranularityDescription: Aggregation on columns txn_ref_dt, pmt_txn_id
properties:
- name: txn_ref_dt
Expand Down Expand Up @@ -218,16 +218,17 @@ schema:

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

| Key | UX label | Required | Description |
|--------------------------|------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| name | Name | Yes | Name of the element. |
| physicalName | Physical Name | No | Physical name. |
| description | Description | No | Description of the element. |
| businessName | Business Name | No | The business name of the element. |
| 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. |
| quality | Quality | No | List of data quality attributes. |
| 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. |
| customProperties | Custom Properties | No | Custom properties that are not part of the standard. |

| Key | UX label | Required | Description |
|--------------------------|------------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| name | Name | Yes | Name of the element. |
| physicalName | Physical Name | No | Physical name. |
| description | Description | No | Description of the element. |
| businessName | Business Name | No | The business name of the element. |
| 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. |
| quality | Quality | No | List of data quality attributes. |
| 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`. |
| customProperties | Custom Properties | No | Custom properties that are not part of the standard. |

#### Applicable to Objects

Expand Down
4 changes: 2 additions & 2 deletions docs/examples/all/full-example.odcs.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ schema:
type: businessDefinition
- url: https://youtu.be/jbY1BKFj9ec
type: videoTutorial
tags: [ ]
tags: [ 'finance', 'payments']
dataGranularityDescription: Aggregation on columns txn_ref_dt, pmt_txn_id
properties:
- name: txn_ref_dt
Expand Down Expand Up @@ -77,7 +77,7 @@ schema:
partitioned: false
partitionKeyPosition: -1
criticalDataElement: false
tags: [ ]
tags: [ 'uid' ]
classification: restricted
- name: rcvr_cntry_code
primaryKey: false
Expand Down
2 changes: 2 additions & 0 deletions docs/examples/all/postgresql-adventureworks-contract.odcs.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@ schema:
criticalDataElement: false
primaryKey: false
required: false
tags: ['sensitive']
- name: "loginid"
logicalType: "string"
physicalType: "varchar[256]"
Expand Down Expand Up @@ -115,6 +116,7 @@ schema:
criticalDataElement: false
primaryKey: false
required: false
tags: ['sensitive']
- name: "maritalstatus"
logicalType: "string"
physicalType: "bpchar"
Expand Down
1 change: 1 addition & 0 deletions docs/examples/quality/column-completeness.odcs.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ schema:
type: Reference definition on Data.gov
dataGranularityDescription: Raw records
physicalType: table
tags: ['nyc', 'regional']
properties:
- name: UniqueID
primaryKey: true
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/schema/all-schema-types.odcs.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ schema:
type: businessDefinition
- url: https://youtu.be/jbY1BKFj9ec
type: videoTutorial
tags: []
tags: ['finance']
dataGranularityDescription: Aggregation on columns txn_ref_dt, pmt_txn_id
properties:
- name: txn_ref_dt
Expand Down
2 changes: 1 addition & 1 deletion schema/odcs-json-schema-latest.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1912,7 +1912,7 @@
},
"Tags": {
"type": "array",
"description": "A list of tags that may be assigned to the elements (object or property); the tags keyword may appear at any level.",
"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`.",
"items": {
"type": "string"
}
Expand Down
2 changes: 1 addition & 1 deletion schema/odcs-json-schema-v3.0.0.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1901,7 +1901,7 @@
},
"Tags": {
"type": "array",
"description": "A list of tags that may be assigned to the elements (object or property); the tags keyword may appear at any level.",
"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`.",
"items": {
"type": "string"
}
Expand Down

0 comments on commit 58d932e

Please sign in to comment.