diff options
| author | Dan Engelbrecht <[email protected]> | 2024-06-13 21:34:45 +0200 |
|---|---|---|
| committer | Dan Engelbrecht <[email protected]> | 2024-06-13 21:34:45 +0200 |
| commit | b789281f3fd9c1afaa4ff3cf47fdd26da2c73ae5 (patch) | |
| tree | 1db87e85e8645481b48d6bbed42dc5e3528f231b | |
| parent | changelog (diff) | |
| download | zen-b789281f3fd9c1afaa4ff3cf47fdd26da2c73ae5.tar.xz zen-b789281f3fd9c1afaa4ff3cf47fdd26da2c73ae5.zip | |
changelog
| -rw-r--r-- | CHANGELOG.md | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index 35de04da7..9b61ed99c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,17 +3,19 @@ - New http service endpoint `/ws` - `/ws/{workspace_id}` - manage workspaces. {workspace_id} is a Object Id - PUT - add a workspace. Set `{workspace_id}` to `000000000000000000000000` to automatically generate id from `root_path` - - Parameters: `root_path` the root local file path of the workspace. + - Parameter: `root_path` the root local file path of the workspace. - GET - get information about a workspace - DELETE - removes a workspace (does not affect the files on disk). Remove all shares inside the workspace - `/ws/{workspace_id}/{share_id}` - manage folder shares within a workspaces. {share_id} is a Object Id - PUT - add a workspace. Set `{share_id}` to `000000000000000000000000` to automatically generate id from `share_path` - - Parameters: `share_path` the relative local file path to the workspace root path + - Parameter: `share_path` the relative local file path to the workspace root path. + - Parameter: `alias` a names alias for the share to be used with the `/ws/share/{alias}` url - GET - get information about a workspace share - DELETE -removes a workspace share (does not affect the files on disk) - `/ws/{workspace_id}/{share_id}/files` - GET - get the files in the workspace share - - Parameters: `fieldnames` is a parameter to filter which fields to include in the response. Default fields are: `id`, `clientpath` and `serverpath` (translates to `?fieldnames=id,clientpath,serverpath`). `filter=client` only applies if `fieldnames` is not given as a parameter. Use `?fieldnames=*` to get all the fields + - Parameter: `fieldnames` is a parameter to filter which fields to include in the response. Default fields are: `id`, `clientpath` and `serverpath` (translates to `?fieldnames=id,clientpath,serverpath`). Use `?fieldnames=*` to get all the fields. + - Parameter: `filter` only applies if `fieldnames` is not given as a parameter. Use `?filter=client` to exclude the `serverpath` - `/ws/{workspace_id}/{share_id}/entries` - GET - get share as oplog entries - Parameter: `fieldfilter` is a parameter to filter which fields to include in the response. Default fields are: `id`, `clientpath`, `serverpath` (translates to `?fieldnames=id,clientpath,serverpath`). Use `?fieldfilter=*` to get all the fields @@ -27,7 +29,7 @@ - GET - get properties of the chunk. Currently only includes the size of the chunk. - `/ws/{workspace_id}/{share_id}/batch` - POST - do a batch request for multiple chunks in a workspace share - - `/ws/share/{alias}/` - a shortcut to `/ws/{workspace_id}/{share_id}/` based endpoints using the alias for a workspace share + - `/ws/share/{alias}/` - a shortcut to `/ws/{workspace_id}/{share_id}/` based endpoints using the alias for a workspace share. - New `zen workspace {subcommand}` command to manage workspaces - `create` - creates a new workspace - `--root-path` - the root local file path of the workspace |