From db46a9dfaf563d62f584234822f9fbad4cb77a9d Mon Sep 17 00:00:00 2001
From: MSeidl93 <matthias.seidl@gmx.de>
Date: Tue, 2 Apr 2024 09:51:02 +0200
Subject: [PATCH] introduced versioning, added more notes on data model lebel

---
 data_model/data_model.dbml         | 20 ++++++++++++--------
 tag_definitions.yml                | 13 +++++++++++++
 valuesets/category_definitions.yml |  1 +
 3 files changed, 26 insertions(+), 8 deletions(-)

diff --git a/data_model/data_model.dbml b/data_model/data_model.dbml
index ccf1c1a..6e9a2d0 100644
--- a/data_model/data_model.dbml
+++ b/data_model/data_model.dbml
@@ -1,6 +1,8 @@
 // dbdocs: https://dbdocs.io/matthias/OpenLabelsInitiative
 // interactive visualization: https://dbdiagram.io/d/OLI-65c538c3ac844320aec4000e
 
+// Version: 1.0
+
 Project OLI {
   database_type: 'PostgreSQL'
   Note: '''
@@ -13,18 +15,20 @@ Project OLI {
 }
 
 Table Tags {
-  tag_id string [pk]
-  name string
-  description string
-  create string
-  value_set list
-
-  Note: "Individual labels or identifiers that can be applied to data points for sorting, searching, and categorization purposes."
+  tag_id string [pk, Note: "A slug that acts as unique identifier for this tag. Namespaces can be assigned."]
+  name string [Note: "The name of this tag in human-readable format."]
+  description string [Note: "A short description of this tag and its purpose."]
+  type string [Note: "The datatype that associated values can take."]
+  value_set list [Note: "If set, this list acts as enums for this tag. Only values from this values set can be assigned."]
+  creator string [Note: "Creator of this tag id."]
+  version float [Note: "The versioning of the tag. Whenever a value set change happens, the versioning will also change."]
+
+  Note: "Individual tags or identifiers that can be applied to addresses for sorting, searching, and categorization purposes."
 }
 
 Table TagMapping {
   address string [pk]
-  chain_id string [pk]
+  chain_id string [pk, Note: "Unique chain identifier according to CAIP-2 standard."]
   tag_id string [pk]
   value string
 
diff --git a/tag_definitions.yml b/tag_definitions.yml
index 980b08a..693af4a 100644
--- a/tag_definitions.yml
+++ b/tag_definitions.yml
@@ -4,6 +4,7 @@ tags:
   description: This tag refers to the fundamental descriptor that provides a clear and immediate understanding of an address's purpose or role. It should offer a straightforward one-word detailed definition into the functionality of the address. For example, the Uniswap router contract would have the name = 'router'.
   type: string
   creator: OLI
+  version: 1.0
 
 - id: oli.is_eoa
   name: Is EOA
@@ -11,6 +12,7 @@ tags:
   type: boolean
   value_set: [true, false]
   creator: OLI
+  version: 1.0
 
 - id: oli.is_factory_contract
   name: Is Contract
@@ -18,6 +20,7 @@ tags:
   type: boolean
   value_set: [true, false]
   creator: OLI
+  version: 1.0
 
 - id: oli.is_contract
   name: Is Factory Contract
@@ -25,18 +28,21 @@ tags:
   type: boolean
   value_set: [true, false]
   creator: OLI
+  version: 1.0
 
 - id: oli.deployment_tx
   name: Deployer Transaction
   description: The transaction that deployed the contract.
   type: bytea
   creator: OLI
+  version: 1.0
 
 - id: oli.deployer_address
   name: Deployer Address
   description: The address that deployed the contract.
   type: bytea
   creator: OLI
+  version: 1.0
 
 - id: oli.owner_project
   name: Owner Project
@@ -44,12 +50,14 @@ tags:
   type: string
   value_set: https://github.com/opensource-observer/oss-directory
   creator: OLI
+  version: 1.0
 
 - id: oli.deployment_date
   name: Deployment Date
   description: The date the contract was deployed.
   type: date
   creator: OLI
+  version: 1.0
 
 - id: oli.is_proxy
   name: Is Proxy
@@ -57,6 +65,7 @@ tags:
   type: boolean
   value_set: [true, false]
   creator: OLI
+  version: 1.0
 
 # - id: oli.bytecode
 #   name: Bytecode
@@ -70,12 +79,14 @@ tags:
   type: string
   value_set: [ERC20, ERC721, ERC777, ERC1155, ERC1400, ERC1404, ERC1594, ERC1643, ERC1644, ERC173, ERC1820, ERC223, ERC621, ERC677, ERC777, ERC827, ERC884, ERC918, ERC948, ERC965, ERC998, ERC1155, ERC1400, ERC1404, ERC1594, ERC1643, ERC1644, ERC173, ERC1820, ERC223, ERC621, ERC677, ERC777, ERC827, ERC884, ERC918, ERC948, ERC965, ERC998]
   creator: OLI
+  version: 1.0
 
 - id: oli.erc20_name
   name: ERC20 Name
   description: The name of the ERC20 token.
   type: string
   creator: OLI
+  version: 1.0
 
 - id: oli.usage_category
   name: Usage Category
@@ -83,9 +94,11 @@ tags:
   type: string
   value_set: https://github.com/openlabelsinitiative/OLI/blob/main/valuesets/category_definitions.yml
   creator: OLI
+  version: 1.0
 
 - id: oli.version
   name: Version
   description: The release version of the dApp (i.e. 2 for Uniswap v2 contracts).
   type: int
   creator: OLI
+  version: 1.0
diff --git a/valuesets/category_definitions.yml b/valuesets/category_definitions.yml
index ebc2143..221d8d2 100644
--- a/valuesets/category_definitions.yml
+++ b/valuesets/category_definitions.yml
@@ -1,3 +1,4 @@
+version: 1.0
 cefi:
   main_category_name: CeFi
   categories: