Adds a description field to plugin.json's pages:role field (#62439)

* Adds a description field to plugin.json's pages:role field

There's no description of what a page object's "role" setting does. It
controls whether a page will appear in the navigation menu for a user
with a given role.

* Update plugindef.cue with comments to match documentation.

* make gen-cue
This commit is contained in:
Joe Blubaugh
2023-02-03 14:50:24 +01:00
committed by GitHub
parent c819e95687
commit 41dc88bd25
3 changed files with 10 additions and 5 deletions
+3 -1
View File
@@ -99,6 +99,8 @@ seqs: [
// (Legacy) The Angular component to use for a page.
component?: string
// The minimum role a user must have to see this page in the navigation menu.
role?: "Admin" | "Editor" | "Viewer"
// RBAC action the user must have to access the route
@@ -107,7 +109,7 @@ seqs: [
// Used for app plugins.
path?: string
// Add the include to the side menu.
// Add the include to the navigation menu.
addToNav?: bool
// Page or dashboard when user clicks the icon in the side menu.