Ajout des fichiers LFS

openapi/.gitignore

@@ -0,0 +1,6 @@
+/schemas/AllDefinitions.json
+/models.yaml
+/models.json
+/openapi-merged.json
+/openapi-*.yaml
+!/openapi-*.ytt.yaml

openapi/openapi-cluster.ytt.yaml

@@ -0,0 +1,41 @@
+#@ 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: 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"))

openapi/openapi-collections.ytt.yaml

@@ -0,0 +1,282 @@
+#@ load("openapi.lib.yml", "response", "reference", "type", "array")
+
+paths:
+  /collections:
+    get:
+      tags:
+        - Collections
+      summary: List collections
+      description: Get list name of all existing collections
+      operationId: get_collections
+      responses: #@ response(reference("CollectionsResponse"))
+
+  /collections/{collection_name}:
+    get:
+      tags:
+        - Collections
+      summary: Collection info
+      description: Get detailed information about specified existing collection
+      operationId: get_collection
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection to retrieve
+          required: true
+          schema:
+            type: string
+      responses: #@ response(reference("CollectionInfo"))
+
+    put:
+      tags:
+        - Collections
+      summary: Create collection
+      description: Create new collection with given parameters
+      operationId: create_collection
+      requestBody:
+        description: Parameters of a new collection
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/CreateCollection"
+
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the new collection
+          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"))
+
+    patch:
+      tags:
+        - Collections
+      summary: Update collection parameters
+      description: Update parameters of the existing collection
+      operationId: update_collection
+      requestBody:
+        description: New parameters
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/UpdateCollection"
+
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection to update
+          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"))
+
+    delete:
+      tags:
+        - Collections
+      summary: Delete collection
+      description: Drop collection and all associated data
+      operationId: delete_collection
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection to delete
+          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/aliases:
+    post:
+      tags:
+        - Aliases
+      summary: Update aliases of the collections
+      operationId: update_aliases
+      requestBody:
+        description: Alias update operations
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/ChangeAliasesOperation"
+      parameters:
+        - 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}/index:
+    put:
+      tags:
+        - Indexes
+      summary: Create index for field in collection
+      description: Create index for field in collection
+      operationId: create_field_index
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection
+          required: true
+          schema:
+            type: string
+        - name: wait
+          in: query
+          description: "If true, wait for changes to actually happen"
+          required: false
+          schema:
+            type: boolean
+        - name: ordering
+          in: query
+          description: "define ordering guarantees for the operation"
+          required: false
+          schema:
+            $ref: "#/components/schemas/WriteOrdering"
+      requestBody:
+        description: Field name
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/CreateFieldIndex"
+
+      responses: #@ response(reference("UpdateResult"))
+
+  /collections/{collection_name}/exists:
+    get:
+      tags:
+        - Collections
+      summary: Check the existence of a collection
+      description: Returns "true" if the given collection name exists, and "false" otherwise
+      operationId: collection_exists
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection
+          required: true
+          schema:
+            type: string
+      responses: #@ response(reference("CollectionExistence"))
+
+  /collections/{collection_name}/index/{field_name}:
+    delete:
+      tags:
+        - Indexes
+      summary: Delete index for field in collection
+      description: Delete field index for collection
+      operationId: delete_field_index
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection
+          required: true
+          schema:
+            type: string
+        - name: field_name
+          in: path
+          description: Name of the field where to delete the index
+          required: true
+          schema:
+            type: string
+        - name: wait
+          in: query
+          description: "If true, wait for changes to actually happen"
+          required: false
+          schema:
+            type: boolean
+        - name: ordering
+          in: query
+          description: "define ordering guarantees for the operation"
+          required: false
+          schema:
+            $ref: "#/components/schemas/WriteOrdering"
+      responses: #@ response(reference("UpdateResult"))
+
+  /collections/{collection_name}/cluster:
+    get:
+      tags:
+        - Distributed
+      summary: Collection cluster info
+      description: Get cluster information for a collection
+      operationId: collection_cluster_info
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection to retrieve the cluster info for
+          required: true
+          schema:
+            type: string
+      responses: #@ response(reference("CollectionClusterInfo"))
+
+    post:
+      tags:
+        - Distributed
+      summary: Update collection cluster setup
+      operationId: update_collection_cluster
+      requestBody:
+        description: Collection cluster update operations
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/ClusterOperations"
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection on which to to apply the cluster update operation
+          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}/aliases:
+    get:
+      tags:
+        - Aliases
+      summary: List aliases for collection
+      description: Get list of all aliases for a collection
+      operationId: get_collection_aliases
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection
+          required: true
+          schema:
+            type: string
+      responses: #@ response(reference("CollectionsAliasesResponse"))
+
+  /aliases:
+    get:
+      tags:
+        - Aliases
+      summary: List collections aliases
+      description: Get list of all existing collections aliases
+      operationId: get_collections_aliases
+      responses: #@ response(reference("CollectionsAliasesResponse"))

openapi/openapi-main.ytt.yaml

