From 25245232984d753ef0e3011f5b11c347bc598389 Mon Sep 17 00:00:00 2001 From: ashmrtn Date: Fri, 9 Dec 2022 10:00:45 -0800 Subject: [PATCH] Add a comment for updating Schema constants (#1759) ## Description Note what things need to stay the same and what things can change when updating schema constant values. This is required because some information about the constants are persisted in the model store. ## Type of change - [ ] :sunflower: Feature - [ ] :bug: Bugfix - [x] :world_map: Documentation - [ ] :robot: Test - [ ] :computer: CI/Deployment - [x] :hamster: Trivial/Minor ## Issue(s) * closes #1757 ## Test Plan - [x] :muscle: Manual - [ ] :zap: Unit test - [ ] :green_heart: E2E --- src/internal/model/model.go | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/internal/model/model.go b/src/internal/model/model.go index b0e906010..b78db93ee 100644 --- a/src/internal/model/model.go +++ b/src/internal/model/model.go @@ -11,6 +11,11 @@ type ( Schema int ) +// Schema constants denote the type of model stored. The integer values of the +// constants can be changed without issue, but the string values should remain +// the same. If the string values are changed, additional code will be needed to +// transform from the old value to the new value. +// //go:generate go run golang.org/x/tools/cmd/stringer -type=Schema const ( UnknownSchema = Schema(iota)