switch json fields to camelCase
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone/pr Build is passing

This commit is contained in:
Alex 2022-04-11 18:06:34 +02:00
parent 834e564efa
commit a455f48ef4
Signed by: lx
GPG key ID: 0E496D15096376BE

View file

@ -361,7 +361,7 @@ HTTP/1.1 200 OK
start: null, start: null,
end: null, end: null,
limit: null, limit: null,
partition_keys: [ partitionKeys: [
{ pk: "keys", n: 3043 }, { pk: "keys", n: 3043 },
{ pk: "mailbox:INBOX", n: 42 }, { pk: "mailbox:INBOX", n: 42 },
{ pk: "mailbox:Junk", n: 2991 }, { pk: "mailbox:Junk", n: 2991 },
@ -421,24 +421,24 @@ HTTP/1.1 200 OK
Batch read of triplets in a bucket. Batch read of triplets in a bucket.
The request body is a JSON list of searches, that each specify a range of The request body is a JSON list of searches, that each specify a range of
items to get (to get single items, set `single_item` to `true`). A search is a items to get (to get single items, set `singleItem` to `true`). A search is a
JSON struct with the following fields: JSON struct with the following fields:
| name | default value | meaning | | name | default value | meaning |
| - | - | - | | - | - | - |
| `partition_key` | **mandatory** | The partition key in which to search | | `partitionKey` | **mandatory** | The partition key in which to search |
| `start` | `null` | The sort key of the first item to read | | `start` | `null` | The sort key of the first item to read |
| `end` | `null` | The sort key of the last item to read (excluded) | | `end` | `null` | The sort key of the last item to read (excluded) |
| `limit` | `null` | The maximum number of items to return | | `limit` | `null` | The maximum number of items to return |
| `single_item` | `false` | Whether to return only the item with sort key `start` | | `singleItem` | `false` | Whether to return only the item with sort key `start` |
| `conflicts_only` | `false` | Whether to return only items that have several concurrent values | | `conflictsOnly` | `false` | Whether to return only items that have several concurrent values |
| `tombstones` | `false` | Whether or not to return tombstone lines to indicate the presence of old deleted items | | `tombstones` | `false` | Whether or not to return tombstone lines to indicate the presence of old deleted items |
For each of the searches, triplets are listed and returned separately. The For each of the searches, triplets are listed and returned separately. The
semantics of `start`, `end` and `limit` is the same as for ReadIndex. The semantics of `start`, `end` and `limit` is the same as for ReadIndex. The
additionnal parameter `single_item` allows to get a single item, whose sort key additionnal parameter `singleItem` allows to get a single item, whose sort key
is the one given in `start`. Parameters `conflicts_only` and `tombstones` is the one given in `start`. Parameters `conflictsOnly` and `tombstones`
control additional filters on the items that are returned. control additional filters on the items that are returned.
The result is a list of length the number of searches, that consists in for The result is a list of length the number of searches, that consists in for
@ -471,17 +471,17 @@ POST /my_bucket?search HTTP/1.1
[ [
{ {
partition_key: "mailboxes", partitionKey: "mailboxes",
}, },
{ {
partition_key: "mailbox:INBOX", partitionKey: "mailbox:INBOX",
start: "001892831", start: "001892831",
limit: 3, limit: 3,
}, },
{ {
partition_key: "keys", partitionKey: "keys",
start: "0", start: "0",
single_item: true, singleItem: true,
}, },
] ]
``` ```
@ -493,13 +493,13 @@ HTTP/1.1 200 OK
[ [
{ {
partition_key: "mailboxes", partitionKey: "mailboxes",
start: null, start: null,
end: null, end: null,
limit: null, limit: null,
conflicts_only: false, conflictsOnly: false,
tombstones: false, tombstones: false,
single_item: false, singleItem: false,
items: [ items: [
{ sk: "INBOX", ct: "opaquetoken123", v: ["b64cryptoblob123", "b64cryptoblob'123"] }, { sk: "INBOX", ct: "opaquetoken123", v: ["b64cryptoblob123", "b64cryptoblob'123"] },
{ sk: "Trash", ct: "opaquetoken456", v: ["b64cryptoblob456"] }, { sk: "Trash", ct: "opaquetoken456", v: ["b64cryptoblob456"] },
@ -509,13 +509,13 @@ HTTP/1.1 200 OK
nextStart: null, nextStart: null,
}, },
{ {
partition_key: "mailbox::INBOX", partitionKey: "mailbox::INBOX",
start: "001892831", start: "001892831",
end: null, end: null,
limit: 3, limit: 3,
conflicts_only: false, conflictsOnly: false,
tombstones: false, tombstones: false,
single_item: false, singleItem: false,
items: [ items: [
{ sk: "001892831", ct: "opaquetoken321", v: ["b64cryptoblob321"] }, { sk: "001892831", ct: "opaquetoken321", v: ["b64cryptoblob321"] },
{ sk: "001892832", ct: "opaquetoken654", v: ["b64cryptoblob654"] }, { sk: "001892832", ct: "opaquetoken654", v: ["b64cryptoblob654"] },
@ -525,13 +525,13 @@ HTTP/1.1 200 OK
nextStart: "001892898", nextStart: "001892898",
}, },
{ {
partition_key: "keys", partitionKey: "keys",
start: "0", start: "0",
end: null, end: null,
conflicts_only: false, conflictsOnly: false,
tombstones: false, tombstones: false,
limit: null, limit: null,
single_item: true, singleItem: true,
items: [ items: [
{ sk: "0", ct: "opaquetoken999", v: ["b64binarystuff999"] }, { sk: "0", ct: "opaquetoken999", v: ["b64binarystuff999"] },
], ],
@ -547,8 +547,8 @@ HTTP/1.1 200 OK
Batch deletion of triplets. The request format is the same for `POST Batch deletion of triplets. The request format is the same for `POST
/<bucket>?search` to indicate items or range of items, except that here they /<bucket>?search` to indicate items or range of items, except that here they
are deleted instead of returned, but only the fields `partition_key`, `start`, are deleted instead of returned, but only the fields `partitionKey`, `start`,
`end`, and `single_item` are supported. Causality information is not given by `end`, and `singleItem` are supported. Causality information is not given by
the user: this request will internally list all triplets and write deletion the user: this request will internally list all triplets and write deletion
markers that supersede all of the versions that have been read. markers that supersede all of the versions that have been read.
@ -562,12 +562,12 @@ POST /my_bucket?delete HTTP/1.1
[ [
{ {
partition_key: "mailbox:OldMailbox", partitionKey: "mailbox:OldMailbox",
}, },
{ {
partition_key: "mailbox:INBOX", partitionKey: "mailbox:INBOX",
start: "0018928321", start: "0018928321",
single_item: true, singleItem: true,
}, },
] ]
``` ```
@ -579,18 +579,18 @@ HTTP/1.1 200 OK
[ [
{ {
partition_key: "mailbox:OldMailbox", partitionKey: "mailbox:OldMailbox",
start: null, start: null,
end: null, end: null,
single_item: false, singleItem: false,
deleted_items: 35, deletedItems: 35,
}, },
{ {
partition_key: "mailbox:INBOX", partitionKey: "mailbox:INBOX",
start: "0018928321", start: "0018928321",
end: null, end: null,
single_item: true, singleItem: true,
deleted_items: 1, deletedItems: 1,
}, },
] ]
``` ```