@@ -0,0 +1,871 @@
+#@ load("openapi.lib.yml", "response", "reference", "type", "array")
+
+openapi: 3.0.1
+security:
+  - api-key: []
+  - bearerAuth: []
+  - {}
+info:
+  title: Qdrant API
+  description: >
+
+    API description for Qdrant vector search engine.
+
+
+    This document describes CRUD and search operations on collections of points (vectors with payload).
+
+
+    Qdrant supports any combinations of `should`, `min_should`, `must` and `must_not` conditions,
+    which makes it possible to use in applications when object could not be described solely by vector.
+    It could be location features, availability flags, and other custom properties businesses should take into account.
+
+    ## Examples
+
+    This examples cover the most basic use-cases - collection creation and basic vector search.
+
+    ### Create collection
+
+    First - let's create a collection with dot-production metric.
+
+    ```
+
+    curl -X PUT 'http://localhost:6333/collections/test_collection' \
+      -H 'Content-Type: application/json' \
+      --data-raw '{
+        "vectors": {
+          "size": 4,
+          "distance": "Dot"
+        }
+      }'
+
+    ```
+
+    Expected response:
+
+    ```
+
+    {
+        "result": true,
+        "status": "ok",
+        "time": 0.031095451
+    }
+
+    ```
+
+    We can ensure that collection was created:
+
+    ```
+
+    curl 'http://localhost:6333/collections/test_collection'
+
+    ```
+
+    Expected response:
+
+    ```
+
+    {
+      "result": {
+        "status": "green",
+        "vectors_count": 0,
+        "segments_count": 5,
+        "disk_data_size": 0,
+        "ram_data_size": 0,
+        "config": {
+          "params": {
+            "vectors": {
+              "size": 4,
+              "distance": "Dot"
+            }
+          },
+          "hnsw_config": {
+            "m": 16,
+            "ef_construct": 100,
+            "full_scan_threshold": 10000
+          },
+          "optimizer_config": {
+            "deleted_threshold": 0.2,
+            "vacuum_min_vector_number": 1000,
+            "default_segment_number": 2,
+            "max_segment_size": null,
+            "memmap_threshold": null,
+            "indexing_threshold": 20000,
+            "flush_interval_sec": 5,
+            "max_optimization_threads": null
+          },
+          "wal_config": {
+            "wal_capacity_mb": 32,
+            "wal_segments_ahead": 0
+          }
+        }
+      },
+      "status": "ok",
+      "time": 2.1199e-05
+    }
+
+    ```
+
+
+    ### Add points
+
+    Let's now add vectors with some payload:
+
+    ```
+
+    curl -L -X PUT 'http://localhost:6333/collections/test_collection/points?wait=true' \
+    -H 'Content-Type: application/json' \
+    --data-raw '{
+      "points": [
+        {"id": 1, "vector": [0.05, 0.61, 0.76, 0.74], "payload": {"city": "Berlin"}},
+        {"id": 2, "vector": [0.19, 0.81, 0.75, 0.11], "payload": {"city": ["Berlin", "London"] }},
+        {"id": 3, "vector": [0.36, 0.55, 0.47, 0.94], "payload": {"city": ["Berlin", "Moscow"] }},
+        {"id": 4, "vector": [0.18, 0.01, 0.85, 0.80], "payload": {"city": ["London", "Moscow"] }},
+        {"id": 5, "vector": [0.24, 0.18, 0.22, 0.44], "payload": {"count": [0]}},
+        {"id": 6, "vector": [0.35, 0.08, 0.11, 0.44]}
+      ]
+    }'
+
+    ```
+
+    Expected response:
+
+    ```
+
+    {
+        "result": {
+            "operation_id": 0,
+            "status": "completed"
+        },
+        "status": "ok",
+        "time": 0.000206061
+    }
+
+    ```
+
+    ### Search with filtering
+
+    Let's start with a basic request:
+
+    ```
+
+    curl -L -X POST 'http://localhost:6333/collections/test_collection/points/search' \
+    -H 'Content-Type: application/json' \
+    --data-raw '{
+        "vector": [0.2,0.1,0.9,0.7],
+        "top": 3
+    }'
+
+    ```
+
+    Expected response:
+
+    ```
+
+    {
+        "result": [
+            { "id": 4, "score": 1.362, "payload": null, "version": 0 },
+            { "id": 1, "score": 1.273, "payload": null, "version": 0 },
+            { "id": 3, "score": 1.208, "payload": null, "version": 0 }
+        ],
+        "status": "ok",
+        "time": 0.000055785
+    }
+
+    ```
+
+    But result is different if we add a filter:
+
+    ```
+
+    curl -L -X POST 'http://localhost:6333/collections/test_collection/points/search' \
+    -H 'Content-Type: application/json' \
+    --data-raw '{
+        "filter": {
+            "should": [
+                {
+                    "key": "city",
+                    "match": {
+                        "value": "London"
+                    }
+                }
+            ]
+        },
+        "vector": [0.2, 0.1, 0.9, 0.7],
+        "top": 3
+    }'
+
+    ```
+
+    Expected response:
+
+    ```
+
+    {
+        "result": [
+            { "id": 4, "score": 1.362, "payload": null, "version": 0 },
+            { "id": 2, "score": 0.871, "payload": null, "version": 0 }
+        ],
+        "status": "ok",
+        "time": 0.000093972
+    }
+
+    ```
+
+  contact:
+    email: [email protected]
+  license:
+    name: Apache 2.0
+    url: http://www.apache.org/licenses/LICENSE-2.0.html
+  version: master
+externalDocs:
+  description: Find out more about Qdrant applications and demo
+  url: https://qdrant.tech/documentation/
+servers:
+  - url: "{protocol}://{hostname}:{port}"
+    variables:
+      protocol:
+        enum:
+          - http
+          - https
+        default: http
+      hostname:
+        default: localhost
+      port:
+        default: "6333"
+tags:
+  - name: Collections
+    description: Searchable collections of points.
+  - name: Points
+    description: Float-point vectors with payload.
+  - name: Search
+    description: Find points in a collection.
+  - name: Aliases
+    description: Additional names for existing collections.
+  - name: Indexes
+    description: Indexes for payloads associated with points.
+  - name: Distributed
+    description: Service distributed setup.
+  - name: Snapshots
+    description: Storage and collections snapshots.
+  - name: Service
+    description: Qdrant service utilities.
+  - name: Beta
+    description: Beta features, do not depend on these yet.
+
+paths:
+  /collections/{collection_name}/points/scroll:
+    post:
+      tags:
+        - Points
+      summary: Scroll points
+      description: Scroll request - paginate over all points which matches given filtering condition
+      operationId: scroll_points
+      requestBody:
+        description: Pagination and filter parameters
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/ScrollRequest"
+
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection to retrieve from
+          required: true
+          schema:
+            type: string
+        - name: consistency
+          in: query
+          description: Define read consistency guarantees for the operation
+          required: false
+          schema:
+            $ref: "#/components/schemas/ReadConsistency"
+        - name: timeout
+          in: query
+          description: If set, overrides global timeout for this request. Unit is seconds.
+          required: false
+          schema:
+            type: integer
+            minimum: 1
+      responses: #@ response(reference("ScrollResult"))
+
+  /collections/{collection_name}/points/search:
+    post:
+      tags:
+        - Search
+      summary: Search points
+      description: Retrieve closest points based on vector similarity and given filtering conditions
+      operationId: search_points
+      requestBody:
+        description: Search request with optional filtering
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/SearchRequest"
+
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection to search in
+          required: true
+          schema:
+            type: string
+        - name: consistency
+          in: query
+          description: Define read consistency guarantees for the operation
+          required: false
+          schema:
+            $ref: "#/components/schemas/ReadConsistency"
+        - name: timeout
+          in: query
+          description: If set, overrides global timeout for this request. Unit is seconds.
+          required: false
+          schema:
+            type: integer
+            minimum: 1
+      responses: #@ response(array(reference("ScoredPoint")))
+
+  /collections/{collection_name}/points/search/batch:
+    post:
+      tags:
+        - Search
+      summary: Search batch points
+      description: Retrieve by batch the closest points based on vector similarity and given filtering conditions
+      operationId: search_batch_points
+      requestBody:
+        description: Search batch request
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/SearchRequestBatch"
+
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection to search in
+          required: true
+          schema:
+            type: string
+        - name: consistency
+          in: query
+          description: Define read consistency guarantees for the operation
+          required: false
+          schema:
+            $ref: "#/components/schemas/ReadConsistency"
+        - name: timeout
+          in: query
+          description: If set, overrides global timeout for this request. Unit is seconds.
+          required: false
+          schema:
+            type: integer
+            minimum: 1
+      responses: #@ response(array(array(reference("ScoredPoint"))))
+
+  /collections/{collection_name}/points/search/groups:
+    post:
+      tags:
+        - Search
+      summary: Search point groups
+      description: Retrieve closest points based on vector similarity and given filtering conditions, grouped by a given payload field
+      operationId: search_point_groups
+      requestBody:
+        description: Search request with optional filtering, grouped by a given payload field
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/SearchGroupsRequest"
+
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection to search in
+          required: true
+          schema:
+            type: string
+        - name: consistency
+          in: query
+          description: Define read consistency guarantees for the operation
+          required: false
+          schema:
+            $ref: "#/components/schemas/ReadConsistency"
+        - name: timeout
+          in: query
+          description: If set, overrides global timeout for this request. Unit is seconds.
+          required: false
+          schema:
+            type: integer
+            minimum: 1
+      responses: #@ response(reference("GroupsResult"))
+
+  /collections/{collection_name}/points/recommend:
+    post:
+      tags:
+        - Search
+      summary: Recommend points
+      description: Look for the points which are closer to stored positive examples and at the same time further to negative examples.
+      operationId: recommend_points
+      requestBody:
+        description: Request points based on positive and negative examples.
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/RecommendRequest"
+
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection to search in
+          required: true
+          schema:
+            type: string
+        - name: consistency
+          in: query
+          description: Define read consistency guarantees for the operation
+          required: false
+          schema:
+            $ref: "#/components/schemas/ReadConsistency"
+        - name: timeout
+          in: query
+          description: If set, overrides global timeout for this request. Unit is seconds.
+          required: false
+          schema:
+            type: integer
+            minimum: 1
+      responses: #@ response(array(reference("ScoredPoint")))
+
+  /collections/{collection_name}/points/recommend/batch:
+    post:
+      tags:
+        - Search
+      summary: Recommend batch points
+      description: Look for the points which are closer to stored positive examples and at the same time further to negative examples.
+      operationId: recommend_batch_points
+      requestBody:
+        description: Request points based on positive and negative examples.
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/RecommendRequestBatch"
+
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection to search in
+          required: true
+          schema:
+            type: string
+        - name: consistency
+          in: query
+          description: Define read consistency guarantees for the operation
+          required: false
+          schema:
+            $ref: "#/components/schemas/ReadConsistency"
+        - name: timeout
+          in: query
+          description: If set, overrides global timeout for this request. Unit is seconds.
+          required: false
+          schema:
+            type: integer
+            minimum: 1
+      responses: #@ response(array(array(reference("ScoredPoint"))))
+
+  /collections/{collection_name}/points/recommend/groups:
+    post:
+      tags:
+        - Search
+      summary: Recommend point groups
+      description: Look for the points which are closer to stored positive examples and at the same time further to negative examples, grouped by a given payload field.
+      operationId: recommend_point_groups
+      requestBody:
+        description: Request points based on positive and negative examples, grouped by a payload field.
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/RecommendGroupsRequest"
+
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection to search in
+          required: true
+          schema:
+            type: string
+        - name: consistency
+          in: query
+          description: Define read consistency guarantees for the operation
+          required: false
+          schema:
+            $ref: "#/components/schemas/ReadConsistency"
+        - name: timeout
+          in: query
+          description: If set, overrides global timeout for this request. Unit is seconds.
+          required: false
+          schema:
+            type: integer
+            minimum: 1
+      responses: #@ response(reference("GroupsResult"))
+
+  /collections/{collection_name}/points/discover:
+    post:
+      tags:
+        - Search
+      summary: Discover points
+      description: >
+        Use context and a target to find the most similar points to the target, constrained by the context.
+
+        When using only the context (without a target), a special search - called context search - is performed where
+        pairs of points are used to generate a loss that guides the search towards the zone where
+        most positive examples overlap. This means that the score minimizes the scenario of
+        finding a point closer to a negative than to a positive part of a pair.
+
+        Since the score of a context relates to loss, the maximum score a point can get is 0.0,
+        and it becomes normal that many points can have a score of 0.0.
+
+        When using target (with or without context), the score behaves a little different: The 
+        integer part of the score represents the rank with respect to the context, while the
+        decimal part of the score relates to the distance to the target. The context part of the score for 
+        each pair is calculated +1 if the point is closer to a positive than to a negative part of a pair, 
+        and -1 otherwise.
+      operationId: discover_points
+      requestBody:
+        description: Request points based on {positive, negative} pairs of examples, and/or a target
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/DiscoverRequest"
+
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection to search in
+          required: true
+          schema:
+            type: string
+        - name: consistency
+          in: query
+          description: Define read consistency guarantees for the operation
+          required: false
+          schema:
+            $ref: "#/components/schemas/ReadConsistency"
+        - name: timeout
+          in: query
+          description: If set, overrides global timeout for this request. Unit is seconds.
+          required: false
+          schema:
+            type: integer
+            minimum: 1
+      responses: #@ response(array(reference("ScoredPoint")))
+
+  /collections/{collection_name}/points/discover/batch:
+    post:
+      tags:
+        - Search
+      summary: Discover batch points
+      description: Look for points based on target and/or positive and negative example pairs, in batch.
+      operationId: discover_batch_points
+      requestBody:
+        description: Batch request points based on { positive, negative } pairs of examples, and/or a target.
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/DiscoverRequestBatch"
+
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection to search in
+          required: true
+          schema:
+            type: string
+        - name: consistency
+          in: query
+          description: Define read consistency guarantees for the operation
+          required: false
+          schema:
+            $ref: "#/components/schemas/ReadConsistency"
+        - name: timeout
+          in: query
+          description: If set, overrides global timeout for this request. Unit is seconds.
+          required: false
+          schema:
+            type: integer
+            minimum: 1
+      responses: #@ response(array(array(reference("ScoredPoint"))))
+
+  /collections/{collection_name}/points/count:
+    post:
+      tags:
+        - Points
+      summary: Count points
+      description: Count points which matches given filtering condition
+      operationId: count_points
+      requestBody:
+        description: Request counts of points which matches given filtering condition
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/CountRequest"
+
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection to count in
+          required: true
+          schema:
+            type: string
+        - name: timeout
+          in: query
+          description: If set, overrides global timeout for this request. Unit is seconds.
+          required: false
+          schema:
+            type: integer
+            minimum: 1
+      responses: #@ response(reference("CountResult"))
+
+  /collections/{collection_name}/facet:
+    post:
+      tags:
+        - Points
+      summary: Facet a payload key with a given filter.
+      description: Count points that satisfy the given filter for each unique value of a payload key.
+      operationId: facet
+      requestBody:
+        description: Request counts of points for each unique value of a payload key
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/FacetRequest"
+
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection to facet in
+          required: true
+          schema:
+            type: string
+        - name: timeout
+          in: query
+          description: If set, overrides global timeout for this request. Unit is seconds.
+          required: false
+          schema:
+            type: integer
+            minimum: 1
+        - name: consistency
+          in: query
+          description: Define read consistency guarantees for the operation
+          required: false
+          schema:
+            $ref: "#/components/schemas/ReadConsistency"
+      responses: #@ response(reference("FacetResponse"))
+      
+  /collections/{collection_name}/points/query:
+    post:
+      tags:
+        - Search
+      summary: Query points
+      description: Universally query points. This endpoint covers all capabilities of search, recommend, discover, filters. But also enables hybrid and multi-stage queries.
+      operationId: query_points
+      requestBody: 
+        description: Describes the query to make to the collection
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/QueryRequest"
+              
+
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection to query
+          required: true
+          schema:
+            type: string
+        - name: consistency
+          in: query
+          description: Define read consistency guarantees for the operation
+          required: false
+          schema:
+            $ref: "#/components/schemas/ReadConsistency"
+        - name: timeout
+          in: query
+          description: If set, overrides global timeout for this request. Unit is seconds.
+          required: false
+          schema:
+            type: integer
+            minimum: 1
+
+      responses: #@ response(reference("QueryResponse"))
+
+  /collections/{collection_name}/points/query/batch:
+    post:
+      tags:
+        - Search
+      summary: Query points in batch
+      description: Universally query points in batch. This endpoint covers all capabilities of search, recommend, discover, filters. But also enables hybrid and multi-stage queries.
+      operationId: query_batch_points
+      requestBody:
+        description: Describes the queries to make to the collection
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/QueryRequestBatch"
+
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection to query
+          required: true
+          schema:
+            type: string
+        - name: consistency
+          in: query
+          description: Define read consistency guarantees for the operation
+          required: false
+          schema:
+            $ref: "#/components/schemas/ReadConsistency"
+        - name: timeout
+          in: query
+          description: If set, overrides global timeout for this request. Unit is seconds.
+          required: false
+          schema:
+            type: integer
+            minimum: 1
+
+      responses: #@ response(array(reference("QueryResponse")))
+
+  /collections/{collection_name}/points/query/groups:
+    post:
+      tags:
+        - Search
+      summary: Query points, grouped by a given payload field
+      description: Universally query points, grouped by a given payload field
+      operationId: query_points_groups
+      requestBody:
+        description: Describes the query to make to the collection
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/QueryGroupsRequest"
+
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection to query
+          required: true
+          schema:
+            type: string
+        - name: consistency
+          in: query
+          description: Define read consistency guarantees for the operation
+          required: false
+          schema:
+            $ref: "#/components/schemas/ReadConsistency"
+        - name: timeout
+          in: query
+          description: If set, overrides global timeout for this request. Unit is seconds.
+          required: false
+          schema:
+            type: integer
+            minimum: 1
+
+      responses: #@ response(reference("GroupsResult"))
+
+  /collections/{collection_name}/points/search/matrix/pairs:
+    post:
+      tags:
+        - Search
+      summary: Search points matrix distance pairs
+      description: Compute distance matrix for sampled points with a pair based output format
+      operationId: search_matrix_pairs
+      requestBody:
+        description: Search matrix request with optional filtering
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/SearchMatrixRequest"
+
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection to search in
+          required: true
+          schema:
+            type: string
+        - name: consistency
+          in: query
+          description: Define read consistency guarantees for the operation
+          required: false
+          schema:
+            $ref: "#/components/schemas/ReadConsistency"
+        - name: timeout
+          in: query
+          description: If set, overrides global timeout for this request. Unit is seconds.
+          required: false
+          schema:
+            type: integer
+            minimum: 1
+      responses: #@ response(reference("SearchMatrixPairsResponse"))
+
+  /collections/{collection_name}/points/search/matrix/offsets:
+    post:
+      tags:
+        - Search
+      summary: Search points matrix distance offsets
+      description: Compute distance matrix for sampled points with an offset based output format
+      operationId: search_matrix_offsets
+      requestBody:
+        description: Search matrix request with optional filtering
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/SearchMatrixRequest"
+
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection to search in
+          required: true
+          schema:
+            type: string
+        - name: consistency
+          in: query
+          description: Define read consistency guarantees for the operation
+          required: false
+          schema:
+            $ref: "#/components/schemas/ReadConsistency"
+        - name: timeout
+          in: query
+          description: If set, overrides global timeout for this request. Unit is seconds.
+          required: false
+          schema:
+            type: integer
+            minimum: 1
+      responses: #@ response(reference("SearchMatrixOffsetsResponse"))
+
+components:
+  securitySchemes:
+    api-key:
+      type: apiKey
+      in: header
+      name: api-key
+      description: Authorization key, either read-write or read-only
+    bearerAuth:
+      type: http
+      scheme: bearer
+  schemas:
+    ErrorResponse:
+      type: object
+      properties:
+        time:
+          type: number
+          format: float
+          description: Time spent to process this request
+        status:
+          type: object
+          properties:
+            error:
+              type: string
+              description: Description of the occurred error.
+        result:
+          type: object
+          nullable: true

