📝 Small documentation of entities fixes (#433)
This commit is contained in:
committed by
ericlinagora
parent
b9fb180589
commit
7113173456
@@ -6,11 +6,10 @@ import search from "./drive-file.search";
|
||||
|
||||
export const TYPE = "drive_files";
|
||||
export type DriveScope = "personal" | "shared";
|
||||
|
||||
/**
|
||||
* This represents an item in the file hierarchy.
|
||||
*
|
||||
* DriveFile s do not have a notion of owner, only a creator. The `creator_id`
|
||||
* DriveFile s do not have a notion of owner, only a creator. The `creator`
|
||||
* is used to locate the root files. The `parent_id` fields then form the
|
||||
* hierarchy.
|
||||
*
|
||||
@@ -21,15 +20,15 @@ export type DriveScope = "personal" | "shared";
|
||||
*
|
||||
* The `parent_id` can point to the `id` of another `DriveFile`, or one
|
||||
* of the named entries:
|
||||
* - `"user_$userid"`: Root of the personal "My Drive" folder of the user in the string.
|
||||
* - `"user_$userid"`: Root of the personal "My Drive" (and Trash) folder of the user in the string.
|
||||
* Usually this is assumed to be the creator, there is no official way
|
||||
* of extracting the user id from the `parent_id`.
|
||||
* - `"trash_$userid"`: Trash folder for a given user (same note as `"user_$userid"`)
|
||||
* - `"root"`: Root of the creator's company "Shared Drive" feature
|
||||
* - The following virtual values never appear in the stored `parent_id` field but are used
|
||||
* in queries and URLs etc:
|
||||
* - `"trash"`: used to query items at the root of the creator with `is_in_trash == true`,
|
||||
* if `scope == "personal"`, otherwise the trash of the shared drive
|
||||
* - `"trash_$userid"`: Trash folder for a given user (same note as `"user_$userid"`)
|
||||
* - `"shared_with_me"`: for the feature of the same name
|
||||
*/
|
||||
@Entity(TYPE, {
|
||||
|
||||
@@ -12,6 +12,7 @@ export const TYPE = "group_user";
|
||||
type: TYPE,
|
||||
})
|
||||
export default class CompanyUser {
|
||||
/** company_id */
|
||||
@Column("group_id", "timeuuid")
|
||||
group_id: string;
|
||||
|
||||
|
||||
Reference in New Issue
Block a user