diff options
| author | Simon Rettberg | 2024-04-11 16:14:59 +0200 |
|---|---|---|
| committer | Simon Rettberg | 2024-04-11 16:14:59 +0200 |
| commit | dc4da9869594bbf0573fcaac31488eb51a9f9e6a (patch) | |
| tree | fa60afd7ac6c8e542cbca059ea7326dd109fd718 /src/fuse/cowDoc/readme.md | |
| parent | [FUSE] Rename COW API endpoints again (diff) | |
| download | dnbd3-dc4da9869594bbf0573fcaac31488eb51a9f9e6a.tar.gz dnbd3-dc4da9869594bbf0573fcaac31488eb51a9f9e6a.tar.xz dnbd3-dc4da9869594bbf0573fcaac31488eb51a9f9e6a.zip | |
[FUSE] More cleanup and minor fixes
- Add support for aborting session and further uploads via SIGQUIT
- Make API versioned
- Change it to "uuid" everywhere instead of a mix of uuid and guid
- Server can now tell us to wait with further uploads
- merge request is now urlencoded POST instead of mime data
Diffstat (limited to 'src/fuse/cowDoc/readme.md')
| -rw-r--r-- | src/fuse/cowDoc/readme.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/src/fuse/cowDoc/readme.md b/src/fuse/cowDoc/readme.md index fd3557c..46b753e 100644 --- a/src/fuse/cowDoc/readme.md +++ b/src/fuse/cowDoc/readme.md @@ -222,7 +222,7 @@ The following configuration variables have been added to `config/cow.h`. // +++++ COW API Endpoints +++++ #define COW_API_PREFIX "%s/v1/" #define COW_API_CREATE COW_API_PREFIX "file/create" -#define COW_API_UPDATE COW_API_PREFIX "file/update?guid=%s&clusterindex=%lu" +#define COW_API_UPDATE COW_API_PREFIX "file/update?uuid=%s&clusterindex=%lu" #define COW_API_START_MERGE COW_API_PREFIX "file/merge" ``` @@ -251,7 +251,7 @@ The following Rest API is used to transmit the data and commands to the cow serv | ---- | ----------- | | 200 | Success | -This request is used as soon as a new cow session is created. The returned guid is used in all subsequent requests to identify the session. +This request is used as soon as a new cow session is created. The returned uuid is used in all subsequent requests to identify the session. ### v1/file/update @@ -261,7 +261,7 @@ This request is used as soon as a new cow session is created. The returned guid | Name | Located in | Description | Required | Schema | | ---- | ---------- | ----------- | -------- | ---- | -| guid | query | | Yes | string (uuid) | +| uuid | query | | Yes | string (uuid) | | clusterNumber | query | | Yes | integer | ##### Responses @@ -280,7 +280,7 @@ Used to upload a cluster. The cluster number is the absolute cluster number. The | Name | Located in | Description | Required | Schema | | ---- | ---------- | ----------- | -------- | ---- | -| guid | Form | | Yes | string (uuid) | +| uuid | Form | | Yes | string (uuid) | | originalFileSize | Form | | Yes | integer | | newFileSize | Form | | Yes | integer | ##### Responses @@ -299,7 +299,7 @@ Used to start the merge on the server. | Name | Located in | Description | Required | Schema | | ---- | ---------- | ----------- | -------- | ---- | -| guid | query | | Yes | string (uuid) | +| uuid | query | | Yes | string (uuid) | | amount | query | | Yes | integer | ##### Responses @@ -317,7 +317,7 @@ This request returns a list containing the cluster IDs and the number of uploads | Name | Located in | Description | Required | Schema | | ---- | ---------- | ----------- | -------- | ---- | -| guid | query | | Yes | string (uuid) | +| uuid | query | | Yes | string (uuid) | ##### Responses |