openapi/openapi-points.ytt.yaml

@@ -0,0 +1,376 @@
+#@ load("openapi.lib.yml", "response", "reference", "type", "array")
+
+paths:
+  /collections/{collection_name}/points/{id}:
+    get:
+      tags:
+        - Points
+      summary: Get point
+      description: Retrieve full information of single point by id
+      operationId: get_point
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection to retrieve from
+          required: true
+          schema:
+            type: string
+        - name: id
+          in: path
+          description: Id of the point
+          required: true
+          schema:
+            $ref: "#/components/schemas/ExtendedPointId"
+        - name: consistency
+          in: query
+          description: Define read consistency guarantees for the operation
+          required: false
+          schema:
+            $ref: "#/components/schemas/ReadConsistency"
+      responses: #@ response(reference("Record"))
+
+  /collections/{collection_name}/points:
+    post:
+      tags:
+        - Points
+      summary: Get points
+      description: Retrieve multiple points by specified IDs
+      operationId: get_points
+      requestBody:
+        description: List of points to retrieve
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/PointRequest"
+
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection to retrieve from
+          required: true
+          schema:
+            type: string
+        - name: consistency
+          in: query
+          description: Define read consistency guarantees for the operation
+          required: false
+          schema:
+            $ref: "#/components/schemas/ReadConsistency"
+        - name: timeout
+          in: query
+          description: If set, overrides global timeout for this request. Unit is seconds.
+          required: false
+          schema:
+            type: integer
+            minimum: 1
+      responses: #@ response(array(reference("Record")))
+
+    put:
+      tags:
+        - Points
+      summary: Upsert points
+      description: Perform insert + updates on points. If point with given ID already exists - it will be overwritten.
+      operationId: upsert_points
+      requestBody:
+        description: Operation to perform on points
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/PointInsertOperations"
+
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection to update from
+          required: true
+          schema:
+            type: string
+        - name: wait
+          in: query
+          description: "If true, wait for changes to actually happen"
+          required: false
+          schema:
+            type: boolean
+        - name: ordering
+          in: query
+          description: "define ordering guarantees for the operation"
+          required: false
+          schema:
+            $ref: "#/components/schemas/WriteOrdering"
+      responses: #@ response(reference("UpdateResult"))
+
+  /collections/{collection_name}/points/delete:
+    post:
+      tags:
+        - Points
+      summary: Delete points
+      description: Delete points
+      operationId: delete_points
+      requestBody:
+        description: Operation to perform on points
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/PointsSelector"
+
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection to delete from
+          required: true
+          schema:
+            type: string
+        - name: wait
+          in: query
+          description: "If true, wait for changes to actually happen"
+          required: false
+          schema:
+            type: boolean
+        - name: ordering
+          in: query
+          description: "define ordering guarantees for the operation"
+          required: false
+          schema:
+            $ref: "#/components/schemas/WriteOrdering"
+      responses: #@ response(reference("UpdateResult"))
+
+  /collections/{collection_name}/points/vectors:
+    put:
+      tags:
+        - Points
+      summary: Update vectors
+      description: Update specified named vectors on points, keep unspecified vectors intact.
+      operationId: update_vectors
+      requestBody:
+        description: Update named vectors on points
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/UpdateVectors"
+
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection to update from
+          required: true
+          schema:
+            type: string
+        - name: wait
+          in: query
+          description: "If true, wait for changes to actually happen"
+          required: false
+          schema:
+            type: boolean
+        - name: ordering
+          in: query
+          description: "define ordering guarantees for the operation"
+          required: false
+          schema:
+            $ref: "#/components/schemas/WriteOrdering"
+      responses: #@ response(reference("UpdateResult"))
+
+  /collections/{collection_name}/points/vectors/delete:
+    post:
+      tags:
+        - Points
+      summary: Delete vectors
+      description: Delete named vectors from the given points.
+      operationId: delete_vectors
+      requestBody:
+        description: Delete named vectors from points
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/DeleteVectors"
+
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection to delete from
+          required: true
+          schema:
+            type: string
+        - name: wait
+          in: query
+          description: "If true, wait for changes to actually happen"
+          required: false
+          schema:
+            type: boolean
+        - name: ordering
+          in: query
+          description: "define ordering guarantees for the operation"
+          required: false
+          schema:
+            $ref: "#/components/schemas/WriteOrdering"
+      responses: #@ response(reference("UpdateResult"))
+
+  /collections/{collection_name}/points/payload:
+    post:
+      tags:
+        - Points
+      summary: Set payload
+      description: Set payload values for points
+      operationId: set_payload
+      requestBody:
+        description: Set payload on points
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/SetPayload"
+
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection to set from
+          required: true
+          schema:
+            type: string
+        - name: wait
+          in: query
+          description: "If true, wait for changes to actually happen"
+          required: false
+          schema:
+            type: boolean
+        - name: ordering
+          in: query
+          description: "define ordering guarantees for the operation"
+          required: false
+          schema:
+            $ref: "#/components/schemas/WriteOrdering"
+      responses: #@ response(reference("UpdateResult"))
+    put:
+      tags:
+        - Points
+      summary: Overwrite payload
+      description: Replace full payload of points with new one
+      operationId: overwrite_payload
+      requestBody:
+        description: Payload and points selector
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/SetPayload"
+
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection to set from
+          required: true
+          schema:
+            type: string
+        - name: wait
+          in: query
+          description: "If true, wait for changes to actually happen"
+          required: false
+          schema:
+            type: boolean
+        - name: ordering
+          in: query
+          description: "define ordering guarantees for the operation"
+          required: false
+          schema:
+            $ref: "#/components/schemas/WriteOrdering"
+      responses: #@ response(reference("UpdateResult"))
+
+  /collections/{collection_name}/points/payload/delete:
+    post:
+      tags:
+        - Points
+      summary: Delete payload
+      description: Delete specified key payload for points
+      operationId: delete_payload
+      requestBody:
+        description: delete payload on points
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/DeletePayload"
+
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection to delete from
+          required: true
+          schema:
+            type: string
+        - name: wait
+          in: query
+          description: "If true, wait for changes to actually happen"
+          required: false
+          schema:
+            type: boolean
+        - name: ordering
+          in: query
+          description: "define ordering guarantees for the operation"
+          required: false
+          schema:
+            $ref: "#/components/schemas/WriteOrdering"
+      responses: #@ response(reference("UpdateResult"))
+
+  /collections/{collection_name}/points/payload/clear:
+    post:
+      tags:
+        - Points
+      summary: Clear payload
+      description: Remove all payload for specified points
+      operationId: clear_payload
+      requestBody:
+        description: clear payload on points
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/PointsSelector"
+
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection to clear payload from
+          required: true
+          schema:
+            type: string
+        - name: wait
+          in: query
+          description: "If true, wait for changes to actually happen"
+          required: false
+          schema:
+            type: boolean
+        - name: ordering
+          in: query
+          description: "define ordering guarantees for the operation"
+          required: false
+          schema:
+            $ref: "#/components/schemas/WriteOrdering"
+      responses: #@ response(reference("UpdateResult"))
+  /collections/{collection_name}/points/batch:
+    post:
+      tags:
+        - Points
+      summary: Batch update points
+      description: Apply a series of update operations for points, vectors and payloads
+      operationId: batch_update
+      requestBody:
+        description: update operations
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/UpdateOperations"
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection to apply operations on
+          required: true
+          schema:
+            type: string
+        - name: wait
+          in: query
+          description: "If true, wait for changes to actually happen"
+          required: false
+          schema:
+            type: boolean
+        - name: ordering
+          in: query
+          description: "define ordering guarantees for the operation"
+          required: false
+          schema:
+            $ref: "#/components/schemas/WriteOrdering"
+      responses: #@ response(array(reference("UpdateResult")))

