add desc

replicatedhq · Mar 8, 2019 · 681ef98 · 681ef98
1 parent ba94132
commit 681ef98
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 4 deletions.
diff --git a/hack/docs/mutations.json b/hack/docs/mutations.json
@@ -1107,9 +1107,17 @@
   {
     "path": "properties.lifecycle.properties.v1.items.properties.render",
     "merge": {
-      "description": "A `render` step will do the work of collecting configuration values from a user and using them to generate the final assets that can be used to deploy an application.",
+      "description": "A `render` step will do the work of collecting configuration values from a user and using them to generate the final assets that can be used to deploy an application. If an `assets` field is set, those assets will be rendered rather than the top-level `assets` object",
       "examples": [
-        {}
+        {},
+        { "root": "./"},
+        {
+          "root": "./",
+          "assets": {
+            "v1": [{
+              "inline": { "contents": "some-asset", "dest": "some-path.txt"}
+            }
+        ]}}
       ]
     },
     "replace": {

diff --git a/hack/docs/schema.json b/hack/docs/schema.json
@@ -1088,9 +1088,25 @@
                 ]
               },
               "render": {
-                "description": "A `render` step will do the work of collecting configuration values from a user and using them to generate the final assets that can be used to deploy an application.",
+                "description": "A `render` step will do the work of collecting configuration values from a user and using them to generate the final assets that can be used to deploy an application. If an `assets` field is set, those assets will be rendered rather than the top-level `assets` object",
                 "examples": [
-                  {}
+                  {},
+                  {
+                    "root": "./"
+                  },
+                  {
+                    "root": "./",
+                    "assets": {
+                      "v1": [
+                        {
+                          "inline": {
+                            "contents": "some-asset",
+                            "dest": "some-path.txt"
+                          }
+                        }
+                      ]
+                    }
+                  }
                 ],
                 "type": "object",
                 "properties": {