add doc comments and server gen

hashicorp · Mar 28, 2022 · 9e820e6 · 9e820e6
1 parent 37ec042
commit 9e820e6
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 4 deletions.
diff --git a/pkg/server/gen/server.pb.go b/pkg/server/gen/server.pb.go
diff --git a/pkg/server/gen/server.swagger.json b/pkg/server/gen/server.swagger.json
@@ -8594,7 +8594,8 @@
  "type": "object",
  "properties": {
  "sensitive": {
- "type": "string"
+ "type": "string",
+ "title": "'sensitive' values are hashed as SHA256 values for\nthe purposes of output and logging"
  },
  "str": {
  "type": "string"
@@ -8628,7 +8629,7 @@
  "DYNAMIC"
  ],
  "default": "UNKNOWN",
- "title": "- UNKNOWN: TODO: comments"
+ "description": " - UNKNOWN: This is the final used value's source\nthat is supplied to the user in outputs."
  },
  "hashicorp.waypoint.Variable.HclPos": {
  "type": "object",

diff --git a/pkg/server/proto/server.proto b/pkg/server/proto/server.proto
@@ -628,6 +628,8 @@ message Variable {
  // value stores one of three simple types (string, number, bool) as their
  // matching protobuf format, or any complex hcl type as a raw string.
  oneof value {
+ // 'sensitive' values are hashed as SHA256 values for
+ // the purposes of output and logging
  string sensitive = 1;
  string str = 2;
  bool bool = 3;
@@ -638,7 +640,8 @@ message Variable {
 
  Source source = 6;
  enum Source {
- // TODO: comments
+ // This is the final used value's source
+ // that is supplied to the user in outputs.
  UNKNOWN = 0;
  DEFAULT = 1;
  FILE = 2;