openapi/openapi-service.ytt.yaml

@@ -0,0 +1,178 @@
+#@ load("openapi.lib.yml", "response", "reference", "type", "array")
+
+paths:
+  /:
+    get:
+      summary: Returns information about the running Qdrant instance
+      description: Returns information about the running Qdrant instance like version and commit id
+      operationId: root
+      tags:
+        - Service
+      responses:
+        "200":
+          description: Qdrant server version information
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/VersionInfo"
+        "4XX":
+          description: error
+
+  /telemetry:
+    get:
+      summary: Collect telemetry data
+      description: Collect telemetry data including app info, system info, collections info, cluster info, configs and statistics
+      operationId: telemetry
+      tags:
+        - Service
+      parameters:
+        - name: anonymize
+          in: query
+          description: "If true, anonymize result"
+          required: false
+          schema:
+            type: boolean
+      responses: #@ response(reference("TelemetryData"))
+
+  /metrics:
+    get:
+      summary: Collect Prometheus metrics data
+      description: Collect metrics data including app info, collections info, cluster info and statistics
+      operationId: metrics
+      tags:
+        - Service
+      parameters:
+        - name: anonymize
+          in: query
+          description: "If true, anonymize result"
+          required: false
+          schema:
+            type: boolean
+      responses:
+        "200":
+          description: Metrics data in Prometheus format
+          content:
+            text/plain:
+              schema:
+                type: string
+                example: |
+                  # HELP app_info information about qdrant server
+                  # TYPE app_info gauge
+                  app_info{name="qdrant",version="0.11.1"} 1
+                  # HELP cluster_enabled is cluster support enabled
+                  # TYPE cluster_enabled gauge
+                  cluster_enabled 0
+                  # HELP collections_total number of collections
+                  # TYPE collections_total gauge
+                  collections_total 1
+        "4XX":
+          description: error
+
+  /locks:
+    post:
+      summary: Set lock options
+      description: Set lock options. If write is locked, all write operations and collection creation are forbidden. Returns previous lock options
+      operationId: post_locks
+      tags:
+        - Service
+      requestBody:
+        description: Lock options and optional error message
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/LocksOption"
+      responses: #@ response(reference("LocksOption"))
+
+    get:
+      summary: Get lock options
+      description: Get lock options. If write is locked, all write operations and collection creation are forbidden
+      operationId: get_locks
+      tags:
+        - Service
+      responses: #@ response(reference("LocksOption"))
+
+  /healthz:
+    get:
+      summary: Kubernetes healthz endpoint
+      description: An endpoint for health checking used in Kubernetes.
+      operationId: healthz
+      tags:
+        - Service
+      responses:
+        "200":
+          description: Healthz response
+          content:
+            text/plain:
+              schema:
+                type: string
+                example: healthz check passed
+        "4XX":
+          description: error
+
+  /livez:
+    get:
+      summary: Kubernetes livez endpoint
+      description: An endpoint for health checking used in Kubernetes.
+      operationId: livez
+      tags:
+        - Service
+      responses:
+        "200":
+          description: Healthz response
+          content:
+            text/plain:
+              schema:
+                type: string
+                example: healthz check passed
+        "4XX":
+          description: error
+
+  /readyz:
+    get:
+      summary: Kubernetes readyz endpoint
+      description: An endpoint for health checking used in Kubernetes.
+      operationId: readyz
+      tags:
+        - Service
+      responses:
+        "200":
+          description: Healthz response
+          content:
+            text/plain:
+              schema:
+                type: string
+                example: healthz check passed
+        "4XX":
+          description: error
+
+  /issues:
+    get:
+      summary: Get issues
+      description: Get a report of performance issues and configuration suggestions
+      operationId: get_issues
+      tags:
+        - Beta
+      responses:
+        "200":
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                type: object
+        "4XX":
+          description: error
+    delete:
+      summary: Clear issues
+      description: Removes all issues reported so far
+      operationId: clear_issues
+      tags:
+        - Beta
+      responses:
+        "200":
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                type: boolean
+        "4XX":
+          description: error

