add isPatchAllowed to jsdoc (#28260)

hashicorp · Sep 3, 2024 · de87c7f · de87c7f
1 parent 3a9db72
commit de87c7f
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/ui/lib/kv/addon/components/kv-subkeys-card.js b/ui/lib/kv/addon/components/kv-subkeys-card.js
@@ -32,9 +32,11 @@ sample subkeys:
 ```
  * 
  * @example
- * <KvSubkeysCard @subkeys={{this.subkeys}} />
+ * <KvSubkeysCard @subkeys={{this.subkeys}} @isPatchAllowed={{true}} />
  *
  * @param {object} subkeys - leaf keys of a kv v2 secret, all values (unless a nested object with more keys) return null
+ * @param {boolean} isPatchAllowed - true if the version is enterprise AND a user has "patch" secret + "read" subkeys capabilities, if true renders the "Patch secret" action
+
  */
 
 export default class KvSubkeysCard extends Component {

diff --git a/ui/lib/kv/addon/components/page/secret/details.js b/ui/lib/kv/addon/components/page/secret/details.js
@@ -33,7 +33,7 @@ import { isAdvancedSecret } from 'core/utils/advanced-secret';
  * @param {boolean} canReadData - if true and the secret is not destroyed/deleted the copy secret dropdown renders
  * @param {boolean} canReadMetadata - if true it renders the kv select version dropdown in the toolbar and "Version History" tab
  * @param {boolean} canUpdateData - if true it renders "Create new version" toolbar action
- * @param {boolean} isPatchAllowed - if true it renders "Patch latest version" toolbar action
+ * @param {boolean} isPatchAllowed - isPatchAllowed is true if the version is enterprise AND a user has "patch" secret + "read" subkeys capabilities, if true it renders "Patch latest version" toolbar action
  * @param {model} metadata - Ember data model: 'kv/metadata'
  * @param {string} path - path of kv secret 'my/secret' used as the title for the KV page header
  * @param {model} secret - Ember data model: 'kv/data'

diff --git a/ui/lib/kv/addon/components/page/secret/overview.js b/ui/lib/kv/addon/components/page/secret/overview.js
@@ -14,6 +14,7 @@ import { isDeleted } from 'kv/utils/kv-deleted';
  * @breadcrumbs={{this.breadcrumbs}}
  * @canReadMetadata={{true}}
  * @canUpdateData={{true}}
+ * @isPatchAllowed={{true}}
  * @metadata={{this.model.metadata}}
  * @path={{this.model.path}}
  * @subkeys={{this.model.subkeys}}
@@ -23,6 +24,7 @@ import { isDeleted } from 'kv/utils/kv-deleted';
  * @param {array} breadcrumbs - Array to generate breadcrumbs, passed to the page header component
  * @param {boolean} canReadMetadata - permissions to read metadata
  * @param {boolean} canUpdateData - permissions to create a new version of a secret
+ * @param {boolean} isPatchAllowed - isPatchAllowed is true if the version is enterprise AND a user has "patch" secret + "read" subkeys capabilities, passed to KvSubkeysCard
  * @param {model} metadata - Ember data model: 'kv/metadata'
  * @param {string} path - path to request secret data for selected version
  * @param {object} subkeys - API response from subkeys endpoint, object with "subkeys" and "metadata" keys. This arg is null for community edition