Sort REST JSON entities alphabetically
The JSON entities in the REST documentation were sorted alphabetically to make it easier for readers to find a certain JSON entity in the index, but over time some JSON entities got misplaced. Change-Id: I16ca3d97fd292481f0648dd6c5f49271adf17a1d Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
This commit is contained in:
Edwin Kempin
David Pursehouse
parent
43a6584829
commit
521c124a81
@ -1351,87 +1351,6 @@ link:access-control.html#capability_viewPlugins[View Plugins] capability.
|
||||
link:access-control.html#capability_viewQueue[View Queue] capability.
|
||||
|=================================
|
||||
|
||||
[[preferences-info]]
|
||||
=== PreferencesInfo
|
||||
The `PreferencesInfo` entity contains information about a user's preferences.
|
||||
|
||||
[options="header",cols="1,^1,5"]
|
||||
|=====================================
|
||||
|Field Name ||Description
|
||||
|`changes_per_page` ||
|
||||
The number of changes to show on each page.
|
||||
Allowed values are `10`, `25`, `50`, `100`.
|
||||
|`show_site_header` |not set if `false`|
|
||||
Whether the site header should be shown.
|
||||
|`use_flash_clipboard` |not set if `false`|
|
||||
Whether to use the flash clipboard widget.
|
||||
|`download_scheme` ||
|
||||
The type of download URL the user prefers to use.
|
||||
|`download_command` ||
|
||||
The type of download command the user prefers to use.
|
||||
|`copy_self_on_email` |not set if `false`|
|
||||
Whether to CC me on comments I write.
|
||||
|`date_format` ||
|
||||
The format to display the date in.
|
||||
Allowed values are `STD`, `US`, `ISO`, `EURO`, `UK`.
|
||||
|`time_format` ||
|
||||
The format to display the time in.
|
||||
Allowed values are `HHMM_12`, `HHMM_24`.
|
||||
|`relative_date_in_change_table` |not set if `false`|
|
||||
Whether to show relative dates in the changes table.
|
||||
|`size_bar_in_change_table` |not set if `false`|
|
||||
Whether to show the change sizes as colored bars in the change table.
|
||||
|`legacycid_in_change_table` |not set if `false`|
|
||||
Whether to show change number in the change table.
|
||||
|`review_category_strategy` ||
|
||||
The strategy used to displayed info in the review category column.
|
||||
Allowed values are `NONE`, `NAME`, `EMAIL`, `USERNAME`, `ABBREV`.
|
||||
|`diff_view` ||
|
||||
The type of diff view to show.
|
||||
Allowed values are `SIDE_BY_SIDE`, `UNIFIED_DIFF`.
|
||||
|=====================================
|
||||
|
||||
[[preferences-input]]
|
||||
=== PreferencesInput
|
||||
The `PreferencesInput` entity contains information for setting the
|
||||
user preferences. Fields which are not set will not be updated.
|
||||
|
||||
[options="header",cols="1,^1,5"]
|
||||
|=====================================
|
||||
|Field Name ||Description
|
||||
|`changes_per_page` |optional|
|
||||
The number of changes to show on each page.
|
||||
Allowed values are `10`, `25`, `50`, `100`.
|
||||
|`show_site_header` |optional|
|
||||
Whether the site header should be shown.
|
||||
|`use_flash_clipboard` |optional|
|
||||
Whether to use the flash clipboard widget.
|
||||
|`download_scheme` |optional|
|
||||
The type of download URL the user prefers to use.
|
||||
|`download_command` |optional|
|
||||
The type of download command the user prefers to use.
|
||||
|`copy_self_on_email` |optional|
|
||||
Whether to CC me on comments I write.
|
||||
|`date_format` |optional|
|
||||
The format to display the date in.
|
||||
Allowed values are `STD`, `US`, `ISO`, `EURO`, `UK`.
|
||||
|`time_format` |optional|
|
||||
The format to display the time in.
|
||||
Allowed values are `HHMM_12`, `HHMM_24`.
|
||||
|`relative_date_in_change_table` |optional|
|
||||
Whether to show relative dates in the changes table.
|
||||
|`size_bar_in_change_table` |optional|
|
||||
Whether to show the change sizes as colored bars in the change table.
|
||||
|`legacycid_in_change_table` |optional|
|
||||
Whether to show change number in the change table.
|
||||
|`review_category_strategy` |optional|
|
||||
The strategy used to displayed info in the review category column.
|
||||
Allowed values are `NONE`, `NAME`, `EMAIL`, `USERNAME`, `ABBREV`.
|
||||
|`diff_view` |optional|
|
||||
The type of diff view to show.
|
||||
Allowed values are `SIDE_BY_SIDE`, `UNIFIED_DIFF`.
|
||||
|=====================================
|
||||
|
||||
[[diff-preferences-info]]
|
||||
=== DiffPreferencesInfo
|
||||
The `DiffPreferencesInfo` entity contains information about the diff
|
||||
@ -1599,6 +1518,87 @@ If empty or not set and `generate` is false or not set, the HTTP
|
||||
password is deleted.
|
||||
|============================
|
||||
|
||||
[[preferences-info]]
|
||||
=== PreferencesInfo
|
||||
The `PreferencesInfo` entity contains information about a user's preferences.
|
||||
|
||||
[options="header",cols="1,^1,5"]
|
||||
|=====================================
|
||||
|Field Name ||Description
|
||||
|`changes_per_page` ||
|
||||
The number of changes to show on each page.
|
||||
Allowed values are `10`, `25`, `50`, `100`.
|
||||
|`show_site_header` |not set if `false`|
|
||||
Whether the site header should be shown.
|
||||
|`use_flash_clipboard` |not set if `false`|
|
||||
Whether to use the flash clipboard widget.
|
||||
|`download_scheme` ||
|
||||
The type of download URL the user prefers to use.
|
||||
|`download_command` ||
|
||||
The type of download command the user prefers to use.
|
||||
|`copy_self_on_email` |not set if `false`|
|
||||
Whether to CC me on comments I write.
|
||||
|`date_format` ||
|
||||
The format to display the date in.
|
||||
Allowed values are `STD`, `US`, `ISO`, `EURO`, `UK`.
|
||||
|`time_format` ||
|
||||
The format to display the time in.
|
||||
Allowed values are `HHMM_12`, `HHMM_24`.
|
||||
|`relative_date_in_change_table` |not set if `false`|
|
||||
Whether to show relative dates in the changes table.
|
||||
|`size_bar_in_change_table` |not set if `false`|
|
||||
Whether to show the change sizes as colored bars in the change table.
|
||||
|`legacycid_in_change_table` |not set if `false`|
|
||||
Whether to show change number in the change table.
|
||||
|`review_category_strategy` ||
|
||||
The strategy used to displayed info in the review category column.
|
||||
Allowed values are `NONE`, `NAME`, `EMAIL`, `USERNAME`, `ABBREV`.
|
||||
|`diff_view` ||
|
||||
The type of diff view to show.
|
||||
Allowed values are `SIDE_BY_SIDE`, `UNIFIED_DIFF`.
|
||||
|=====================================
|
||||
|
||||
[[preferences-input]]
|
||||
=== PreferencesInput
|
||||
The `PreferencesInput` entity contains information for setting the
|
||||
user preferences. Fields which are not set will not be updated.
|
||||
|
||||
[options="header",cols="1,^1,5"]
|
||||
|=====================================
|
||||
|Field Name ||Description
|
||||
|`changes_per_page` |optional|
|
||||
The number of changes to show on each page.
|
||||
Allowed values are `10`, `25`, `50`, `100`.
|
||||
|`show_site_header` |optional|
|
||||
Whether the site header should be shown.
|
||||
|`use_flash_clipboard` |optional|
|
||||
Whether to use the flash clipboard widget.
|
||||
|`download_scheme` |optional|
|
||||
The type of download URL the user prefers to use.
|
||||
|`download_command` |optional|
|
||||
The type of download command the user prefers to use.
|
||||
|`copy_self_on_email` |optional|
|
||||
Whether to CC me on comments I write.
|
||||
|`date_format` |optional|
|
||||
The format to display the date in.
|
||||
Allowed values are `STD`, `US`, `ISO`, `EURO`, `UK`.
|
||||
|`time_format` |optional|
|
||||
The format to display the time in.
|
||||
Allowed values are `HHMM_12`, `HHMM_24`.
|
||||
|`relative_date_in_change_table` |optional|
|
||||
Whether to show relative dates in the changes table.
|
||||
|`size_bar_in_change_table` |optional|
|
||||
Whether to show the change sizes as colored bars in the change table.
|
||||
|`legacycid_in_change_table` |optional|
|
||||
Whether to show change number in the change table.
|
||||
|`review_category_strategy` |optional|
|
||||
The strategy used to displayed info in the review category column.
|
||||
Allowed values are `NONE`, `NAME`, `EMAIL`, `USERNAME`, `ABBREV`.
|
||||
|`diff_view` |optional|
|
||||
The type of diff view to show.
|
||||
Allowed values are `SIDE_BY_SIDE`, `UNIFIED_DIFF`.
|
||||
|=====================================
|
||||
|
||||
[[query-limit-info]]
|
||||
=== QueryLimitInfo
|
||||
The `QueryLimitInfo` entity contains information about the
|
||||
|
||||
@ -3208,16 +3208,29 @@ permitted to vote on that label.
|
||||
The time and date describing when the approval was made.
|
||||
|===========================
|
||||
|
||||
[[group-base-info]]
|
||||
=== GroupBaseInfo
|
||||
The `GroupBaseInfo` entity contains base information about the group.
|
||||
[[change-edit-input]]
|
||||
=== ChangeEditInput
|
||||
The `ChangeEditInput` entity contains information for restoring a
|
||||
path within change edit.
|
||||
|
||||
[options="header",cols="1,6"]
|
||||
|==========================
|
||||
|Field Name |Description
|
||||
|`id` |The id of the group.
|
||||
|`name` |The name of the group.
|
||||
|==========================
|
||||
[options="header",cols="1,^1,5"]
|
||||
|===========================
|
||||
|Field Name ||Description
|
||||
|`restore_path`|optional|Path to file to restore.
|
||||
|`old_path` |optional|Old path to file to rename.
|
||||
|`new_path` |optional|New path to file to rename.
|
||||
|===========================
|
||||
|
||||
[[change-edit-message-input]]
|
||||
=== ChangeEditMessageInput
|
||||
The `ChangeEditMessageInput` entity contains information for changing
|
||||
the commit message within a change edit.
|
||||
|
||||
[options="header",cols="1,^1,5"]
|
||||
|===========================
|
||||
|Field Name ||Description
|
||||
|`message` ||New commit message.
|
||||
|===========================
|
||||
|
||||
[[change-info]]
|
||||
=== ChangeInfo
|
||||
@ -3305,38 +3318,6 @@ A link:#change-id[\{change-id\}] that identifies the base change for a create
|
||||
change operation. Only used for the link:#create-change[CreateChange] endpoint.
|
||||
|==================================
|
||||
|
||||
[[related-changes-info]]
|
||||
=== RelatedChangesInfo
|
||||
The `RelatedChangesInfo` entity contains information about related
|
||||
changes.
|
||||
|
||||
[options="header",cols="1,6"]
|
||||
|===========================
|
||||
|Field Name |Description
|
||||
|`changes` |A list of
|
||||
link:#related-change-and-commit-info[RelatedChangeAndCommitInfo] entities
|
||||
describing the related changes. Sorted by git commit order, newest to
|
||||
oldest. Empty if there are no related changes.
|
||||
|===========================
|
||||
|
||||
[[related-change-and-commit-info]]
|
||||
=== RelatedChangeAndCommitInfo
|
||||
|
||||
The `RelatedChangeAndCommitInfo` entity contains information about
|
||||
a related change and commit.
|
||||
|
||||
[options="header",cols="1,^1,5"]
|
||||
|===========================
|
||||
|Field Name ||Description
|
||||
|`change_id` |optional|The Change-Id of the change.
|
||||
|`status` |optional|The status of the change.
|
||||
|`commit` ||The commit as a
|
||||
link:#commit-info[CommitInfo] entity.
|
||||
|`_change_number` |optional|The change number.
|
||||
|`_revision_number` |optional|The revision number.
|
||||
|`_current_revision_number`|optional|The current revision number.
|
||||
|===========================
|
||||
|
||||
[[change-message-info]]
|
||||
=== ChangeMessageInfo
|
||||
The `ChangeMessageInfo` entity contains information about a message
|
||||
@ -3577,6 +3558,25 @@ Whether the web link should be shown on the side-by-side diff screen.
|
||||
Whether the web link should be shown on the unified diff screen.
|
||||
|=======================
|
||||
|
||||
[[edit-info]]
|
||||
=== EditInfo
|
||||
The `EditInfo` entity contains information about a change edit.
|
||||
|
||||
[options="header",cols="1,^1,5"]
|
||||
|===========================
|
||||
|Field Name ||Description
|
||||
|`commit` ||The commit of change edit as
|
||||
link:#commit-info[CommitInfo] entity.
|
||||
|`baseRevision`||The revision of the patch set change edit is based on.
|
||||
|`fetch` ||
|
||||
Information about how to fetch this patch set. The fetch information is
|
||||
provided as a map that maps the protocol name ("`git`", "`http`",
|
||||
"`ssh`") to link:#fetch-info[FetchInfo] entities.
|
||||
|`files` |optional|
|
||||
The files of the change edit as a map that maps the file names to
|
||||
link:#file-info[FileInfo] entities.
|
||||
|===========================
|
||||
|
||||
[[fetch-info]]
|
||||
=== FetchInfo
|
||||
The `FetchInfo` entity contains information about how to fetch a patch
|
||||
@ -3632,6 +3632,31 @@ this identity was constructed.
|
||||
constructed.
|
||||
|==========================
|
||||
|
||||
[[group-base-info]]
|
||||
=== GroupBaseInfo
|
||||
The `GroupBaseInfo` entity contains base information about the group.
|
||||
|
||||
[options="header",cols="1,6"]
|
||||
|==========================
|
||||
|Field Name |Description
|
||||
|`id` |The id of the group.
|
||||
|`name` |The name of the group.
|
||||
|==========================
|
||||
|
||||
[[included-in-info]]
|
||||
=== IncludedInInfo
|
||||
The `IncludedInInfo` entity contains information about the branches a
|
||||
change was merged into and tags it was tagged with.
|
||||
|
||||
[options="header",cols="1,6"]
|
||||
|==========================
|
||||
|Field Name |Description
|
||||
|`branches` | The list of branches this change was merged into.
|
||||
Each branch is listed without the 'refs/head/' prefix.
|
||||
|`tags` | The list of tags this change was tagged with.
|
||||
Each tag is listed without the 'refs/tags/' prefix.
|
||||
|==========================
|
||||
|
||||
[[label-info]]
|
||||
=== LabelInfo
|
||||
The `LabelInfo` entity contains information about a label on a change, always
|
||||
@ -3708,6 +3733,57 @@ Submit type used for this change, can be `MERGE_IF_NECESSARY`,
|
||||
A list of other branch names where this change could merge cleanly
|
||||
|============================
|
||||
|
||||
[[problem-info]]
|
||||
=== ProblemInfo
|
||||
The `ProblemInfo` entity contains a description of a potential consistency problem
|
||||
with a change. These are not related to the code review process, but rather
|
||||
indicate some inconsistency in Gerrit's database or repository metadata related
|
||||
to the enclosing change.
|
||||
|
||||
[options="header",cols="1,^1,5"]
|
||||
|===========================
|
||||
|Field Name||Description
|
||||
|`message` ||Plaintext message describing the problem with the change.
|
||||
|`status` |optional|
|
||||
The status of fixing the problem (`FIXED`, `FIX_FAILED`). Only set if a
|
||||
fix was attempted.
|
||||
|`outcome` |optional|
|
||||
If `status` is set, an additional plaintext message describing the
|
||||
outcome of the fix.
|
||||
|===========================
|
||||
|
||||
[[related-change-and-commit-info]]
|
||||
=== RelatedChangeAndCommitInfo
|
||||
|
||||
The `RelatedChangeAndCommitInfo` entity contains information about
|
||||
a related change and commit.
|
||||
|
||||
[options="header",cols="1,^1,5"]
|
||||
|===========================
|
||||
|Field Name ||Description
|
||||
|`change_id` |optional|The Change-Id of the change.
|
||||
|`status` |optional|The status of the change.
|
||||
|`commit` ||The commit as a
|
||||
link:#commit-info[CommitInfo] entity.
|
||||
|`_change_number` |optional|The change number.
|
||||
|`_revision_number` |optional|The revision number.
|
||||
|`_current_revision_number`|optional|The current revision number.
|
||||
|===========================
|
||||
|
||||
[[related-changes-info]]
|
||||
=== RelatedChangesInfo
|
||||
The `RelatedChangesInfo` entity contains information about related
|
||||
changes.
|
||||
|
||||
[options="header",cols="1,6"]
|
||||
|===========================
|
||||
|Field Name |Description
|
||||
|`changes` |A list of
|
||||
link:#related-change-and-commit-info[RelatedChangeAndCommitInfo] entities
|
||||
describing the related changes. Sorted by git commit order, newest to
|
||||
oldest. Empty if there are no related changes.
|
||||
|===========================
|
||||
|
||||
[[restore-input]]
|
||||
=== RestoreInput
|
||||
The `RestoreInput` entity contains information for restoring a change.
|
||||
@ -3879,16 +3955,6 @@ If `SKIP` the parent filters are not called, allowing the test
|
||||
to return results from the input rule.
|
||||
|===========================
|
||||
|
||||
[[suggested-reviewer-info]]
|
||||
=== SuggestedReviewerInfo
|
||||
The `SuggestedReviewerInfo` entity contains information about a reviewer
|
||||
that can be added to a change (an account or a group).
|
||||
|
||||
`SuggestedReviewerInfo` has either the `account` field that contains
|
||||
the link:rest-api-accounts.html#account-info[AccountInfo] entity, or
|
||||
the `group` field that contains the
|
||||
link:rest-api-changes.html#group-base-info[GroupBaseInfo] entity.
|
||||
|
||||
[[submit-info]]
|
||||
=== SubmitInfo
|
||||
The `SubmitInfo` entity contains information about the change status
|
||||
@ -3963,6 +4029,16 @@ When status is RULE_ERROR this message provides some text describing
|
||||
the failure of the rule predicate.
|
||||
|===========================
|
||||
|
||||
[[suggested-reviewer-info]]
|
||||
=== SuggestedReviewerInfo
|
||||
The `SuggestedReviewerInfo` entity contains information about a reviewer
|
||||
that can be added to a change (an account or a group).
|
||||
|
||||
`SuggestedReviewerInfo` has either the `account` field that contains
|
||||
the link:rest-api-accounts.html#account-info[AccountInfo] entity, or
|
||||
the `group` field that contains the
|
||||
link:rest-api-changes.html#group-base-info[GroupBaseInfo] entity.
|
||||
|
||||
[[topic-input]]
|
||||
=== TopicInput
|
||||
The `TopicInput` entity contains information for setting a topic.
|
||||
@ -3974,20 +4050,6 @@ The `TopicInput` entity contains information for setting a topic.
|
||||
The topic will be deleted if not set.
|
||||
|===========================
|
||||
|
||||
[[included-in-info]]
|
||||
=== IncludedInInfo
|
||||
The `IncludedInInfo` entity contains information about the branches a
|
||||
change was merged into and tags it was tagged with.
|
||||
|
||||
[options="header",cols="1,6"]
|
||||
|==========================
|
||||
|Field Name |Description
|
||||
|`branches` | The list of branches this change was merged into.
|
||||
Each branch is listed without the 'refs/head/' prefix.
|
||||
|`tags` | The list of tags this change was tagged with.
|
||||
Each tag is listed without the 'refs/tags/' prefix.
|
||||
|==========================
|
||||
|
||||
[[web-link-info]]
|
||||
=== WebLinkInfo
|
||||
The `WebLinkInfo` entity describes a link to an external site.
|
||||
@ -4000,68 +4062,6 @@ The `WebLinkInfo` entity describes a link to an external site.
|
||||
|`image_url`|URL to the icon of the link.
|
||||
|======================
|
||||
|
||||
[[edit-info]]
|
||||
=== EditInfo
|
||||
The `EditInfo` entity contains information about a change edit.
|
||||
|
||||
[options="header",cols="1,^1,5"]
|
||||
|===========================
|
||||
|Field Name ||Description
|
||||
|`commit` ||The commit of change edit as
|
||||
link:#commit-info[CommitInfo] entity.
|
||||
|`baseRevision`||The revision of the patch set change edit is based on.
|
||||
|`fetch` ||
|
||||
Information about how to fetch this patch set. The fetch information is
|
||||
provided as a map that maps the protocol name ("`git`", "`http`",
|
||||
"`ssh`") to link:#fetch-info[FetchInfo] entities.
|
||||
|`files` |optional|
|
||||
The files of the change edit as a map that maps the file names to
|
||||
link:#file-info[FileInfo] entities.
|
||||
|===========================
|
||||
|
||||
[[change-edit-input]]
|
||||
=== ChangeEditInput
|
||||
The `ChangeEditInput` entity contains information for restoring a
|
||||
path within change edit.
|
||||
|
||||
[options="header",cols="1,^1,5"]
|
||||
|===========================
|
||||
|Field Name ||Description
|
||||
|`restore_path`|optional|Path to file to restore.
|
||||
|`old_path` |optional|Old path to file to rename.
|
||||
|`new_path` |optional|New path to file to rename.
|
||||
|===========================
|
||||
|
||||
[[change-edit-message-input]]
|
||||
=== ChangeEditMessageInput
|
||||
The `ChangeEditMessageInput` entity contains information for changing
|
||||
the commit message within a change edit.
|
||||
|
||||
[options="header",cols="1,^1,5"]
|
||||
|===========================
|
||||
|Field Name ||Description
|
||||
|`message` ||New commit message.
|
||||
|===========================
|
||||
|
||||
[[problem-info]]
|
||||
=== ProblemInfo
|
||||
The `ProblemInfo` entity contains a description of a potential consistency problem
|
||||
with a change. These are not related to the code review process, but rather
|
||||
indicate some inconsistency in Gerrit's database or repository metadata related
|
||||
to the enclosing change.
|
||||
|
||||
[options="header",cols="1,^1,5"]
|
||||
|===========================
|
||||
|Field Name||Description
|
||||
|`message` ||Plaintext message describing the problem with the change.
|
||||
|`status` |optional|
|
||||
The status of fixing the problem (`FIXED`, `FIX_FAILED`). Only set if a
|
||||
fix was attempted.
|
||||
|`outcome` |optional|
|
||||
If `status` is set, an additional plaintext message describing the
|
||||
outcome of the fix.
|
||||
|===========================
|
||||
|
||||
GERRIT
|
||||
------
|
||||
Part of link:index.html[Gerrit Code Review]
|
||||
|
||||
@ -847,17 +847,6 @@ Information about the hit ratio as a link:#hit-ration-info[
|
||||
HitRatioInfo] entity.
|
||||
|==================================
|
||||
|
||||
[[capability-info]]
|
||||
=== CapabilityInfo
|
||||
The `CapabilityInfo` entity contains information about a capability.
|
||||
|
||||
[options="header",cols="1,6"]
|
||||
|=================================
|
||||
|Field Name |Description
|
||||
|`id` |capability ID
|
||||
|`name` |capability name
|
||||
|=================================
|
||||
|
||||
[[cache-operation-input]]
|
||||
=== CacheOperationInput
|
||||
The `CacheOperationInput` entity contains information about an
|
||||
@ -878,6 +867,17 @@ specified operation should be executed. Whether this list must be
|
||||
specified depends on the operation being executed.
|
||||
|==================================
|
||||
|
||||
[[capability-info]]
|
||||
=== CapabilityInfo
|
||||
The `CapabilityInfo` entity contains information about a capability.
|
||||
|
||||
[options="header",cols="1,6"]
|
||||
|=================================
|
||||
|Field Name |Description
|
||||
|`id` |capability ID
|
||||
|`name` |capability name
|
||||
|=================================
|
||||
|
||||
[[entries-info]]
|
||||
=== EntriesInfo
|
||||
The `EntriesInfo` entity contains information about the entries in a
|
||||
|
||||
@ -1166,21 +1166,6 @@ name. +
|
||||
If not set, the new group will be self-owned.
|
||||
|===========================
|
||||
|
||||
[[groups-input]]
|
||||
=== GroupsInput
|
||||
The `GroupsInput` entity contains information about groups that should
|
||||
be included into a group or that should be deleted from a group.
|
||||
|
||||
[options="header",cols="1,^1,5"]
|
||||
|==========================
|
||||
|Field Name ||Description
|
||||
|`_one_group` |optional|
|
||||
The link:#group-id[id] of one group that should be included or deleted.
|
||||
|`groups` |optional|
|
||||
A list of link:#group-id[group ids] that identify the groups that
|
||||
should be included or deleted.
|
||||
|==========================
|
||||
|
||||
[[group-options-info]]
|
||||
=== GroupOptionsInfo
|
||||
Options of the group.
|
||||
@ -1203,6 +1188,21 @@ New options for a group.
|
||||
Whether the group is visible to all registered users.
|
||||
|=============================
|
||||
|
||||
[[groups-input]]
|
||||
=== GroupsInput
|
||||
The `GroupsInput` entity contains information about groups that should
|
||||
be included into a group or that should be deleted from a group.
|
||||
|
||||
[options="header",cols="1,^1,5"]
|
||||
|==========================
|
||||
|Field Name ||Description
|
||||
|`_one_group` |optional|
|
||||
The link:#group-id[id] of one group that should be included or deleted.
|
||||
|`groups` |optional|
|
||||
A list of link:#group-id[group ids] that identify the groups that
|
||||
should be included or deleted.
|
||||
|==========================
|
||||
|
||||
[[members-input]]
|
||||
MembersInput
|
||||
~~~~~~~~~~~
|
||||
|
||||
@ -1779,22 +1779,6 @@ The name of the project.
|
||||
[[json-entities]]
|
||||
== JSON Entities
|
||||
|
||||
[[branch-info]]
|
||||
=== BranchInfo
|
||||
The `BranchInfo` entity contains information about a branch.
|
||||
|
||||
[options="header",cols="1,^2,4"]
|
||||
|=========================
|
||||
|Field Name ||Description
|
||||
|`ref` ||The ref of the branch.
|
||||
|`revision` ||The revision to which the branch points.
|
||||
|`can_delete`|`false` if not set|
|
||||
Whether the calling user can delete this branch.
|
||||
|`web_links` |optional|
|
||||
Links to the branch in external sites as a list of
|
||||
link:rest-api-changes.html#web-link-info[WebLinkInfo] entries.
|
||||
|=========================
|
||||
|
||||
[[ban-input]]
|
||||
=== BanInput
|
||||
The `BanInput` entity contains information for banning commits in a
|
||||
@ -1819,6 +1803,22 @@ The `BanResultInfo` entity describes the result of banning commits.
|
||||
|`ignored` |optional|List of object IDs that were ignored.
|
||||
|=============================
|
||||
|
||||
[[branch-info]]
|
||||
=== BranchInfo
|
||||
The `BranchInfo` entity contains information about a branch.
|
||||
|
||||
[options="header",cols="1,^2,4"]
|
||||
|=========================
|
||||
|Field Name ||Description
|
||||
|`ref` ||The ref of the branch.
|
||||
|`revision` ||The revision to which the branch points.
|
||||
|`can_delete`|`false` if not set|
|
||||
Whether the calling user can delete this branch.
|
||||
|`web_links` |optional|
|
||||
Links to the branch in external sites as a list of
|
||||
link:rest-api-changes.html#web-link-info[WebLinkInfo] entries.
|
||||
|=========================
|
||||
|
||||
[[branch-input]]
|
||||
=== BranchInput
|
||||
The `BranchInput` entity contains information for the creation of
|
||||
|
||||
Loading…
Reference in New Issue
Block a user