Files
qdrant/openapi/openapi-shards.ytt.yaml
Andrey Vasnetsov 74de1483be Shard key create confirmation (#3027)
* create dedicated API for creating shards with explicit avait on the consensus

* fmt

* update api definitions
2023-11-16 15:58:32 +01:00

60 lines
1.8 KiB
YAML

#@ load("openapi.lib.yml", "response", "reference", "type", "array")
paths:
/collections/{collection_name}/shards:
put:
tags:
- collections
- cluster
summary: Create shard key
operationId: create_shard_key
requestBody:
description: Shard key configuration
content:
application/json:
schema:
$ref: "#/components/schemas/CreateShardingKey"
parameters:
- name: collection_name
in: path
description: Name of the collection to create shards for
required: true
schema:
type: string
- name: timeout
in: query
description: |
Wait for operation commit timeout in seconds.
If timeout is reached - request will return with service error.
schema:
type: integer
responses: #@ response(type("boolean"))
/collections/{collection_name}/shards/delete:
post:
tags:
- collections
- cluster
summary: Delete shard key
operationId: delete_shard_key
requestBody:
description: Select shard key to delete
content:
application/json:
schema:
$ref: "#/components/schemas/DropShardingKey"
parameters:
- name: collection_name
in: path
description: Name of the collection to create shards for
required: true
schema:
type: string
- name: timeout
in: query
description: |
Wait for operation commit timeout in seconds.
If timeout is reached - request will return with service error.
schema:
type: integer
responses: #@ response(type("boolean"))