update jsdoc

hashicorp · Jul 23, 2024 · 94f1e9b · 94f1e9b
1 parent b8fa780
commit 94f1e9b
Showing 1 changed file with 16 additions and 5 deletions.
diff --git a/ui/lib/kv/addon/components/kv-subkeys.js b/ui/lib/kv/addon/components/kv-subkeys.js
@@ -9,18 +9,29 @@ import { tracked } from '@glimmer/tracking';
 /**
  * @module KvSubkeys
  * @description
- * ```
- * sample subkeys:
-  {
+sample secret data:
+```
+ {
+  "foo": "abc",
+  "bar": {
+    "baz": "def"
+  },
+  "quux": {}
+}
+```
+sample subkeys:
+```
+ this.subkeys = {
     "bar": {
         "baz": null
     },
     "foo": null,
     "quux": null
 }
- * ```
+```
  * 
- * <KvSubkeys @subkeys={{@subkeys}} />
+ * @example
+ * <KvSubkeys @subkeys={{this.subkeys}} />
  *
  * @param {object} subkeys - leaf keys of a kv v2 secret, all values (unless a nested object with more keys) return null
  */