Fix documentation of config_web_links field in ProjectAccessInfo
* 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
diff --git a/Documentation/rest-api-access.txt b/Documentation/rest-api-access.txt
index 6664aa2..45a39d8 100644
--- a/Documentation/rest-api-access.txt
+++ b/Documentation/rest-api-access.txt
@@ -406,14 +406,15 @@
|`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.
|==================================