openapi/openapi-shard-snapshots.ytt.yaml

@@ -0,0 +1,214 @@
+#@ load("openapi.lib.yml", "response", "response_with_accepted", "reference", "type", "array")
+
+paths:
+  /collections/{collection_name}/shards/{shard_id}/snapshots/upload:
+    post:
+      tags:
+        - Snapshots
+      summary: Recover shard from an uploaded snapshot
+      description: Recover shard of a local collection from an uploaded snapshot. This will overwrite any data, stored on this node, for the collection shard.
+      operationId: recover_shard_from_uploaded_snapshot
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection
+          required: true
+          schema:
+            type: string
+        - name: shard_id
+          in: path
+          description: Id of the shard to recover
+          required: true
+          schema:
+              type: integer
+        - name: wait
+          in: query
+          description: "If true, wait for changes to actually happen. If false - let changes happen in background. Default is true."
+          required: false
+          schema:
+            type: boolean
+        - name: priority
+          in: query
+          description: "Defines source of truth for snapshot recovery"
+          required: false
+          schema:
+            $ref: "#/components/schemas/SnapshotPriority"
+        - name: checksum
+          in: query
+          description: "Optional SHA256 checksum to verify snapshot integrity before recovery."
+          required: false
+          schema:
+            type: string
+      requestBody:
+        description: Snapshot to recover from
+        content:
+          multipart/form-data:
+            schema:
+              type: object
+              properties:
+                snapshot:
+                  type: string
+                  format: binary
+      responses: #@ response_with_accepted(type("boolean"))
+  /collections/{collection_name}/shards/{shard_id}/snapshots/recover:
+    put:
+      tags:
+        - Snapshots
+      summary: Recover from a snapshot
+      description: Recover shard of a local collection data from a snapshot. This will overwrite any data, stored in this shard, for the collection.
+      operationId: recover_shard_from_snapshot
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection
+          required: true
+          schema:
+            type: string
+        - name: shard_id
+          in: path
+          description: Id of the shard to recover
+          required: true
+          schema:
+            type: integer
+        - name: wait
+          in: query
+          description: "If true, wait for changes to actually happen. If false - let changes happen in background. Default is true."
+          required: false
+          schema:
+            type: boolean
+      requestBody:
+        description: Snapshot to recover from
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/ShardSnapshotRecover"
+      responses: #@ response_with_accepted(type("boolean"))
+
+  /collections/{collection_name}/shards/{shard_id}/snapshots:
+    get:
+      tags:
+        - Snapshots
+      summary: List shards snapshots for a collection
+      description: Get list of snapshots for a shard of a collection
+      operationId: list_shard_snapshots
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection
+          required: true
+          schema:
+            type: string
+        - name: shard_id
+          in: path
+          description: Id of the shard
+          required: true
+          schema:
+              type: integer
+      responses: #@ response(array(reference("SnapshotDescription")))
+
+    post:
+      tags:
+        - Snapshots
+      summary: Create shard snapshot
+      description: Create new snapshot of a shard for a collection
+      operationId: create_shard_snapshot
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection for which to create a snapshot
+          required: true
+          schema:
+            type: string
+        - name: shard_id
+          in: path
+          description: Id of the shard
+          required: true
+          schema:
+            type: integer
+        - name: wait
+          in: query
+          description: "If true, wait for changes to actually happen. If false - let changes happen in background. Default is true."
+          required: false
+          schema:
+            type: boolean
+      responses: #@ response_with_accepted(reference("SnapshotDescription"))
+
+  /collections/{collection_name}/shards/{shard_id}/snapshots/{snapshot_name}:
+    delete:
+      tags:
+        - Snapshots
+      summary: Delete shard snapshot
+      description: Delete snapshot of a shard for a collection
+      operationId: delete_shard_snapshot
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection for which to delete a snapshot
+          required: true
+          schema:
+            type: string
+        - name: shard_id
+          in: path
+          description: Id of the shard
+          required: true
+          schema:
+              type: integer
+        - name: snapshot_name
+          in: path
+          description: Name of the snapshot to delete
+          required: true
+          schema:
+            type: string
+        - name: wait
+          in: query
+          description: "If true, wait for changes to actually happen. If false - let changes happen in background. Default is true."
+          required: false
+          schema:
+            type: boolean
+      responses: #@ response_with_accepted(type("boolean"))
+    get:
+      tags:
+        - Snapshots
+      summary: Download collection snapshot
+      description: Download specified snapshot of a shard from a collection as a file
+      operationId: get_shard_snapshot
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection
+          required: true
+          schema:
+            type: string
+        - name: shard_id
+          in: path
+          description: Id of the shard
+          required: true
+          schema:
+              type: integer
+        - name: snapshot_name
+          in: path
+          description: Name of the snapshot to download
+          required: true
+          schema:
+            type: string
+
+      responses:
+        default:
+          description: error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        4XX:
+          description: error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        '200':
+          description: Snapshot file
+          content:
+            application/octet-stream:
+              schema:
+                type: string
+                format: binary

