diff --git a/docs/README.md b/docs/README.md index 27f5063..082c638 100644 --- a/docs/README.md +++ b/docs/README.md @@ -59,7 +59,7 @@ description: limitations: null usage: null -tags: null +tags: ['finance'] ``` ### Definitions @@ -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 @@ -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 diff --git a/docs/examples/all/full-example.odcs.yaml b/docs/examples/all/full-example.odcs.yaml index 9325763..243f89f 100644 --- a/docs/examples/all/full-example.odcs.yaml +++ b/docs/examples/all/full-example.odcs.yaml @@ -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 @@ -77,7 +77,7 @@ schema: partitioned: false partitionKeyPosition: -1 criticalDataElement: false - tags: [ ] + tags: [ 'uid' ] classification: restricted - name: rcvr_cntry_code primaryKey: false diff --git a/docs/examples/all/postgresql-adventureworks-contract.odcs.yaml b/docs/examples/all/postgresql-adventureworks-contract.odcs.yaml index 922ecb3..8bbc285 100644 --- a/docs/examples/all/postgresql-adventureworks-contract.odcs.yaml +++ b/docs/examples/all/postgresql-adventureworks-contract.odcs.yaml @@ -82,6 +82,7 @@ schema: criticalDataElement: false primaryKey: false required: false + tags: ['sensitive'] - name: "loginid" logicalType: "string" physicalType: "varchar[256]" @@ -115,6 +116,7 @@ schema: criticalDataElement: false primaryKey: false required: false + tags: ['sensitive'] - name: "maritalstatus" logicalType: "string" physicalType: "bpchar" diff --git a/docs/examples/quality/column-completeness.odcs.yaml b/docs/examples/quality/column-completeness.odcs.yaml index 12e4eed..7b1ef42 100644 --- a/docs/examples/quality/column-completeness.odcs.yaml +++ b/docs/examples/quality/column-completeness.odcs.yaml @@ -13,6 +13,7 @@ schema: type: Reference definition on Data.gov dataGranularityDescription: Raw records physicalType: table + tags: ['nyc', 'regional'] properties: - name: UniqueID primaryKey: true diff --git a/docs/examples/schema/all-schema-types.odcs.yaml b/docs/examples/schema/all-schema-types.odcs.yaml index 7b9a633..a955c40 100644 --- a/docs/examples/schema/all-schema-types.odcs.yaml +++ b/docs/examples/schema/all-schema-types.odcs.yaml @@ -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 diff --git a/schema/odcs-json-schema-latest.json b/schema/odcs-json-schema-latest.json index c469302..2d0d891 100644 --- a/schema/odcs-json-schema-latest.json +++ b/schema/odcs-json-schema-latest.json @@ -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" } diff --git a/schema/odcs-json-schema-v3.0.0.json b/schema/odcs-json-schema-v3.0.0.json index 1ecb880..65eaf40 100644 --- a/schema/odcs-json-schema-v3.0.0.json +++ b/schema/odcs-json-schema-v3.0.0.json @@ -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" }