opendev/gerrit
Code Issues Proposed changes

Update doc for addMenuLink

Browse Source 
Bug: Issue 11714
Change-Id: I09f65cba904f243363f797138e9f8643302805b7
(cherry picked from commit 34417a10ae)
This commit is contained in:
Tao Zhou
2019-10-22 13:36:59 +02:00
committed by Paladox none
parent e0ebf9d3e5
commit 9fc57863c9
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
Documentation/pg-plugin-admin-api.txt
View File

@@ -4,14 +4,18 @@ This API is provided by link:pg-plugin-dev.html#plugin-admin[plugin.admin()]
and provides customization of the admin menu. and provides customization of the admin menu.
== addMenuLink == addMenuLink
`adminApi.addMenuLink(text, url, opt_external, opt_capabilities)` `adminApi.addMenuLink(text, url, opt_capability)`
Add a new link to the end of the admin navigation menu. Add a new link to the end of the admin navigation menu.
.Params .Params
- *text* String text to appear in the link. - *text* String text to appear in the link.
- *url* String of the destination URL for the link. - *url* String of the destination URL for the link.
- *opt_capability* String of capability required to show this link.
When adding an external link, the URL provided should be a full URL. Otherwise, When adding an external link, the URL provided should be a full URL. Otherwise,
a non-external link should be relative beginning with a slash. For example, to a non-external link should be relative beginning with a slash. For example, to
create a link to open changes, use the value `/q/status:open`. create a link to open changes, use the value `/q/status:open`.
See more about capability from
link:rest-api-accounts.html#list-account-capabilities[List Account Capabilities].