Commit dd83ae80 authored by Jonathan Schafer's avatar Jonathan Schafer

Add descriptions for Group Member Relations

parent 0c629940
......@@ -4,6 +4,12 @@ class GroupMembersFinder < UnionFinder
RELATIONS = %i(direct inherited descendants).freeze
DEFAULT_RELATIONS = %i(direct inherited).freeze
RELATIONS_DESCRIPTIONS = {
direct: 'Members in the group itself',
inherited: "Members in the group's ancestor groups",
descendants: "Members in the group's subgroups"
}.freeze
include CreatedAtFilter
# Params can be any of the following:
......
......@@ -6,7 +6,7 @@ module Types
description 'Group member relation'
::GroupMembersFinder::RELATIONS.each do |member_relation|
value member_relation.to_s.upcase, value: member_relation, description: "#{member_relation.to_s.titleize} members"
value member_relation.to_s.upcase, value: member_relation, description: ::GroupMembersFinder::RELATIONS_DESCRIPTIONS[member_relation]
end
end
end
......@@ -13248,9 +13248,9 @@ Group member relation.
| Value | Description |
| ----- | ----------- |
| <a id="groupmemberrelationdescendants"></a>`DESCENDANTS` | Descendants members. |
| <a id="groupmemberrelationdirect"></a>`DIRECT` | Direct members. |
| <a id="groupmemberrelationinherited"></a>`INHERITED` | Inherited members. |
| <a id="groupmemberrelationdescendants"></a>`DESCENDANTS` | Members in the group's subgroups. |
| <a id="groupmemberrelationdirect"></a>`DIRECT` | Members in the group itself. |
| <a id="groupmemberrelationinherited"></a>`INHERITED` | Members in the group's ancestor groups. |
### `HealthStatus`
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment