diff options
| author | Simon Schuster <git@rationality.eu> | 2020-10-06 22:50:11 +0200 |
|---|---|---|
| committer | Florian Pritz <bluewind@xinu.at> | 2020-10-07 14:02:48 +0200 |
| commit | 4bdbb005a9b214d5355d4f2036d510f898bc8a87 (patch) | |
| tree | 46cf3c0643189e28b530aafb5a9a68d1913d6e40 /doc | |
| parent | 60d497ff685a581cf63b4840af372d8613bd3f81 (diff) | |
API: Add `minimum-id-length` post parameter
This parameter controls the generated id for files (file/upload) and
multipastes (file/create_multipaste).
The post parameter has to be a positive integer value >= 2.
Changes by Florian Pritz:
- minor style and typo fixes
- NEWS entry
- check expected error reply content in tests
Signed-off-by: Florian Pritz <bluewind@xinu.at>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api.md | 2 | ||||
| -rw-r--r-- | doc/api/file.md | 47 |
2 files changed, 30 insertions, 19 deletions
diff --git a/doc/api.md b/doc/api.md index 1fe475fa8..30dfc77fb 100644 --- a/doc/api.md +++ b/doc/api.md @@ -147,6 +147,8 @@ These are the most common errors that can be returned by any API call. | Version | Endpoint | Note | | ------- | -------- | ---- | +| NEXT | file/create_multipaste | Add paramter ''minimum-id-length'' to control the length of generated content id | +| NEXT | file/upload | Add parameter ''minimum-id-length'' to control the length of generated content id | | 2.1.1 | file/history | Empty objects (values of `items` and `multipaste_items`) are now always returned as {}. Before they were returned as [] | | 2.1.1 | file/delete | Empty objects (values of `errors` and `deleted`) are now always returned as {}. Before they were returned as [] | | 2.1.0 | file/history | Add ''item.thumbnail'' | diff --git a/doc/api/file.md b/doc/api/file.md index 7d95274a3..ceb9aa27f 100644 --- a/doc/api/file.md +++ b/doc/api/file.md @@ -58,14 +58,16 @@ Required access level: `basic` Upload a new file. -| POST field | Type | Comment | -| ---------- | ---- | ------- | -| file[`<index>`] | File | Required. Arbitrary index. | +| POST field | Type | Comment | +| ---------- | ---- | ------- | +| file[`<index>`] | File | Required. Arbitrary index. | +| minimum-id-length | Int | Optional. Values >= 2 only | -| error_id | Message | Note | -| -------- | ------- | ---- | -| file/no-file | No file was uploaded or unknown error occurred | | -| file/upload-verify | Failed to verify uploaded file(s) | This error provides additional detail | +| error_id | Message | Note | +| -------- | ------- | ---- | +| file/no-file | No file was uploaded or unknown error occurred | | +| file/bad-minimum-id-length | Invalid value passsed to bad-minimum-id-length | | +| file/upload-verify | Failed to verify uploaded file(s) | This error provides additional detail | ```javascript // Success response @@ -101,6 +103,10 @@ Example: } ``` +| Version | Change | +| ------- | ------ | +| NEXT | Add parameter ''minimum-id-length'' to control the length of generated content id | + ## file/history Return the currently available files/multipastes. @@ -253,15 +259,17 @@ Required access level: `basic` Create a new multipaste. -| POST field | Type | Comment | -| ---------- | ---- | ------- | -| ids[`<index>`] | upload-id | Required. Arbitrary index. This only accepts IDs of files, not other multipastes. | +| POST field | Type | Comment | +| ---------- | ---- | ------- | +| ids[`<index>`] | upload-id | Required. Arbitrary index. This only accepts IDs of files, not other multipastes. | +| minimum-id-length | Int | Optional. Values >= 2 only | -| error_id | Message | Note | -| -------- | ------- | ---- | -| file/create_multipaste/no-ids | No IDs specified | | -| file/create_multipaste/duplicate-id | Duplicate IDs are not supported | | -| file/create_multipaste/verify-failed | Failed to verify ID(s) | This error provides additional detail | +| error_id | Message | Note | +| -------- | ------- | ---- | +| file/bad-minimum-id-length | Invalid value passsed to bad-minimum-id-length | | +| file/create_multipaste/no-ids | No IDs specified | | +| file/create_multipaste/duplicate-id | Duplicate IDs are not supported | | +| file/create_multipaste/verify-failed | Failed to verify ID(s) | This error provides additional detail | ```javascript // Success response @@ -292,7 +300,8 @@ Example: } ``` -| Version | Change | -| ------- | ------ | -| 1.1.0 | Add url key to response | -| 1.3.0 | Change required access level from ''apikey'' to ''basic'' | +| Version | Change | +| ------- | ------ | +| 1.1.0 | Add url key to response | +| 1.3.0 | Change required access level from ''apikey'' to ''basic'' | +| NEXT | Add paramter ''minimum-id-length'' to control the length of generated content id | |