opendev/gerrit
Code Issues Proposed changes

Fix documentation of config_web_links field in ProjectAccessInfo

Browse Source 
* the field is optional
* the field contains a list of WebLinkInfo entities (not a list of
  strings)
* the name should be lowercase_underscore (not camelCase)

While we are at it also fix the documentation of WebLinkInfo:

* document the target field
* mark the image_url field as optional

Signed-off-by: Edwin Kempin <ekempin@google.com>
Change-Id: I71384e297e68345caf7e67281357c75e9b793923
This commit is contained in:
Edwin Kempin
2021-01-29 13:50:04 +01:00
parent a1130c4730
commit af35ce407e
2 changed files with 13 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
Documentation/rest-api-access.txt
View File

@@ -406,14 +406,15 @@ Whether the calling user can add any tag ref.
|`config_visible` |not set if `false`|
Whether the calling user can see the `refs/meta/config` branch of the
project.
|`groups` ||A map of group UUID to
|`groups` ||A map of group UUID to
link:rest-api-groups.html#group-info[GroupInfo] objects, with names and
URLs for the group UUIDs used in the `local` map.
This will include names for groups that might
be invisible to the caller.
|`configWebLinks` ||
A list of URLs that display the history of the configuration file
governing this project's access rights.
|`config_web_links` |optional|
Links to the history of the configuration file governing this project's access
rights as list of link:rest-api-changes.html#web-link-info[WebLinkInfo]
entities.
|==================================

15
Documentation/rest-api-changes.txt
View File

@@ -8082,13 +8082,14 @@ to max values.
=== WebLinkInfo
The `WebLinkInfo` entity describes a link to an external site.
[options="header",cols="1,6"]
|======================
|Field Name|Description
|`name` |The link name.
|`url` |The link URL.
|`image_url`|URL to the icon of the link.
|======================
[options="header",cols="1,^1,5"]
|========================
|Field Name ||Description
|`name` ||The link name.
|`url` ||The link URL.
|`image_url`|optional|URL to the icon of the link.
|`target` |optional|The target window in which the web link should be opened.
|========================
[[work-in-progress-input]]
=== WorkInProgressInput