Skip to content

docs: document trashedBy/trashedAt in cozyMetadata and org_drive flag in sharings #287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
shepilov wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: document trashedBy/trashedAt in cozyMetadata and org_drive flag in sharings #287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/io.cozy.files.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,11 @@ The `io.cozy.files` doctype has [the standard `cozyMetadata`](https://docs.cozy.
- `slug`: {string} the slug of the application that has made the upload
- `version`: {string} the version number of this application
- `oauthClient`: {object} if the upload was made by an OAuth Client, information about it (`id`, `name`, and `kind`)
- `trashedAt`: {date} the server date/time when the file or folder was moved to the trash
- `trashedBy`: {object} information on who trashed the file or folder (only present when the file is in the trash)
- `kind`: {string} either `member` (a sharing member) or `anonymous-share`
- `displayName`: {string} the display name of the member who trashed the file (only when `kind` is `member`)
- `domain`: {string} the domain of the member's Cozy instance (only when `kind` is `member`)

### Example (JSON-API format)

Expand Down
1 change: 1 addition & 0 deletions docs/io.cozy.sharings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ documents and files from her cozy instance to other people.
- a flag `open_sharing`:
- `true` if any member of the sharing can add a new recipient
- `false` if only the owner can add a new recipient
- a flag `org_drive`: present and `true` when the shared drive was created from an organization instance (i.e. the instance's canonical slug matches its `OrgID`)
- Some technical data (`created_at`, `updated_at`, `app_slug`, `preview_path`,
`triggers`, `credentials`)
- A flag `initial_sync` present only when the initial replication is still running
Expand Down