Merge pull request #67 from TGSAI/60_docs

Added dataset model notation and static string for current version nu…
TGSAI · Aug 5, 2024 · 16f7cb9 · 16f7cb9
2 parents 5baba0d + f08215c
commit 16f7cb9
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/mdio/dataset_schema.h b/mdio/dataset_schema.h
@@ -17,6 +17,16 @@
 
 #include <string>
 
+/*
+Note before progressing beyone here:
+This string is a direct copy of the MDIO Dataset model schema.
+https://mdio-python.readthedocs.io/en/v1/data_models/version_1.html
+
+It should NOT be modified unless the MDIO Dataset model schema is updated.
+*/
+
+/*NOLINT*/ static const std::string kSchemaVersion = "1.0.0";
+
 // TODO(BrianMichell): Cleanup NOLINT
 /*NOLINT*/ static const std::string kDatasetSchema = R"( 
 {