Influxdata
/
chronograf
mirror of https://github.com/influxdata/chronograf.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

chore(ui): improve docs

pull/5921/head
Pavel Zavora 2022-05-27 12:37:35 +02:00
parent 1136c862d8
commit d4264c55f7
2 changed files with 10 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
ui/src/admin/containers/influxdb/util/computeUsersEffectiveDBPermissions.ts
View File

@ -1,15 +1,11 @@
import {User} from 'src/types/influxAdmin'
/** Array of users, with Arrays of databases containing permission records (or record changes) */
/** Array of users with Arrays of databases containing granted permission records */
type UsersDBPermissions = Array<Array<Record<string, boolean>>>
/**
* Creates effective user permissions as a record
* that contains permission names as keys and `true` values
* for every assigned permission.
*
* @param dbNames
* @param users
* @returns
*/
export default function computeUsersEffectiveDBPermissions(
users: User[],

16
ui/src/admin/containers/influxdb/util/userPermissions.ts
View File

@ -1,13 +1,12 @@
import {User, UserPermission} from 'src/types/influxAdmin'
/** Record with database keys and values being a record of granted permissions or permission changes */
/** Record with databases as keys and values being a record of granted permissions or permission changes */
export type UserDBPermissions = Record<string, Record<string, boolean>>
/**
* Create a record of user's database permissions, organized by every database that
* has some granted permissions.
* ComputeUserPermissions creates a record of user's database permissions.
* @param user infludb user
* @param isEnterprise enteprise InfluxDB flag means that <ALL>-scoped permissions are mapped to an extra `''` database.
* @param isEnterprise enteprise InfluxDB flag means that all-scoped permissions are mapped to an extra '' database.
*/
export function computeUserPermissions(
user: User,
@ -25,8 +24,9 @@ export function computeUserPermissions(
}
/**
* Computes changes in user permissions for a specific db and permission,
* having original permission and a set of changes, return a new set of changes.
* ComputeUserPermissionsChange computes changes in user permissions
* for a specific db and permission, having original user permission
* and a set of already performed changes.
*/
export function computeUserPermissionsChange(
db: string,
@ -61,7 +61,9 @@ export function computeUserPermissionsChange(
}
/**
* Creates server's user permissions out of existing and changed user permissions.
* ToUserPermissions creates server-side's user permissions
* out of existing and changed user permissions, optionally
* appended to supplied user permissions.
*/
export function toUserPermissions(
userPermissions: UserDBPermissions,