openapi/openapi-shards.ytt.yaml

@@ -0,0 +1,57 @@
+#@ load("openapi.lib.yml", "response", "reference", "type", "array")
+
+paths:
+  /collections/{collection_name}/shards:
+    put:
+      tags:
+        - Distributed
+      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:
+        - Distributed
+      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"))

openapi/openapi-snapshots.ytt.yaml

@@ -0,0 +1,257 @@
+#@ load("openapi.lib.yml", "response", "response_with_accepted", "reference", "type", "array")
+
+paths:
+  /collections/{collection_name}/snapshots/upload:
+    post:
+      tags:
+        - Snapshots
+      summary: Recover from an uploaded snapshot
+      description: Recover local collection data from an uploaded snapshot. This will overwrite any data, stored on this node, for the collection. If collection does not exist - it will be created.
+      operationId: recover_from_uploaded_snapshot
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection
+          required: true
+          schema:
+            type: string
+        - name: wait
+          in: query
+          description: "If true, wait for changes to actually happen. If false - let changes happen in background. Default is true."
+          required: false
+          schema:
+            type: boolean
+        - name: priority
+          in: query
+          description: "Defines source of truth for snapshot recovery"
+          required: false
+          schema:
+            $ref: "#/components/schemas/SnapshotPriority"
+        - name: checksum
+          in: query
+          description: "Optional SHA256 checksum to verify snapshot integrity before recovery."
+          required: false
+          schema:
+            type: string
+      requestBody:
+        description: Snapshot to recover from
+        content:
+          multipart/form-data:
+            schema:
+              type: object
+              properties:
+                snapshot:
+                  type: string
+                  format: binary
+      responses: #@ response_with_accepted(type("boolean"))
+  /collections/{collection_name}/snapshots/recover:
+    put:
+      tags:
+        - Snapshots
+      summary: Recover from a snapshot
+      description: Recover local collection data from a snapshot. This will overwrite any data, stored on this node, for the collection. If collection does not exist - it will be created.
+      operationId: recover_from_snapshot
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection
+          required: true
+          schema:
+            type: string
+        - name: wait
+          in: query
+          description: "If true, wait for changes to actually happen. If false - let changes happen in background. Default is true."
+          required: false
+          schema:
+            type: boolean
+      requestBody:
+        description: Snapshot to recover from
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/SnapshotRecover"
+      responses: #@ response_with_accepted(type("boolean"))
+
+  /collections/{collection_name}/snapshots:
+    get:
+      tags:
+        - Snapshots
+      summary: List collection snapshots
+      description: Get list of snapshots for a collection
+      operationId: list_snapshots
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection
+          required: true
+          schema:
+            type: string
+      responses: #@ response(array(reference("SnapshotDescription")))
+
+    post:
+      tags:
+        - Snapshots
+      summary: Create collection snapshot
+      description: Create new snapshot for a collection
+      operationId: create_snapshot
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection for which to create a snapshot
+          required: true
+          schema:
+            type: string
+        - name: wait
+          in: query
+          description: "If true, wait for changes to actually happen. If false - let changes happen in background. Default is true."
+          required: false
+          schema:
+            type: boolean
+      responses: #@ response_with_accepted(reference("SnapshotDescription"))
+
+  /collections/{collection_name}/snapshots/{snapshot_name}:
+    delete:
+      tags:
+        - Snapshots
+      summary: Delete collection snapshot
+      description: Delete snapshot for a collection
+      operationId: delete_snapshot
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection for which to delete a snapshot
+          required: true
+          schema:
+            type: string
+        - name: snapshot_name
+          in: path
+          description: Name of the snapshot to delete
+          required: true
+          schema:
+            type: string
+        - name: wait
+          in: query
+          description: "If true, wait for changes to actually happen. If false - let changes happen in background. Default is true."
+          required: false
+          schema:
+            type: boolean
+      responses: #@ response_with_accepted(type("boolean"))
+    get:
+      tags:
+        - Snapshots
+      summary: Download collection snapshot
+      description: Download specified snapshot from a collection as a file
+      operationId: get_snapshot
+      parameters:
+        - name: collection_name
+          in: path
+          description: Name of the collection
+          required: true
+          schema:
+            type: string
+        - name: snapshot_name
+          in: path
+          description: Name of the snapshot to download
+          required: true
+          schema:
+            type: string
+
+      responses:
+        default:
+          description: error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        4XX:
+          description: error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        '200':
+          description: Snapshot file
+          content:
+            application/octet-stream:
+              schema:
+                type: string
+                format: binary
+
+  /snapshots:
+    get:
+      tags:
+        - Snapshots
+      summary: List of storage snapshots
+      description: Get list of snapshots of the whole storage
+      operationId: list_full_snapshots
+      responses: #@ response(array(reference("SnapshotDescription")))
+
+    post:
+      tags:
+        - Snapshots
+      summary: Create storage snapshot
+      description: Create new snapshot of the whole storage
+      operationId: create_full_snapshot
+      parameters:
+        - name: wait
+          in: query
+          description: "If true, wait for changes to actually happen. If false - let changes happen in background. Default is true."
+          required: false
+          schema:
+            type: boolean
+      responses: #@ response_with_accepted(reference("SnapshotDescription"))
+
+  /snapshots/{snapshot_name}:
+    delete:
+      tags:
+        - Snapshots
+      summary: Delete storage snapshot
+      description: Delete snapshot of the whole storage
+      operationId: delete_full_snapshot
+      parameters:
+        - name: snapshot_name
+          in: path
+          description: Name of the full snapshot to delete
+          required: true
+          schema:
+            type: string
+        - name: wait
+          in: query
+          description: "If true, wait for changes to actually happen. If false - let changes happen in background. Default is true."
+          required: false
+          schema:
+            type: boolean
+      responses: #@ response_with_accepted(type("boolean"))
+    get:
+      tags:
+        - Snapshots
+      summary: Download storage snapshot
+      description: Download specified snapshot of the whole storage as a file
+      operationId: get_full_snapshot
+      parameters:
+        - name: snapshot_name
+          in: path
+          description: Name of the snapshot to download
+          required: true
+          schema:
+            type: string
+      responses:
+        default:
+          description: error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        4XX:
+          description: error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        '200':
+          description: Snapshot file
+          content:
+            application/octet-stream:
+              schema:
+                type: string
+                format: binary

