opendev/gerrit
Code Issues Proposed changes

Don't limit tables to 50% width in REST API documentation

Browse Source 
Fixing the width of the tables to 50% makes it difficult to read
entries that have long descriptions.

Change-Id: Ic080c684bc5cf009d47149b2839390c66f3e9af0
This commit is contained in:
David Pursehouse 2014-11-25 17:24:47 +09:00
parent 76af7f8bb5
commit ae36719784
8 changed files with 101 additions and 102 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -292,7 +292,7 @@ The entries in the map are sorted by project name.
The `AccessSectionInfo` describes the access rights that are assigned
on a ref.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|==================================
|Field Name ||Description
|`permissions` ||
@ -306,7 +306,7 @@ entities.
The `PermissionInfo` entity contains information about an assigned
permission.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|==================================
|Field Name ||Description
|`label` |optional|
@ -324,7 +324,7 @@ link:#permission-info[PermissionRuleInfo] entities.
The `PermissionRuleInfo` entity contains information about a permission
rule that is assigned to group.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|==================================
|Field Name ||Description
|`action` ||
@ -346,7 +346,7 @@ The max value of the permission range.
The `ProjectAccessInfo` entity contains information about the access
rights for a project.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|==================================
|Field Name ||Description
|`revision` ||

26
Documentation/rest-api-accounts.txt
View File

@ -1212,7 +1212,7 @@ The sequence number of the SSH key.
=== AccountInfo
The `AccountInfo` entity contains information about an account.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|===========================
|Field Name ||Description
|`_account_id` ||The numeric ID of the account.
@ -1233,7 +1233,7 @@ account information] is requested.
The `AccountInput` entity contains information for the creation of
a new account.
[options="header",width="50%",cols="1,^2,4"]
[options="header",cols="1,^2,4"]
|============================
|Field Name ||Description
|`username` |optional|
@ -1252,7 +1252,7 @@ the groups to which the user should be added.
The `AccountNameInput` entity contains information for setting a name
for an account.
[options="header",width="50%",cols="1,^2,4"]
[options="header",cols="1,^2,4"]
|=============================
|Field Name ||Description
|`name` |optional|The new full name of the account. +
@ -1264,7 +1264,7 @@ If not set or if set to an empty string, the account name is deleted.
The `CapabilityInfo` entity contains information about the global
capabilities of a user.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|=================================
|Field Name ||Description
|`accessDatabase` |not set if `false`|Whether the user has the
@ -1321,7 +1321,7 @@ link:access-control.html#capability_viewQueue[View Queue] capability.
=== PreferencesInfo
The `PreferencesInfo` entity contains information about a user's preferences.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|=====================================
|Field Name ||Description
|`changes_per_page` ||
@ -1370,7 +1370,7 @@ Allowed values are `OLD_UI`, `CHANGE_SCREEN2`.
The `PreferencesInput` entity contains information for setting the
user preferences. Fields which are not set will not be updated.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|=====================================
|Field Name ||Description
|`changes_per_page` |optional|
@ -1419,7 +1419,7 @@ Allowed values are `OLD_UI`, `CHANGE_SCREEN2`.
The `DiffPreferencesInfo` entity contains information about the diff
preferences of a user.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|===========================================
|Field Name ||Description
|`context` ||
@ -1475,7 +1475,7 @@ The `DiffPreferencesInput` entity contains information for setting the
diff preferences of a user. Fields which are not set will not be
updated.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|===========================================
|Field Name ||Description
|`context` |optional|
@ -1527,7 +1527,7 @@ Number of spaces that should be used to display one tab.
The `EmailInfo` entity contains information about an email address of a
user.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|========================
|Field Name ||Description
|`email` ||The email address.
@ -1544,7 +1544,7 @@ this address.
The `EmailInput` entity contains information for registering a new
email address.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|==============================
|Field Name ||Description
|`email` ||
@ -1566,7 +1566,7 @@ confirmation.
The `HttpPasswordInput` entity contains information for setting/generating
an HTTP password.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|============================
|Field Name ||Description
|`generate` |`false` if not set|
@ -1583,7 +1583,7 @@ password is deleted.
The `QueryLimitInfo` entity contains information about the
link:access-control.html#capability_queryLimit[Query Limit] of a user.
[options="header",width="50%",cols="1,6"]
[options="header",cols="1,6"]
|================================
|Field Name |Description
|`min` |Lower limit.
@ -1595,7 +1595,7 @@ link:access-control.html#capability_queryLimit[Query Limit] of a user.
The `SshKeyInfo` entity contains information about an SSH key of a
user.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|=============================
|Field Name ||Description
|`seq` ||The sequence number of the SSH key.

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

