Add Group Description #8448
Add Group Description #8448
Conversation
itaigilo
added
area/API
|
🎊 PR Preview f7b9e69 has been successfully built and deployed to https://treeverse-lakeFS-preview-pr-8448.surge.sh 🕐 Build time: 0.01s
🤖 By surge-preview |
E2E Test Results - DynamoDB Local - Local Block Adapter |
E2E Test Results - Quickstart |
itaigilo
added
exclude-changelog
| @@ -171,6 +175,9 @@ const GroupsContainer = () => { | |||
| placeholder="Group Name (e.g. 'DataTeam')" | |||
| actionName={"Create"} | |||
| validationFunction={disallowPercentSign(INVALID_GROUP_NAME_ERROR_MESSAGE)} | |||
| showExtraField={true} | |||
| extraPlaceholder="Group Description (optional)" | |||
| extraValidationFunction={disallowPercentSign(INVALID_GROUP_DESCRIPTION_ERROR_MESSAGE)} | |||
There was a problem hiding this comment.
Please only add such protections if there is an actual broken case. I always prefer to employ correct quotation mechanisms rather than to attempt to prevent all "bad" cases.
I would expect URI component encoding or whatever to protect percent signs. If things break when descriptions have percent signs, then I expect them also to break in many other cases, such as descriptions with plus signs.
| async getGroup(groupId) { | ||
| const response = await apiRequest(`/auth/groups/${encodeURIComponent(groupId)}`); | ||
| if (response.status !== 200) { | ||
| throw new Error(`could not get groups: ${await extractError(response)}`); | ||
| } | ||
| return response.json(); | ||
| } |
There was a problem hiding this comment.
Why do we need get group, can't we use the information from listing?
There was a problem hiding this comment.
No -
This page is rendered from the auth/groups/{group-id}/ URL,
So it's rendered without calling the list API.
| @@ -959,6 +961,7 @@ func (c *Controller) GetGroup(w http.ResponseWriter, r *http.Request, groupID st | |||
|
|
|||
| response := apigen.Group{ | |||
| Id: g.DisplayName, | |||
| Description: g.Description, | |||
There was a problem hiding this comment.
It wasn't a requirement -
But added now.
Change Description
Background
To make Auth Group more usable, adding a
descriptionfield to (Auth)Groupentities, so there will be easier to distinguish.New Feature
Add the
descriptionfield to theGroupentity,And support it in Group creation and Group fetching.
Testing Details
Tested locally,
Added unit-tests.