openapi/openapi.lib.yml

@@ -0,0 +1,92 @@
+#@ def response(model):
+default:
+  description: error
+  content:
+    application/json:
+      schema:
+        $ref: "#/components/schemas/ErrorResponse"
+4XX:
+  description: error
+  content:
+    application/json:
+      schema:
+        $ref: "#/components/schemas/ErrorResponse"
+"200":
+  description: successful operation
+  content:
+    application/json:
+      schema:
+        type: object
+        properties:
+          usage:
+            default: null
+            anyOf:
+              - $ref: '#/components/schemas/HardwareUsage'
+              - nullable: true
+          time:
+            type: number
+            format: float
+            description: Time spent to process this request
+            example: 0.002
+          status:
+            type: string
+            example: ok
+          result: #@ model
+#@ end
+
+#@ def response_with_accepted(model):
+default:
+  description: error
+  content:
+    application/json:
+      schema:
+        $ref: "#/components/schemas/ErrorResponse"
+4XX:
+  description: error
+  content:
+    application/json:
+      schema:
+        $ref: "#/components/schemas/ErrorResponse"
+"200":
+  description: successful operation
+  content:
+    application/json:
+      schema:
+        type: object
+        properties:
+          time:
+            type: number
+            format: float
+            description: Time spent to process this request
+            example: 0.002
+          status:
+            type: string
+            example: ok
+          result: #@ model
+"202":
+  description: operation is accepted
+  content:
+    application/json:
+      schema:
+        type: object
+        properties:
+          time:
+            type: number
+            format: float
+            description: Time spent to process this request
+          status:
+            type: string
+#@ end
+
+#@ def reference(model_name):
+$ref: #@ "#/components/schemas/" + model_name
+#@ end
+
+#@ def type(type_name):
+type: #@ type_name
+#@ end
+
+#@ def array(type_data):
+type: array
+items: #@ type_data
+#@ end