@ -2995,7 +2995,7 @@ This can be:
=== AbandonInput
The `AbandonInput` entity contains information for abandoning a change.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|===========================
|Field Name ||Description
|`message` |optional|
@ -3009,7 +3009,7 @@ The `ActionInfo` entity describes a REST API call the client can
make to manipulate a resource. These are frequently implemented by
plugins and may be discovered at runtime.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|====================================
|Field Name ||Description
|`method` |optional|
@ -3034,7 +3034,7 @@ at the server or permissions are modified. Not present if false.
The `AddReviewerResult` entity describes the result of adding a
reviewer to a change.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|===========================
|Field Name ||Description
|`reviewers` |optional|
@ -3057,7 +3057,7 @@ user for a label on a change.
link:rest-api-accounts.html#account-info[AccountInfo].
In addition `ApprovalInfo` has the following fields:
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|===========================
|Field Name ||Description
|`value` |optional|
@ -3072,7 +3072,7 @@ The time and date describing when the approval was made.
=== GroupBaseInfo
The `GroupBaseInfo` entity contains base information about the group.
[options="header",width="50%",cols="1,6"]
[options="header",cols="1,6"]
|==========================
|Field Name |Description
|`id` |The id of the group.
@ -3083,7 +3083,7 @@ The `GroupBaseInfo` entity contains base information about the group.
=== ChangeInfo
The `ChangeInfo` entity contains information about a change.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|==================================
|Field Name ||Description
|`id` ||
@ -3165,7 +3165,7 @@ Only set on either the last or the first change that is returned.
The `RelatedChangesInfo` entity contains information about related
changes.
[options="header",width="50%",cols="1,6"]
[options="header",cols="1,6"]
|===========================
|Field Name |Description
|`changes` |A list of
@ -3180,7 +3180,7 @@ oldest. Empty if there are no related changes.
The `RelatedChangeAndCommitInfo` entity contains information about
a related change and commit.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|===========================
|Field Name ||Description
|`change_id` |optional|The Change-Id of the change.
@ -3196,7 +3196,7 @@ link:#commit-info[CommitInfo] entity.
The `ChangeMessageInfo` entity contains information about a message
attached to a change.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|==================================
|Field Name ||Description
|`id` ||The ID of the message.
@ -3215,7 +3215,7 @@ Which patchset (if any) generated this message.
=== CherryPickInput
The `CherryPickInput` entity contains information for cherry-picking a change to a new branch.
[options="header",width="50%",cols="1,6"]
[options="header",cols="1,6"]
|===========================
|Field Name |Description
|`message` |Commit message for the cherry-picked change
@ -3226,7 +3226,7 @@ The `CherryPickInput` entity contains information for cherry-picking a change to
=== CommentInfo
The `CommentInfo` entity contains information about an inline comment.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|===========================
|Field Name ||Description
|`id` ||The URL encoded UUID of the comment.
@ -3261,7 +3261,7 @@ Unset for draft comments, assumed to be the calling user.
The `CommentInput` entity contains information for creating an inline
comment.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|===========================
|Field Name ||Description
|`id` |optional|
@ -3298,7 +3298,7 @@ comment is deleted.
=== CommentRange
The `CommentRange` entity describes the range of an inline comment.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|===========================
|Field Name ||Description
|`start_line` ||The start line number of the range.
@ -3311,7 +3311,7 @@ The `CommentRange` entity describes the range of an inline comment.
=== CommitInfo
The `CommitInfo` entity contains information about a commit.
[options="header",width="50%",cols="1,6"]
[options="header",cols="1,6"]
|==========================
|Field Name |Description
|`commit` |The commit ID.
@ -3333,7 +3333,7 @@ The subject of the commit (header line of the commit message).
The `DiffContent` entity contains information about the content differences
in a file.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|==========================
|Field Name ||Description
|`a` |optional|Content only in the file on side A (deleted in B).
@ -3357,7 +3357,7 @@ used instead of ab.
=== DiffFileMetaInfo
The `DiffFileMetaInfo` entity contains meta information about a file diff.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|==========================
|Field Name ||Description
|`name` ||The name of the file.
@ -3373,7 +3373,7 @@ link:rest-api-changes.html#web-link-info[WebLinkInfo] entries.
The `DiffInfo` entity contains information about the diff of a file
in a revision.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|==========================
|Field Name ||Description
|`meta_a` |not present when the file is added|
@ -3410,7 +3410,7 @@ the length calculation, and thus it is possible for the edits to span newlines.
The `FetchInfo` entity contains information about how to fetch a patch
set via a certain protocol.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|==========================
|Field Name ||Description
|`url` ||The URL of the project.
@ -3425,7 +3425,7 @@ Only set if link:#download_commands[download commands] are requested.
=== FileInfo
The `FileInfo` entity contains information about a file in a patch set.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|=============================
|Field Name ||Description
|`status` |optional|
@ -3449,7 +3449,7 @@ Not set for binary files or if no lines were deleted.
The `GitPersonInfo` entity contains information about the
author/committer of a commit.
[options="header",width="50%",cols="1,6"]
[options="header",cols="1,6"]
|==========================
|Field Name |Description
|`name` |The name of the author/committer.
@ -3473,7 +3473,7 @@ link:#labels[`LABELS`] and link:#detailed-labels[`DETAILED_LABELS`].
users and the allowed range of votes for the current user, use `DETAILED_LABELS`.
==== Common fields
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|===========================
|Field Name ||Description
|`optional` |not set if `false`|
@ -3483,7 +3483,7 @@ set.
|===========================
==== Fields set by `LABELS`
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|===========================
|Field Name ||Description
|`approved` |optional|One user who approved this label on the change
@ -3508,7 +3508,7 @@ This value may be outside the range specified in permitted_labels.
|===========================
==== Fields set by `DETAILED_LABELS`
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|===========================
|Field Name ||Description
|`all` |optional|List of all approvals for this label as a list
@ -3523,7 +3523,7 @@ to the value descriptions.
The `MergeableInfo` entity contains information about the mergeability of a
change.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|============================
|Field Name ||Description
|`submit_type` ||
@ -3540,7 +3540,7 @@ A list of other branch names where this change could merge cleanly
=== RestoreInput
The `RestoreInput` entity contains information for restoring a change.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|===========================
|Field Name ||Description
|`message` |optional|
@ -3552,7 +3552,7 @@ change.
=== RevertInput
The `RevertInput` entity contains information for reverting a change.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|===========================
|Field Name ||Description
|`message` |optional|
@ -3564,7 +3564,7 @@ change.
=== ReviewInfo
The `ReviewInfo` entity contains information about a review.
[options="header",width="50%",cols="1,6"]
[options="header",cols="1,6"]
|===========================
|Field Name |Description
|`labels` |
@ -3577,7 +3577,7 @@ voting values.
The `ReviewInput` entity contains information for adding a review to a
revision.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|============================
|Field Name ||Description
|`message` |optional|
@ -3622,7 +3622,7 @@ link:rest-api-accounts.html#account-info[AccountInfo] and includes
link:#detailed-accounts[detailed account information].
In addition `ReviewerInfo` has the following fields:
[options="header",width="50%",cols="1,6"]
[options="header",cols="1,6"]
|==========================
|Field Name |Description
|`approvals` |
@ -3635,7 +3635,7 @@ approval values ("`-2`", "`-1`", "`0`", "`+1`", "`+2`").
The `ReviewerInput` entity contains information for adding a reviewer
to a change.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|===========================
|Field Name ||Description
|`reviewer` ||
@ -3658,7 +3658,7 @@ Not all fields are returned by default. Additional fields can
be obtained by adding `o` parameters as described in
link:#list-changes[Query Changes].
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|===========================
|Field Name ||Description
|`draft` |not set if `false`|Whether the patch set is a draft.
@ -3697,7 +3697,7 @@ link:#web-links[WEB_LINKS] option is requested.
=== RuleInput
The `RuleInput` entity contains information to test a Prolog rule.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|===========================
|Field Name ||Description
|`rule`||
@ -3725,7 +3725,7 @@ link:rest-api-changes.html#group-base-info[GroupBaseInfo] entity.
The `SubmitInfo` entity contains information about the change status
after submitting.
[options="header",width="50%",cols="1,6"]
[options="header",cols="1,6"]
|==========================
|Field Name |Description
|`status` |
@ -3749,7 +3749,7 @@ not with the identity of the CI account.
=== SubmitInput
The `SubmitInput` entity contains information for submitting a change.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|===========================
|Field Name ||Description
|`wait_for_merge`|`false` if not set|
@ -3763,7 +3763,7 @@ could be merged successfully.
=== SubmitRecord
The `SubmitRecord` entity describes results from a submit_rule.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|===========================
|Field Name ||Description
|`status`||
@ -3798,7 +3798,7 @@ the failure of the rule predicate.
=== TopicInput
The `TopicInput` entity contains information for setting a topic.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|===========================
|Field Name ||Description
|`topic` |optional|The topic. +
@ -3810,7 +3810,7 @@ The topic will be deleted if not set.
The `IncludedInInfo` entity contains information about the branches a
change was merged into and tags it was tagged with.
[options="header",width="50%",cols="1,6"]
[options="header",cols="1,6"]
|==========================
|Field Name |Description
|`branches` | The list of branches this change was merged into.
@ -3823,7 +3823,7 @@ Each tag is listed without the 'refs/tags/' prefix.
=== WebLinkInfo
The `WebLinkInfo` entity describes a link to an external site.
[options="header",width="50%",cols="1,6"]
[options="header",cols="1,6"]
|======================
|Field Name|Description
|`name` |The link name.
@ -3835,7 +3835,7 @@ The `WebLinkInfo` entity describes a link to an external site.
=== EditInfo
The `EditInfo` entity contains information about a change edit.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|===========================
|Field Name ||Description
|`commit` ||The commit of change edit as
@ -3859,7 +3859,7 @@ link:#file-info[FileInfo] entities.
The `ChangeEditInput` entity contains information for restoring a
path within change edit.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|===========================
|Field Name ||Description
|`restore_path`|optional|Path to file to restore.

