Files
qdrant/openapi/openapi-cluster.ytt.yaml
Tim Visée c075b28f1f Add timeout param remove peer API (#7235)
* Describe cluster peer remove timeout parameter in OpenAPI spec

* Remove trailing spaces
2025-09-09 16:58:08 +02:00

49 lines
1.4 KiB
YAML

#@ load("openapi.lib.yml", "response", "reference", "type", "array")
paths:
/cluster:
get:
tags:
- Distributed
summary: Get cluster status info
description: Get information about the current state and composition of the cluster
operationId: cluster_status
responses: #@ response(reference("ClusterStatus"))
/cluster/recover:
post:
tags:
- Distributed
summary: Tries to recover current peer Raft state.
operationId: recover_current_peer
responses: #@ response(type("boolean"))
/cluster/peer/{peer_id}:
delete:
tags:
- Distributed
summary: Remove peer from the cluster
description: Tries to remove peer from the cluster. Will return an error if peer has shards on it.
operationId: remove_peer
parameters:
- name: peer_id
in: path
description: Id of the peer
required: true
schema:
type: integer
- 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
- name: force
in: query
description: If true - removes peer even if it has shards/replicas on it.
schema:
type: boolean
default: false
responses: #@ response(type("boolean"))