diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/openapi.yaml | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/openapi.yaml b/docs/openapi.yaml index b85481c..ba66f08 100644 --- a/docs/openapi.yaml +++ b/docs/openapi.yaml @@ -54,6 +54,7 @@ paths: parameters: - $ref: '#/components/parameters/conflicts' - $ref: '#/components/parameters/heads' + - $ref: '#/components/parameters/shallow' responses: '200': $ref: '#/components/responses/Value' @@ -77,6 +78,7 @@ paths: parameters: - $ref: '#/components/parameters/conflicts' - $ref: '#/components/parameters/heads' + - $ref: '#/components/parameters/shallow' responses: '200': $ref: '#/components/responses/Value' @@ -1001,6 +1003,20 @@ components: schema: type: boolean default: false + shallow: + name: shallow + in: query + description: | + Instead of the value, what is there one level deep, as JSON, to browse a large + store a level at a time: `type` (`map`, `list`, `text`, `string`, `bytes`, + `number`, `boolean`, `null`, `unknown`), `size` (a map's keys, a list's items, + a text's characters, a string's or bytes' bytes), `value` for a scalar up to + 256 bytes, and for a map `entries`: each key's summary (without entries of its + own). Concurrent values resolved as a read resolves them. Not with `conflicts` + (`400`). + schema: + type: boolean + default: false wait: name: wait in: query |