26
Documentation/rest-api-config.txt
View File

@ -826,7 +826,7 @@ The ID of the task (hex string).
=== CacheInfo
The `CacheInfo` entity contains information about a cache.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|==================================
|Field Name ||Description
|`name` |
@ -851,7 +851,7 @@ HitRatioInfo] entity.
=== CapabilityInfo
The `CapabilityInfo` entity contains information about a capability.
[options="header",width="50%",cols="1,6"]
[options="header",cols="1,6"]
|=================================
|Field Name |Description
|`id` |capability ID
@ -863,7 +863,7 @@ The `CapabilityInfo` entity contains information about a capability.
The `CacheOperationInput` entity contains information about an
operation that should be executed on caches.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|==================================
|Field Name ||Description
|`operation` ||
@ -883,7 +883,7 @@ specified depends on the operation being executed.
The `EntriesInfo` entity contains information about the entries in a
cache.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|==================================
|Field Name ||Description
|`mem` |optional|Number of cache entries that are held in memory.
@ -901,7 +901,7 @@ with a unit abbreviation (`k`: kilobytes, `m`: megabytes,
The `HitRatioInfo` entity contains information about the hit ratio of a
cache.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|==================================
|Field Name ||Description
|`mem` ||
@ -915,7 +915,7 @@ Only set for disk caches.
=== JvmSummaryInfo
The `JvmSummaryInfo` entity contains information about the JVM.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|========================================
|Field Name ||Description
|`vm_vendor` ||The vendor of the virtual machine.
@ -936,7 +936,7 @@ The host on which Gerrit is running.
The `MemSummaryInfo` entity contains information about the current
memory usage.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|============================
|Field Name ||Description
|`total` ||
@ -963,7 +963,7 @@ The number of open files.
The `SummaryInfo` entity contains information about the current state
of the server.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|============================
|Field Name ||Description
|`task_summary` ||
@ -985,7 +985,7 @@ Only set if the `jvm` option was set.
The `TaskInfo` entity contains information about a task in a background
work queue.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|====================================
|Field Name ||Description
|`id` ||The ID of the task.
@ -1006,7 +1006,7 @@ project.
The `TaskSummaryInfo` entity contains information about the current
tasks.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|============================
|Field Name ||Description
|`total` |optional|
@ -1024,7 +1024,7 @@ Number of currently sleeping tasks.
The `ThreadSummaryInfo` entity contains information about the current
threads.
[options="header",width="50%",cols="1,6"]
[options="header",cols="1,6"]
|===========================
|Field Name |Description
|`cpus` |
@ -1048,7 +1048,7 @@ included: `NEW`, `RUNNABLE`, `BLOCKED`, `WAITING`, `TIMED_WAITING` and
The `TopMenuEntryInfo` entity contains information about a top menu
entry.
[options="header",width="50%",cols="1,6"]
[options="header",cols="1,6"]
|=================================
|Field Name |Description
|`name` |Name of the top menu entry.
@ -1060,7 +1060,7 @@ entry.
The `TopMenuItemInfo` entity contains information about a menu item in
a top menu entry.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|========================
|Field Name ||Description
|`url` ||The URL of the menu item link.

2
Documentation/rest-api-documentation.txt
View File

@ -130,7 +130,7 @@ get::/Documentation/?q=keyword
=== DocResult
The `DocResult` entity contains information about a document.
[options="header",width="50%",cols="1,^2,4"]
[options="header",cols="1,^2,4"]
|=========================
|Field Name ||Description
|`title` ||The title of the document.

13
Documentation/rest-api-groups.txt
View File

@ -1113,7 +1113,7 @@ Group name that uniquely identifies one group.
The `GroupInfo` entity contains information about a group. This can be
a Gerrit internal group, or an external group that is known to Gerrit.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|===========================
|Field Name ||Description
|`id` ||The URL encoded UUID of the group.
@ -1139,7 +1139,6 @@ Only set if link:#includes[included groups] are requested.
|===========================
The type of a group can be deduced from the group's UUID:
[width="50%"]
|============
|UUID matches "^[0-9a-f]\{40\}$"|Gerrit internal group
|UUID starts with "global:"|Gerrit system group
@ -1152,7 +1151,7 @@ The type of a group can be deduced from the group's UUID:
The 'GroupInput' entity contains information for the creation of
a new internal group.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|===========================
|Field Name ||Description
|`name` |optional|The name of the group (not encoded). +
@ -1172,7 +1171,7 @@ If not set, the new group will be self-owned.
The `GroupsInput` entity contains information about groups that should
be included into a group or that should be deleted from a group.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|==========================
|Field Name ||Description
|`_one_group` |optional|
@ -1186,7 +1185,7 @@ should be included or deleted.
=== GroupOptionsInfo
Options of the group.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|=============================
|Field Name ||Description
|`visible_to_all`|not set if `false`|
@ -1197,7 +1196,7 @@ Whether the group is visible to all registered users.
=== GroupOptionsInput
New options for a group.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|=============================
|Field Name ||Description
|`visible_to_all`|not set if `false`|
@ -1210,7 +1209,7 @@ MembersInput
The `MembersInput` entity contains information about accounts that should
be added as members to a group or that should be deleted from the group.
[options="header",width="50%",cols="1,^1,5"]
[options="header",cols="1,^1,5"]
|==========================
|Field Name ||Description
|`_one_member`|optional|

4
Documentation/rest-api-plugins.txt
View File

@ -247,7 +247,7 @@ The ID of the plugin.
=== PluginInfo
The `PluginInfo` entity describes a plugin.
[options="header",width="50%",cols="1,^2,4"]
[options="header",cols="1,^2,4"]
|=======================
|Field Name ||Description
|`id` ||The ID of the plugin.
@ -260,7 +260,7 @@ The `PluginInfo` entity describes a plugin.
=== PluginInput
The `PluginInput` entity describes a plugin that should be installed.
[options="header",width="50%",cols="1,6"]
[options="header",cols="1,6"]
|======================
|Field Name|Description
|`url` |URL to the plugin jar.

44
Documentation/rest-api-projects.txt
View File

@ -1783,7 +1783,7 @@ The name of the project.
=== BranchInfo
The `BranchInfo` entity contains information about a branch.
[options="header",width="50%",cols="1,^2,4"]
[options="header",cols="1,^2,4"]
|=========================
|Field Name ||Description
|`ref` ||The ref of the branch.
@ -1800,7 +1800,7 @@ link:rest-api-changes.html#web-link-info[WebLinkInfo] entries.
The `BanInput` entity contains information for banning commits in a
project.
[options="header",width="50%",cols="1,^2,4"]
[options="header",cols="1,^2,4"]
|=======================
|Field Name||Description
|`commits` ||List of commits to be banned.
@ -1811,7 +1811,7 @@ project.
=== BanResultInfo
The `BanResultInfo` entity describes the result of banning commits.
[options="header",width="50%",cols="1,^2,4"]
[options="header",cols="1,^2,4"]
|=============================
|Field Name ||Description
|`newly_banned` |optional|List of newly banned commits.
@ -1824,7 +1824,7 @@ The `BanResultInfo` entity describes the result of banning commits.
The `BranchInput` entity contains information for the creation of
a new branch.
[options="header",width="50%",cols="1,^2,4"]
[options="header",cols="1,^2,4"]
|=======================
|Field Name||Description
|`ref` |optional|
@ -1841,7 +1841,7 @@ If not set, `HEAD` will be used as base revision.
The `ConfigInfo` entity contains information about the effective project
configuration.
[options="header",width="50%",cols="1,^2,4"]
[options="header",cols="1,^2,4"]
|=======================================================
|Field Name ||Description
|`description` |optional|
@ -1902,7 +1902,7 @@ link:rest-api-changes.html#action-info[ActionInfo] entities.
=== ConfigInput
The `ConfigInput` entity describes a new project configuration.
[options="header",width="50%",cols="1,^2,4"]
[options="header",cols="1,^2,4"]
|======================================================
|Field Name ||Description
|`description` |optional|
@ -1962,7 +1962,7 @@ ConfigParameterInfo
The `ConfigParameterInfo` entity describes a project configuration
parameter.
[options="header",width="50%",cols="1,^2,4"]
[options="header",cols="1,^2,4"]
|===============================
|Field Name ||Description
|`display_name` |optional|
@ -2001,7 +2001,7 @@ The list of permitted values, only set if the `type` is `LIST`.
The `DashboardInfo` entity contains information about a project
dashboard.
[options="header",width="50%",cols="1,^2,4"]
[options="header",cols="1,^2,4"]
|===============================
|Field Name ||Description
|`id` ||
@ -2038,7 +2038,7 @@ The list of link:#dashboard-section-info[sections] in the dashboard.
The `DashboardInput` entity contains information to create/update a
project dashboard.
[options="header",width="50%",cols="1,^2,4"]
[options="header",cols="1,^2,4"]
|=============================
|Field Name ||Description
|`id` |optional|
@ -2052,7 +2052,7 @@ Message that should be used to commit the change of the dashboard.
The `DashboardSectionInfo` entity contains information about a section
in a dashboard.
[options="header",width="50%",cols="1,6"]
[options="header",cols="1,6"]
|===========================
|Field Name |Description
|`name` |The title of the section.
@ -2065,7 +2065,7 @@ Tokens such as `${project}` are not resolved.
The `GCInput` entity contains information to run the Git garbage
collection.
[options="header",width="50%",cols="1,^2,4"]
[options="header",cols="1,^2,4"]
|=============================
|Field Name ||Description
|`show_progress` |`false` if not set|
@ -2077,7 +2077,7 @@ Whether progress information should be shown.
The `HeadInput` entity contains information for setting `HEAD` for a
project.
[options="header",width="50%",cols="1,6"]
[options="header",cols="1,6"]
|============================
|Field Name |Description
|`ref` |
@ -2089,7 +2089,7 @@ omitted.
=== InheritedBooleanInfo
A boolean value that can also be inherited.
[options="header",width="50%",cols="1,^2,4"]
[options="header",cols="1,^2,4"]
|================================
|Field Name ||Description
|`value` ||
@ -2107,7 +2107,7 @@ The `MaxObjectSizeLimitInfo` entity contains information about the
link:config-gerrit.html#receive.maxObjectSizeLimit[max object size
limit] of a project.
[options="header",width="50%",cols="1,^2,4"]
[options="header",cols="1,^2,4"]
|===============================
|Field Name ||Description
|`value` |optional|
@ -2128,7 +2128,7 @@ Not set if there is no global limit for the object size.
The `ProjectDescriptionInput` entity contains information for setting a
project description.
[options="header",width="50%",cols="1,^2,4"]
[options="header",cols="1,^2,4"]
|=============================
|Field Name ||Description
|`description` |optional|The project description. +
@ -2143,7 +2143,7 @@ branch.
=== ProjectInfo
The `ProjectInfo` entity contains information about a project.
[options="header",width="50%",cols="1,^2,4"]
[options="header",cols="1,^2,4"]
|===========================
|Field Name ||Description
|`id` ||The URL encoded project name.
@ -2167,7 +2167,7 @@ link:rest-api-changes.html#web-link-info[WebLinkInfo] entries.
The `ProjectInput` entity contains information for the creation of
a new project.
[options="header",width="50%",cols="1,^2,4"]
[options="header",cols="1,^2,4"]
|=========================================
|Field Name ||Description
|`name` |optional|
@ -2227,7 +2227,7 @@ of parameter names to values.
The `ProjectParentInput` entity contains information for setting a
project parent.
[options="header",width="50%",cols="1,^2,4"]
[options="header",cols="1,^2,4"]
|=============================
|Field Name ||Description
|`parent` ||The name of the parent project.
@ -2240,7 +2240,7 @@ in the `project.config` file to the `refs/meta/config` branch.
=== ReflogEntryInfo
The `ReflogEntryInfo` entity describes an entry in a reflog.
[options="header",width="50%",cols="1,6"]
[options="header",cols="1,6"]
|============================
|Field Name |Description
|`old_id` |The old commit ID.
@ -2256,7 +2256,7 @@ link:rest-api-changes.html#git-person-info[GitPersonInfo] entity.
The `RepositoryStatisticsInfo` entity contains information about
statistics of a Git repository.
[options="header",width="50%",cols="1,6"]
[options="header",cols="1,6"]
|======================================
|Field Name |Description
|`number_of_loose_objects` |Number of loose objects.
@ -2272,7 +2272,7 @@ statistics of a Git repository.
=== TagInfo
The `TagInfo` entity contains information about a tag.
[options="header",width="50%",cols="1,^2,4"]
[options="header",cols="1,^2,4"]
|=========================
|Field Name ||Description
|`ref` ||The ref of the tag.
@ -2290,7 +2290,7 @@ link:rest-api-changes.html#git-person-info[GitPersonInfo] entity.
=== ThemeInfo
The `ThemeInfo` entity describes a theme.
[options="header",width="50%",cols="1,^2,4"]
[options="header",cols="1,^2,4"]
|=============================
|Field Name ||Description
|`css` |optional|