openapi: 3.0.3
info:
  title: Weaviate REST API
  description: '# Introduction<br/> Weaviate is an open source, AI-native vector database
    that helps developers create intuitive and reliable AI-powered applications. <br/>
    ### Base Path <br/>The base path for the Weaviate server is structured as `[YOUR-WEAVIATE-HOST]:[PORT]/v1`.
    As an example, if you wish to access the `schema` endpoint on a local instance,
    you would navigate to `http://localhost:8080/v1/schema`. Ensure you replace `[YOUR-WEAVIATE-HOST]`
    and `[PORT]` with your actual server host and port number respectively. <br/>
    ### Questions? <br/>If you have any comments or questions, please feel free to
    reach out to us at the community forum [https://forum.weaviate.io/](https://forum.weaviate.io/).
    <br/>### Issues? <br/>If you find a bug or want to file a feature request, please
    open an issue on our GitHub repository for [Weaviate](https://github.com/weaviate/weaviate).
    <br/>### Need more documentation? <br/>For a quickstart, code examples, concepts
    and more, please visit our [documentation page](https://docs.weaviate.io/weaviate).'
  version: 1.38.0-dev
servers:
- url: http://localhost:8080
  description: Local Weaviate instance
security:
- ApiKeyAuth: []
- BearerAuth: []
paths:
  /:
    get:
      summary: Weaviate List Available Endpoints
      description: Get links to other endpoints to help discover the REST API.
      operationId: weaviate.root
      responses:
        '200':
          description: Weaviate is alive and ready.
          content:
            application/json:
              schema:
                type: object
                properties:
                  links:
                    type: array
                    items:
                      $ref: '#/components/schemas/Link'
      x-microcks-operation:
        delay: 100
  /.well-known/live:
    get:
      summary: Weaviate Check Application Liveness
      description: Indicates if the Weaviate instance is running and responsive to
        basic HTTP requests. Primarily used for health checks, such as Kubernetes
        liveness probes.
      operationId: weaviate.wellknown.liveness
      responses:
        '200':
          description: The application is alive and responding to HTTP requests.
      x-microcks-operation:
        delay: 100
  /.well-known/ready:
    get:
      summary: Weaviate Check Application Readiness
      description: Indicates if the Weaviate instance has completed its startup routines
        and is prepared to accept user traffic (data import, queries, etc.). Used
        for readiness checks, such as Kubernetes readiness probes.
      operationId: weaviate.wellknown.readiness
      responses:
        '200':
          description: The application is ready to serve traffic.
        '503':
          description: The application is not ready to serve traffic. Traffic should
            be directed to other available replicas if applicable.
      x-microcks-operation:
        delay: 100
  /.well-known/openid-configuration:
    get:
      summary: Weaviate Get OIDC Configuration
      description: Provides OpenID Connect (OIDC) discovery information if OIDC authentication
        is configured for Weaviate. Returns details like the token issuer URL, client
        ID, and required scopes.
      tags:
      - well-known
      - oidc
      - discovery
      responses:
        '200':
          description: OIDC configuration details returned successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  href:
                    type: string
                    description: The OIDC issuer URL to redirect to for authentication.
                  clientId:
                    type: string
                    description: The OAuth Client ID configured for Weaviate.
                  scopes:
                    type: array
                    description: The required OAuth scopes for authentication.
                    items:
                      type: string
        '404':
          description: OIDC provider is not configured for this Weaviate instance.
        '500':
          description: An internal server error occurred while retrieving OIDC configuration.
            Check the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /replication/replicate:
    post:
      summary: Weaviate Initiate A Replica Movement
      description: Begins an asynchronous operation to move or copy a specific shard
        replica from its current node to a designated target node. The operation involves
        copying data, synchronizing, and potentially decommissioning the source replica.
      tags:
      - replication
      operationId: replicate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReplicationReplicateReplicaRequest'
      responses:
        '200':
          description: Replication operation registered successfully. ID of the operation
            is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReplicationReplicateReplicaResponse'
        '400':
          description: Malformed request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues. Please check the values in your request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '501':
          description: Replica movement operations are disabled.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    delete:
      summary: Weaviate Delete All Replication Operations
      description: Schedules all replication operations for deletion across all collections,
        shards, and nodes.
      tags:
      - replication
      operationId: deleteAllReplications
      responses:
        '204':
          description: Replication operation registered successfully
        '400':
          description: Malformed request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues. Please check the values in your request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '501':
          description: Replica movement operations are disabled.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /replication/replicate/force-delete:
    post:
      summary: Weaviate Force Delete Replication Operations
      description: USE AT OWN RISK! Synchronously force delete operations from the
        FSM. This will not perform any checks on which state the operation is in so
        may lead to data corruption or loss. It is recommended to first scale the
        number of replication engine workers to 0 before calling this endpoint to
        ensure no operations are in-flight.
      tags:
      - replication
      operationId: forceDeleteReplications
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReplicationReplicateForceDeleteRequest'
      responses:
        '200':
          description: Replication operations force deleted successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReplicationReplicateForceDeleteResponse'
        '400':
          description: Malformed request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues. Please check the values in your request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /replication/replicate/{id}:
    get:
      summary: Weaviate Retrieve A Replication Operation
      description: Fetches the current status and detailed information for a specific
        replication operation, identified by its unique ID. Optionally includes historical
        data of the operation's progress if requested.
      tags:
      - replication
      operationId: replicationDetails
      parameters:
      - name: id
        in: path
        required: true
        description: The ID of the replication operation to get details for.
        schema:
          type: string
          format: uuid
      - name: includeHistory
        in: query
        required: false
        description: Whether to include the history of the replication operation.
        schema:
          type: boolean
      responses:
        '200':
          description: The details of the replication operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReplicationReplicateDetailsReplicaResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Shard replica operation not found.
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues. Please check the values in your request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '501':
          description: Replica movement operations are disabled.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    delete:
      summary: Weaviate Delete A Replication Operation
      description: Removes a specific replication operation. If the operation is currently
        active, it will be cancelled and its resources cleaned up before the operation
        is deleted.
      tags:
      - replication
      operationId: deleteReplication
      parameters:
      - name: id
        in: path
        required: true
        description: The ID of the replication operation to delete.
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Successfully deleted.
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Shard replica operation not found.
        '409':
          description: The operation is not in a deletable state, e.g. it is a MOVE
            op in the DEHYDRATING state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues. Please check the values in your request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '501':
          description: Replica movement operations are disabled.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /replication/replicate/list:
    get:
      summary: Weaviate List Replication Operations
      description: Retrieves a list of currently registered replication operations,
        optionally filtered by collection, shard, or node ID.
      tags:
      - replication
      operationId: listReplication
      parameters:
      - name: targetNode
        in: query
        required: false
        description: The name of the target node to get details for.
        schema:
          type: string
      - name: collection
        in: query
        required: false
        description: The name of the collection to get details for.
        schema:
          type: string
      - name: shard
        in: query
        required: false
        description: The shard to get details for.
        schema:
          type: string
      - name: includeHistory
        in: query
        required: false
        description: Whether to include the history of the replication operation.
        schema:
          type: boolean
      responses:
        '200':
          description: The details of the replication operations.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReplicationReplicateDetailsReplicaResponse'
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '501':
          description: Replica movement operations are disabled.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /replication/replicate/{id}/cancel:
    post:
      summary: Weaviate Cancel A Replication Operation
      description: Requests the cancellation of an active replication operation identified
        by its ID. The operation will be stopped, but its record will remain in the
        `CANCELLED` state (can't be resumed) and will not be automatically deleted.
      tags:
      - replication
      operationId: cancelReplication
      parameters:
      - name: id
        in: path
        required: true
        description: The ID of the replication operation to cancel.
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Successfully cancelled.
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Shard replica operation not found.
        '409':
          description: The operation is not in a cancellable state, e.g. it is READY
            or is a MOVE op in the DEHYDRATING state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues. Please check the values in your request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '501':
          description: Replica movement operations are disabled.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /replication/sharding-state:
    get:
      summary: Weaviate Get Sharding State
      description: Fetches the current sharding state, including replica locations
        and statuses, for all collections or a specified collection. If a shard name
        is provided along with a collection, the state for that specific shard is
        returned.
      tags:
      - replication
      operationId: getCollectionShardingState
      parameters:
      - name: collection
        in: query
        required: false
        description: The collection name to get the sharding state for.
        schema:
          type: string
      - name: shard
        in: query
        required: false
        description: The shard to get the sharding state for.
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved sharding state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReplicationShardingStateResponse'
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Collection or shard not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '501':
          description: Replica movement operations are disabled.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /replication/scale:
    get:
      summary: Weaviate Get Replication Scale Plan
      description: Computes and returns a replication scale plan for a given collection
        and desired replication factor. The plan includes, for each shard, a list
        of nodes to be added and a list of nodes to be removed.
      tags:
      - replication
      operationId: getReplicationScalePlan
      parameters:
      - name: collection
        in: query
        required: true
        description: The collection name to get the scaling plan for.
        schema:
          type: string
      - name: replicationFactor
        in: query
        required: true
        description: The desired replication factor to scale to. Must be a positive
          integer greater than zero.
        schema:
          type: integer
          minimum: 1
      responses:
        '200':
          description: Replication scale plan showing node additions and removals
            per shard.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReplicationScalePlan'
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Collection not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '501':
          description: Replica movement operations are disabled.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    post:
      summary: Weaviate Apply Replication Scaling Plan
      description: Apply a replication scaling plan that specifies nodes to add or
        remove per shard for a given collection.
      tags:
      - replication
      operationId: applyReplicationScalePlan
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReplicationScalePlan'
      responses:
        '200':
          description: List of replication shard copy operation IDs initiated for
            the scale operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReplicationScaleApplyResponse'
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Collection not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '501':
          description: Replica movement operations are disabled.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /users/own-info:
    get:
      summary: Weaviate Get Current User Info
      description: Get information about the currently authenticated user, including
        username and assigned roles.
      tags:
      - users
      operationId: getOwnInfo
      responses:
        '200':
          description: Info about the user.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserOwnInfo'
        '401':
          description: Unauthorized or invalid credentials.
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '501':
          description: Replica movement operations are disabled.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /users/db:
    get:
      summary: Weaviate List All Users
      description: Retrieves a list of all database (`db` user type) users with their
        roles and status information.
      tags:
      - users
      operationId: listAllUsers
      parameters:
      - name: includeLastUsedTime
        in: query
        required: false
        description: Whether to include the last time the users were utilized.
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: Info about the users.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DBUserInfo'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /users/db/{user_id}:
    get:
      summary: Weaviate Get User Info
      description: Retrieve detailed information about a specific database user (`db`
        user type), including their roles, status, and type.
      tags:
      - users
      operationId: getUserInfo
      parameters:
      - name: user_id
        in: path
        required: true
        description: The name of the user.
        schema:
          type: string
      - name: includeLastUsedTime
        in: query
        required: false
        description: Whether to include the last used time of the given user
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: Info about the user.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DBUserInfo'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: User not found.
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues. Please check the values in your request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    post:
      summary: Weaviate Create A New User
      description: Create a new database (`db` user type) user with the specified
        name. Returns an API key for the newly created user.
      tags:
      - users
      operationId: createUser
      parameters:
      - name: user_id
        in: path
        required: true
        description: The name of the user.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                import:
                  type: boolean
                  description: EXPERIMENTAL, DONT USE. THIS WILL BE REMOVED AGAIN.
                    - import api key from static user
                  default: false
                createTime:
                  type: string
                  format: date-time
                  description: EXPERIMENTAL, DONT USE. THIS WILL BE REMOVED AGAIN.
                    - set the given time as creation time
                namespace:
                  type: string
                  description: Namespace to bind the new user to. Required on namespace-enabled
                    clusters. Must be set by a global operator only.
      responses:
        '201':
          description: User created successfully and API key returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserApiKey'
        '400':
          description: Malformed request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: User not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: A user with the specified name already exists.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues. Please check the values in your request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    delete:
      summary: Weaviate Delete A User
      description: Delete a database user. You can't delete your current user.
      tags:
      - users
      operationId: deleteUser
      parameters:
      - name: user_id
        in: path
        required: true
        description: The name of the user.
        schema:
          type: string
      responses:
        '204':
          description: Successfully deleted.
        '400':
          description: Malformed request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: User not found.
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues. Please check the values in your request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /users/db/{user_id}/rotate-key:
    post:
      summary: Weaviate Rotate API Key Of A User
      description: Revoke the current API key for the specified database user (`db`
        user type) and generate a new one.
      tags:
      - users
      operationId: rotateUserApiKey
      parameters:
      - name: user_id
        in: path
        required: true
        description: The name of the user.
        schema:
          type: string
      responses:
        '200':
          description: API key successfully updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserApiKey'
        '400':
          description: Malformed request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: User not found.
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues. Please check the values in your request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /users/db/{user_id}/activate:
    post:
      summary: Weaviate Activate A User
      description: Activate a deactivated database user (`db` user type).
      tags:
      - users
      operationId: activateUser
      parameters:
      - name: user_id
        in: path
        required: true
        description: The name of the user.
        schema:
          type: string
      responses:
        '200':
          description: User successfully activated.
        '400':
          description: Malformed request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: User not found.
        '409':
          description: User already activated.
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues. Please check the values in your request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /users/db/{user_id}/deactivate:
    post:
      summary: Weaviate Deactivate A User
      description: Deactivate a database user (`db` user type).
      tags:
      - users
      operationId: deactivateUser
      parameters:
      - name: user_id
        in: path
        required: true
        description: The name of the user.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                revoke_key:
                  type: boolean
                  description: Whether the API key should be revoked when deactivating
                    the user.
                  default: false
      responses:
        '200':
          description: User successfully deactivated.
        '400':
          description: Malformed request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: User not found.
        '409':
          description: User already deactivated.
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues. Please check the values in your request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /authz/roles:
    get:
      summary: Weaviate Get All Roles
      description: Get all roles and their assigned permissions.
      tags:
      - authz
      operationId: getRoles
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RolesListResponse'
        '400':
          description: Malformed request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    post:
      summary: Weaviate Create New Role
      description: Create a new role with the specified permissions.
      tags:
      - authz
      operationId: createRole
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Role'
      responses:
        '201':
          description: Role created successfully.
        '400':
          description: Malformed request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Role already exists.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues. Please check the values in your request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /authz/roles/{id}/add-permissions:
    post:
      summary: Weaviate Add Permissions To A Role
      description: Add new permissions to an existing role without affecting current
        permissions.
      tags:
      - authz
      operationId: addPermissions
      parameters:
      - name: id
        in: path
        required: true
        description: The name (ID) of the role being modified.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              - permissions
              properties:
                permissions:
                  type: array
                  description: Permissions to be added to the role.
                  items:
                    $ref: '#/components/schemas/Permission'
      responses:
        '200':
          description: Permissions added successfully.
        '400':
          description: Malformed request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: No role found.
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues. Please check the values in your request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /authz/roles/{id}/remove-permissions:
    post:
      summary: Weaviate Remove Permissions From A Role
      description: Permissions can be revoked from a specified role. Removing all
        permissions from a role will delete the role itself.
      tags:
      - authz
      operationId: removePermissions
      parameters:
      - name: id
        in: path
        required: true
        description: The name of the role being modified.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - permissions
              properties:
                permissions:
                  type: array
                  description: Permissions to remove from the role.
                  items:
                    $ref: '#/components/schemas/Permission'
      responses:
        '200':
          description: Permissions removed successfully.
        '400':
          description: Malformed request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: No role found.
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues. Please check the values in your request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /authz/roles/{id}:
    get:
      summary: Weaviate Get A Role
      description: Fetch a role by its name.
      tags:
      - authz
      operationId: getRole
      parameters:
      - name: id
        in: path
        required: true
        description: The name of the role.
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Role'
        '400':
          description: Malformed request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: No role found.
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    delete:
      summary: Weaviate Delete A Role
      description: Deleting a role will remove it from the system, and revoke the
        associated permissions from all users who had this role.
      tags:
      - authz
      operationId: deleteRole
      parameters:
      - name: id
        in: path
        required: true
        description: The name of the role.
        schema:
          type: string
      responses:
        '204':
          description: Successfully deleted.
        '400':
          description: Malformed request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /authz/roles/{id}/has-permission:
    post:
      summary: Weaviate Check Whether A Role Possesses A Permission
      description: Check whether a role has the specified permissions.
      tags:
      - authz
      operationId: hasPermission
      parameters:
      - name: id
        in: path
        required: true
        description: The name of the role.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Permission'
      responses:
        '200':
          description: Permission check was successful.
          content:
            application/json:
              schema:
                type: boolean
        '400':
          description: Malformed request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues. Please check the values in your request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /authz/roles/{id}/users:
    get:
      summary: Weaviate Get Users Assigned To A Role
      description: Get all the users (`db` + `oidc`) who have been assigned a specific
        role. Deprecated, will be removed when v1.29 is not supported anymore.
      tags:
      - authz
      operationId: getUsersForRoleDeprecated
      parameters:
      - name: id
        in: path
        required: true
        description: The name of the role.
        schema:
          type: string
      responses:
        '200':
          description: Users assigned to this role.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
        '400':
          description: Malformed request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: No role found.
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /authz/roles/{id}/user-assignments:
    get:
      summary: Weaviate Get Users Assigned To A Role
      description: Fetch a list of users which have the specified role.
      tags:
      - authz
      operationId: getUsersForRole
      parameters:
      - name: id
        in: path
        required: true
        description: The name (ID) of the role.
        schema:
          type: string
      responses:
        '200':
          description: Users assigned to this role.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  required:
                  - name
                  - userType
                  properties:
                    userId:
                      type: string
                    userType:
                      $ref: '#/components/schemas/UserTypeOutput'
        '400':
          description: Malformed request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: No role found.
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /authz/roles/{id}/group-assignments:
    get:
      summary: Weaviate Get Groups That Have A Specific Role Assigned
      description: Retrieves a list of all groups that have been assigned a specific
        role, identified by its name.
      tags:
      - authz
      operationId: getGroupsForRole
      parameters:
      - name: id
        in: path
        required: true
        description: The unique name of the role.
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the list of groups that have the role
            assigned.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  required:
                  - name
                  - groupType
                  properties:
                    groupId:
                      type: string
                    groupType:
                      $ref: '#/components/schemas/GroupType'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: The specified role was not found.
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /authz/users/{id}/roles:
    get:
      summary: Weaviate Get Roles Assigned To A User
      description: Retrieve the roles assigned to a specific user (`db` + `oidc`).
        Deprecated, will be removed when 1.29 is not supported anymore
      tags:
      - authz
      operationId: getRolesForUserDeprecated
      parameters:
      - name: id
        in: path
        required: true
        description: The name of the user.
        schema:
          type: string
      responses:
        '200':
          description: Roles assigned to the user.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RolesListResponse'
        '400':
          description: Malformed request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: No roles found for specified user.
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues. Please check the values in your request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /authz/users/{id}/roles/{userType}:
    get:
      summary: Weaviate Get Roles Assigned To A User
      description: Get all the roles for a specific user (`db` or `oidc`).
      tags:
      - authz
      operationId: getRolesForUser
      parameters:
      - name: id
        in: path
        required: true
        description: The name of the user.
        schema:
          type: string
      - name: userType
        in: path
        required: true
        description: The type of the user.
        schema:
          type: string
          enum:
          - oidc
          - db
      - name: includeFullRoles
        in: query
        required: false
        description: Whether to include detailed role information like its assigned
          permissions.
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: Roles assigned to the user.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RolesListResponse'
        '400':
          description: Malformed request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: No roles found for specified user.
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues. Please check the values in your request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /authz/users/{id}/assign:
    post:
      summary: Weaviate Assign A Role To A User
      description: Assign one or more roles to a user. Users can have multiple roles.
      tags:
      - authz
      operationId: assignRoleToUser
      parameters:
      - name: id
        in: path
        required: true
        description: The name of the user.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                roles:
                  type: array
                  description: The roles that are assigned to the specified user.
                  items:
                    type: string
                userType:
                  $ref: '#/components/schemas/UserTypeInput'
      responses:
        '200':
          description: Role assigned successfully.
        '400':
          description: Malformed request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Specified role or user not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /authz/users/{id}/revoke:
    post:
      summary: Weaviate Revoke A Role From A User
      description: Remove one or more roles from a user.
      tags:
      - authz
      operationId: revokeRoleFromUser
      parameters:
      - name: id
        in: path
        required: true
        description: The name of the user.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                roles:
                  type: array
                  description: The roles to revoke from the specified user.
                  items:
                    type: string
                userType:
                  $ref: '#/components/schemas/UserTypeInput'
      responses:
        '200':
          description: Roles revoked successfully.
        '400':
          description: Malformed request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Specified role or user not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /authz/groups/{id}/assign:
    post:
      summary: Weaviate Assign A Role To A Group
      description: Assign roles to the specified group.
      tags:
      - authz
      operationId: assignRoleToGroup
      parameters:
      - name: id
        in: path
        required: true
        description: The name of the group.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                roles:
                  type: array
                  description: The roles to assign to the specified group.
                  items:
                    type: string
                groupType:
                  $ref: '#/components/schemas/GroupType'
      responses:
        '200':
          description: Roles assigned successfully.
        '400':
          description: Malformed request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Role or group not found.
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /authz/groups/{id}/revoke:
    post:
      summary: Weaviate Revoke A Role From A Group
      description: Revoke roles from the specified group.
      tags:
      - authz
      operationId: revokeRoleFromGroup
      parameters:
      - name: id
        in: path
        required: true
        description: The name of the group.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                roles:
                  type: array
                  description: The roles to revoke from the specified group.
                  items:
                    type: string
                groupType:
                  $ref: '#/components/schemas/GroupType'
      responses:
        '200':
          description: Roles revoked successfully.
        '400':
          description: Malformed request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Role or group not found.
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /authz/groups/{id}/roles/{groupType}:
    get:
      summary: Weaviate Get Roles Assigned To A Specific Group
      description: Retrieves a list of all roles assigned to a specific group. The
        group must be identified by both its name (`id`) and its type (`db` or `oidc`).
      tags:
      - authz
      operationId: getRolesForGroup
      parameters:
      - name: id
        in: path
        required: true
        description: The unique name of the group.
        schema:
          type: string
      - name: groupType
        in: path
        required: true
        description: The type of the group.
        schema:
          type: string
          enum:
          - oidc
      - name: includeFullRoles
        in: query
        required: false
        description: If true, the response will include the full role definitions
          with all associated permissions. If false, only role names are returned.
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: A list of roles assigned to the specified group.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RolesListResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: The specified group was not found.
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues. Please check the values in your request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /authz/groups/{groupType}:
    get:
      summary: Weaviate List All Groups Of A Specific Type
      description: Retrieves a list of all available group names for a specified group
        type (`oidc` or `db`).
      tags:
      - authz
      operationId: getGroups
      parameters:
      - name: groupType
        in: path
        required: true
        description: The type of group to retrieve.
        schema:
          type: string
          enum:
          - oidc
      responses:
        '200':
          description: A list of group names for the specified type.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues. Please check the values in your request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /objects:
    get:
      summary: Weaviate List Objects
      description: Retrieves a list of data objects. By default, objects are returned
        in reverse order of creation. Requires a collection name (`class`) parameter
        to specify which collection's objects to list, otherwise, returns an empty
        list.
      tags:
      - objects
      operationId: objects.list
      parameters:
      - name: after
        in: query
        required: false
        description: A threshold UUID of the objects to retrieve after, using an UUID-based
          ordering. This object is not part of the set. <br/><br/>Must be used with
          collection name (`class`), typically in conjunction with `limit`. <br/><br/>Note
          `after` cannot be used with `offset` or `sort`. <br/><br/>For a null value
          similar to offset=0, set an empty string in the request, i.e. `after=` or
          `after`.
        schema:
          type: string
      - name: offset
        in: query
        required: false
        description: The starting index of the result window. Note `offset` will retrieve
          `offset+limit` results and return `limit` results from the object with index
          `offset` onwards. Limited by the value of `QUERY_MAXIMUM_RESULTS`. <br/><br/>Should
          be used in conjunction with `limit`. <br/><br/>Cannot be used with `after`.
        schema:
          type: integer
          format: int64
          default: 0
      - name: limit
        in: query
        required: false
        description: The maximum number of items to be returned per page. The default
          is 25 unless set otherwise as an environment variable.
        schema:
          type: integer
          format: int64
      - name: include
        in: query
        required: false
        description: 'Include additional information, such as classification information.
          Allowed values include: `classification`, `vector` and `interpretation`.'
        schema:
          type: string
      - name: sort
        in: query
        required: false
        description: Name(s) of the property to sort by - e.g. `city`, or `country,city`.
        schema:
          type: string
      - name: order
        in: query
        required: false
        description: 'Order parameter to tell how to order (asc or desc) data within
          given field. Should be used in conjunction with `sort` parameter. If providing
          multiple `sort` values, provide multiple `order` values in corresponding
          order, e.g.: `sort=author_name,title&order=desc,asc`.'
        schema:
          type: string
      - name: class
        in: query
        required: false
        description: The collection from which to query objects.  <br/><br/>Note that
          if the collection name (`class`) is not provided, the response will not
          include any objects.
        schema:
          type: string
      - name: tenant
        in: query
        required: false
        description: Specifies the tenant in a request targeting a multi-tenant collection
          (class).
        schema:
          type: string
      responses:
        '200':
          description: Successful response containing the list of objects. If the
            collection name (`class`) is not provided, the response will not include
            any objects.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectsListResponse'
        '400':
          description: Malformed request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Successful query result but no matching objects were found.
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues. Please check the values in your request. Ensure
            the specified collection exists.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error occurred while trying to fulfill the request. Check
            the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    post:
      summary: Weaviate Create An Object
      description: Creates a new data object. The object's metadata and schema values
        are validated before creation.<br/><br/>**Note (batch import)**:<br/>If you
        plan on importing a large number of objects, using the `/batch/objects` endpoint
        is significantly more efficient than sending multiple single requests.<br/><br/>**Note
        (idempotence)**:<br/>This operation (POST) fails if an object with the provided
        ID already exists. To update an existing object, use the PUT or PATCH methods.
      tags:
      - objects
      operationId: objects.create
      parameters:
      - name: consistency_level
        in: query
        required: false
        description: Determines how many replicas must acknowledge a request before
          it is considered successful.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Object'
      responses:
        '200':
          description: Object created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Object'
        '400':
          description: Malformed request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues. Please check the values in your request. Ensure
            the collection exists and the object properties are valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error occurred while trying to fulfill the request. Check
            the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /objects/{id}:
    delete:
      summary: Weaviate Delete An Object
      description: 'Deletes an object from the database based on its UUID. <br/><br/>**Note**:
        This endpoint is deprecated and will be removed in a future version. Use the
        `/objects/{className}/{id}` endpoint instead.'
      tags:
      - objects
      operationId: objects.delete
      parameters:
      - name: id
        in: path
        required: true
        description: Unique UUID of the object to be deleted.
        schema:
          type: string
          format: uuid
      - name: consistency_level
        in: query
        required: false
        description: Determines how many replicas must acknowledge a request before
          it is considered successful.
        schema:
          type: string
      - name: tenant
        in: query
        required: false
        description: Specifies the tenant in a request targeting a multi-tenant collection
          (class).
        schema:
          type: string
      responses:
        '204':
          description: Object deleted successfully.
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Object not found.
        '500':
          description: An error occurred while trying to fulfill the request. Check
            the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    get:
      summary: Weaviate Get An Object
      description: 'Get a specific object based on its UUID. Also available as Websocket
        bus. <br/><br/>**Note**: This endpoint is deprecated and will be removed in
        a future version. Use the `/objects/{className}/{id}` endpoint instead.'
      tags:
      - objects
      operationId: objects.get
      parameters:
      - name: id
        in: path
        required: true
        description: Unique UUID of the object to be retrieved.
        schema:
          type: string
          format: uuid
      - name: include
        in: query
        required: false
        description: 'Include additional information, such as classification information.
          Allowed values include: `classification`, `vector` and `interpretation`.'
        schema:
          type: string
      responses:
        '200':
          description: Successful response containing the object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Object'
        '400':
          description: Malformed request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Object not found.
        '500':
          description: An error occurred while trying to fulfill the request. Check
            the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    patch:
      summary: Weaviate Patch An Object
      description: 'Update an object based on its UUID (using patch semantics). This
        method supports json-merge style patch semantics (RFC 7396). Provided meta-data
        and schema values are validated. `lastUpdateTimeUnix` is set to the time this
        function is called. <br/><br/>**Note**: This endpoint is deprecated and will
        be removed in a future version. Use the `/objects/{className}/{id}` endpoint
        instead.'
      tags:
      - objects
      operationId: objects.patch
      parameters:
      - name: id
        in: path
        required: true
        description: Unique UUID of the object to be patched.
        schema:
          type: string
          format: uuid
      - name: consistency_level
        in: query
        required: false
        description: Determines how many replicas must acknowledge a request before
          it is considered successful.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Object'
      responses:
        '204':
          description: Object patched successfully.
        '400':
          description: Malformed patch request body.
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Object not found.
        '422':
          description: The patch object is valid JSON but is unprocessable for other
            reasons (e.g., invalid schema).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error occurred while trying to fulfill the request. Check
            the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    put:
      summary: Weaviate Update An Object
      description: 'Updates an object based on its UUID. Given meta-data and schema
        values are validated. `lastUpdateTimeUnix` is set to the time this function
        is called. <br/><br/>**Note**: This endpoint is deprecated and will be removed
        in a future version. Use the `/objects/{className}/{id}` endpoint instead.'
      tags:
      - objects
      operationId: objects.update
      parameters:
      - name: id
        in: path
        required: true
        description: Unique UUID of the object to be replaced.
        schema:
          type: string
          format: uuid
      - name: consistency_level
        in: query
        required: false
        description: Determines how many replicas must acknowledge a request before
          it is considered successful.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Object'
      responses:
        '200':
          description: Object replaced successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Object'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Object not found.
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues. Please check the values in your request. Ensure
            the collection exists and the object properties are valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error occurred while trying to fulfill the request. Check
            the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    head:
      summary: Weaviate Check If An Object Exists
      description: 'Checks if an object exists in the system based on its UUID. <br/><br/>**Note**:
        This endpoint is deprecated and will be removed in a future version. Use the
        `/objects/{className}/{id}` endpoint instead.'
      tags:
      - objects
      operationId: objects.head
      parameters:
      - name: id
        in: path
        required: true
        description: Unique UUID of the object to check.
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Object exists.
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Object does not exist.
        '500':
          description: An error occurred while trying to fulfill the request. Check
            the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /objects/{className}/{id}:
    get:
      summary: Weaviate Get An Object
      description: Get a data object based on its collection name (`className`) and
        UUID (`id`).
      tags:
      - objects
      operationId: objects.class.get
      parameters:
      - name: className
        in: path
        required: true
        description: Name of the collection (class) the object belongs to.
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: Unique UUID of the object to be retrieved.
        schema:
          type: string
          format: uuid
      - name: include
        in: query
        required: false
        description: 'Include additional information, such as classification information.
          Allowed values include: `classification`, `vector` and `interpretation`.'
        schema:
          type: string
      - name: consistency_level
        in: query
        required: false
        description: Determines how many replicas must acknowledge a request before
          it is considered successful.
        schema:
          type: string
      - name: node_name
        in: query
        required: false
        description: The target node which should fulfill the request.
        schema:
          type: string
      - name: tenant
        in: query
        required: false
        description: Specifies the tenant in a request targeting a multi-tenant collection
          (class).
        schema:
          type: string
      responses:
        '200':
          description: Successful response containing the object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Object'
        '400':
          description: Malformed request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Object not found.
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues. Please check the values in your request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error occurred while trying to fulfill the request. Check
            the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    delete:
      summary: Weaviate Delete An Object
      description: Removes a data object from a specific collection, identified by
        its collection name (`className`) and UUID (`id`).<br/><br/>**Note on deleting
        references (legacy format):**<br/>For backward compatibility with older beacon
        formats (lacking a collection name), deleting a reference requires the beacon
        in the request to exactly match the stored format. Beacons always use `localhost`
        as the host, indicating the target is within the same Weaviate instance.
      tags:
      - objects
      operationId: objects.class.delete
      parameters:
      - name: className
        in: path
        required: true
        description: Name of the collection (class) the object belongs to.
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: Unique UUID of the object to be deleted.
        schema:
          type: string
          format: uuid
      - name: consistency_level
        in: query
        required: false
        description: Determines how many replicas must acknowledge a request before
          it is considered successful.
        schema:
          type: string
      - name: tenant
        in: query
        required: false
        description: Specifies the tenant in a request targeting a multi-tenant collection
          (class).
        schema:
          type: string
      responses:
        '204':
          description: Object deleted successfully.
        '400':
          description: Malformed request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Object not found.
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues. Please check the values in your request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error occurred while trying to fulfill the request. Check
            the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    put:
      summary: Weaviate Replace An Object
      description: Replaces properties of an existing data object. The object is identified
        by its collection name (`className`) and UUID (`id`). The request body must
        contain the complete object definition with the new property values.
      tags:
      - objects
      operationId: objects.class.put
      parameters:
      - name: className
        in: path
        required: true
        description: Name of the collection (class) the object belongs to.
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: Unique UUID of the object to be replaced.
        schema:
          type: string
          format: uuid
      - name: consistency_level
        in: query
        required: false
        description: Determines how many replicas must acknowledge a request before
          it is considered successful.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Object'
      responses:
        '200':
          description: Object replaced successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Object'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Object not found.
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues. Please check the values in your request. Ensure
            the collection exists and the object properties are valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error occurred while trying to fulfill the request. Check
            the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    patch:
      summary: Weaviate Patch An Object
      description: Updates specific properties of an existing data object using JSON
        merge patch semantics (RFC 7396). The object is identified by its collection
        name (`className`) and UUID (`id`). Only the fields provided in the request
        body are modified. Metadata and schema values are validated, and the object's
        `lastUpdateTimeUnix` is updated.
      tags:
      - objects
      operationId: objects.class.patch
      parameters:
      - name: className
        in: path
        required: true
        description: Name of the collection (class) the object belongs to.
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: Unique UUID of the object to be patched.
        schema:
          type: string
          format: uuid
      - name: consistency_level
        in: query
        required: false
        description: Determines how many replicas must acknowledge a request before
          it is considered successful.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Object'
      responses:
        '204':
          description: Object patched successfully.
        '400':
          description: Malformed patch request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Object not found.
        '422':
          description: The patch object is valid JSON but is unprocessable for other
            reasons (e.g., invalid schema).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error occurred while trying to fulfill the request. Check
            the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    head:
      summary: Weaviate Check If An Object Exists
      description: Verifies the existence of a specific data object within a collection
        (class), identified by its collection name (`className`) and UUID (`id`),
        without returning the object itself.<br/><br/>This is faster than a GET request
        as it avoids retrieving and processing object data. Existence is confirmed
        by a 204 No Content status code, while non-existence results in a 404 Not
        Found.
      tags:
      - objects
      operationId: objects.class.head
      parameters:
      - name: className
        in: path
        required: true
        description: Name of the collection (class) the object belongs to.
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: Unique UUID of the object to check.
        schema:
          type: string
          format: uuid
      - name: consistency_level
        in: query
        required: false
        description: Determines how many replicas must acknowledge a request before
          it is considered successful.
        schema:
          type: string
      - name: tenant
        in: query
        required: false
        description: Specifies the tenant in a request targeting a multi-tenant collection
          (class).
        schema:
          type: string
      responses:
        '204':
          description: Object exists.
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Object does not exist.
        '422':
          description: Invalid data provided. Please check the values in your request
            (e.g., invalid UUID format).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error occurred while trying to fulfill the request. Check
            the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /objects/{id}/references/{propertyName}:
    post:
      summary: Weaviate Add An Object Reference
      description: 'Add a reference to a specific property of a data object. <br/><br/>**Note**:
        This endpoint is deprecated and will be removed in a future version. Use the
        `/objects/{className}/{id}/references/{propertyName}` endpoint instead.'
      tags:
      - objects
      operationId: objects.references.create
      parameters:
      - name: id
        in: path
        required: true
        description: Unique UUID of the source object.
        schema:
          type: string
          format: uuid
      - name: propertyName
        in: path
        required: true
        description: Unique name of the reference property of the source object.
        schema:
          type: string
      - name: tenant
        in: query
        required: false
        description: Specifies the tenant in a request targeting a multi-tenant collection
          (class).
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SingleRef'
      responses:
        '200':
          description: Reference added successfully.
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues. Please check the values in your request. Ensure
            the property exists and is a reference type.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error occurred while trying to fulfill the request. Check
            the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    put:
      summary: Weaviate Replace Object References
      description: 'Replace all references in cross-reference property of an object.
        <br/><br/>**Note**: This endpoint is deprecated and will be removed in a future
        version. Use the `/objects/{className}/{id}/references/{propertyName}` endpoint
        instead.'
      tags:
      - objects
      operationId: objects.references.update
      parameters:
      - name: id
        in: path
        required: true
        description: Unique UUID of the source object.
        schema:
          type: string
          format: uuid
      - name: propertyName
        in: path
        required: true
        description: Unique name of the reference property of the source object.
        schema:
          type: string
      - name: tenant
        in: query
        required: false
        description: Specifies the tenant in a request targeting a multi-tenant collection
          (class).
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MultipleRef'
      responses:
        '200':
          description: References replaced successfully.
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues. Please check the values in your request. Ensure
            the property exists and is a reference type.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error occurred while trying to fulfill the request. Check
            the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    delete:
      summary: Weaviate Delete An Object Reference
      description: 'Delete the single reference that is given in the body from the
        list of references that this property has. <br/><br/>**Note**: This endpoint
        is deprecated and will be removed in a future version. Use the `/objects/{className}/{id}/references/{propertyName}`
        endpoint instead.'
      tags:
      - objects
      operationId: objects.references.delete
      parameters:
      - name: id
        in: path
        required: true
        description: Unique UUID of the source object.
        schema:
          type: string
          format: uuid
      - name: propertyName
        in: path
        required: true
        description: Unique name of the reference property of the source object.
        schema:
          type: string
      - name: tenant
        in: query
        required: false
        description: Specifies the tenant in a request targeting a multi-tenant collection
          (class).
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SingleRef'
      responses:
        '204':
          description: Reference deleted successfully.
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Object or reference not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error occurred while trying to fulfill the request. Check
            the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /objects/{className}/{id}/references/{propertyName}:
    post:
      summary: Weaviate Add An Object Reference
      description: Adds a new reference to a reference property (`propertyName`) on
        a source data object. The source object is identified by its collection name
        (`className`) and UUID (`id`). The reference to add is specified in the request
        body.
      tags:
      - objects
      operationId: objects.class.references.create
      parameters:
      - name: className
        in: path
        required: true
        description: Name of the collection (class) the source object belongs to.
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: Unique UUID of the source object.
        schema:
          type: string
          format: uuid
      - name: propertyName
        in: path
        required: true
        description: Unique name of the reference property of the source object.
        schema:
          type: string
      - name: consistency_level
        in: query
        required: false
        description: Determines how many replicas must acknowledge a request before
          it is considered successful.
        schema:
          type: string
      - name: tenant
        in: query
        required: false
        description: Specifies the tenant in a request targeting a multi-tenant collection
          (class).
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SingleRef'
      responses:
        '200':
          description: Reference added successfully.
        '400':
          description: Malformed request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Source object not found.
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues. Please check the values in your request. Ensure
            the property exists and is a reference type.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error occurred while trying to fulfill the request. Check
            the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    put:
      summary: Weaviate Replace Object References
      description: Replaces all existing references for a specific reference property
        (`propertyName`) on a source data object. The source object is identified
        by its collection name (`className`) and UUID (`id`). The new set of references
        is provided in the request body.
      tags:
      - objects
      operationId: objects.class.references.put
      parameters:
      - name: className
        in: path
        required: true
        description: Name of the collection (class) the source object belongs to.
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: Unique UUID of the source object.
        schema:
          type: string
          format: uuid
      - name: propertyName
        in: path
        required: true
        description: Unique name of the reference property of the source object.
        schema:
          type: string
      - name: consistency_level
        in: query
        required: false
        description: Determines how many replicas must acknowledge a request before
          it is considered successful.
        schema:
          type: string
      - name: tenant
        in: query
        required: false
        description: Specifies the tenant in a request targeting a multi-tenant collection
          (class).
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MultipleRef'
      responses:
        '200':
          description: References replaced successfully.
        '400':
          description: Malformed request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Source object not found.
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues. Please check the values in your request. Ensure
            the property exists and is a reference type.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error occurred while trying to fulfill the request. Check
            the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    delete:
      summary: Weaviate Delete An Object Reference
      description: Removes a specific reference from a reference property (`propertyName`)
        of a source data object. The source object is identified by its collection
        name (`className`) and UUID (`id`). The reference to remove is specified in
        the request body.
      tags:
      - objects
      operationId: objects.class.references.delete
      parameters:
      - name: className
        in: path
        required: true
        description: Name of the collection (class) the source object belongs to.
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: Unique UUID of the source object.
        schema:
          type: string
          format: uuid
      - name: propertyName
        in: path
        required: true
        description: Unique name of the reference property of the source object.
        schema:
          type: string
      - name: consistency_level
        in: query
        required: false
        description: Determines how many replicas must acknowledge a request before
          it is considered successful.
        schema:
          type: string
      - name: tenant
        in: query
        required: false
        description: Specifies the tenant in a request targeting a multi-tenant collection
          (class).
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SingleRef'
      responses:
        '204':
          description: Reference deleted successfully.
        '400':
          description: Malformed request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Object or reference not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues. Please check the values in your request. Ensure
            the property exists and is a reference type.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error occurred while trying to fulfill the request. Check
            the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /objects/validate:
    post:
      summary: Weaviate Validate An Object
      description: Checks if a data object's structure conforms to the specified collection
        schema and metadata rules without actually storing the object.<br/><br/>A
        successful validation returns a 200 OK status code with no body. If validation
        fails, an error response with details is returned.
      tags:
      - objects
      operationId: objects.validate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Object'
      responses:
        '200':
          description: Object is valid according to the schema.
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Request body is well-formed but the object is invalid according
            to the schema.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error occurred while trying to fulfill the request. Check
            the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /batch/objects:
    post:
      summary: Weaviate Create Objects In Batch
      description: Registers multiple data objects in a single request for efficiency.
        Metadata and schema values for each object are validated.<br/><br/>**Note
        (idempotence)**:<br/>This operation is idempotent based on the object UUIDs
        provided. If an object with a given UUID already exists, it will be overwritten
        (similar to a PUT operation for that specific object within the batch).
      tags:
      - batch
      - objects
      operationId: batch.objects.create
      parameters:
      - name: consistency_level
        in: query
        required: false
        description: Determines how many replicas must acknowledge a request before
          it is considered successful.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                fields:
                  type: array
                  description: Controls which fields are returned in the response
                    for each object. Default is `ALL`.
                  items:
                    type: string
                    enum:
                    - ALL
                    - class
                    - schema
                    - id
                    - creationTimeUnix
                    default: ALL
                objects:
                  type: array
                  description: Array of objects to be created.
                  items:
                    $ref: '#/components/schemas/Object'
      responses:
        '200':
          description: Request processed successfully. Individual object statuses
            are provided in the response body.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ObjectsGetResponse'
        '400':
          description: Malformed request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues. Please check the values in your request. Ensure
            the collection exists and the object properties are valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error occurred while trying to fulfill the request. Check
            the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    delete:
      summary: Weaviate Delete Objects In Batch
      description: Removes multiple data objects based on a filter specified in the
        request body.<br/><br/>Deletion occurs based on the filter criteria provided
        in the `where` clause. There is a configurable limit (default 10,000, set
        via `QUERY_MAXIMUM_RESULTS`) on how many objects can be deleted in a single
        batch request to prevent excessive resource usage. Objects are deleted in
        the order they match the filter. To delete more objects than the limit allows,
        repeat the request until no more matching objects are found.
      tags:
      - batch
      - objects
      operationId: batch.objects.delete
      parameters:
      - name: consistency_level
        in: query
        required: false
        description: Determines how many replicas must acknowledge a request before
          it is considered successful.
        schema:
          type: string
      - name: tenant
        in: query
        required: false
        description: Specifies the tenant in a request targeting a multi-tenant collection
          (class).
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchDelete'
      responses:
        '200':
          description: Request processed successfully. See response body for matching
            objects and deletion results.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchDeleteResponse'
        '400':
          description: Malformed request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Invalid data provided. Please check the values in your request
            (e.g., invalid filter).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error occurred while trying to fulfill the request. Check
            the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /batch/references:
    post:
      summary: Weaviate Create Cross-References In Bulk
      description: Batch create cross-references between collection items in bulk.
      tags:
      - batch
      - references
      operationId: batch.references.create
      parameters:
      - name: consistency_level
        in: query
        required: false
        description: Determines how many replicas must acknowledge a request before
          it is considered successful.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/BatchReference'
      responses:
        '200':
          description: 'Request Successful. Warning: A successful request does not
            guarantee that every batched reference was successfully created. Inspect
            the response body to see which references succeeded and which failed.'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BatchReferenceResponse'
        '400':
          description: Malformed request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues. Please check the values in your request. Ensure
            the collection exists and the object properties are valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /graphql:
    post:
      summary: Weaviate Perform A GraphQL Query
      description: Executes a single GraphQL query provided in the request body. Use
        this endpoint for all Weaviate data queries and exploration.
      tags:
      - graphql
      operationId: graphql.post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GraphQLQuery'
      responses:
        '200':
          description: Query executed successfully. The response body contains the
            query result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphQLResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues. Please check the values in your request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An internal server error occurred during query execution. Check
            the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /graphql/batch:
    post:
      summary: Weaviate Perform Batched GraphQL Queries
      description: Executes multiple GraphQL queries provided in the request body
        as an array. Allows performing several queries in a single network request
        for efficiency.
      tags:
      - graphql
      operationId: graphql.batch
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GraphQLQueries'
      responses:
        '200':
          description: Batch request processed successfully. The response body contains
            an array of results corresponding to the input queries.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphQLResponses'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues. Please check the values in your request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An internal server error occurred during batch query execution.
            Check the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /meta:
    get:
      summary: Weaviate Get Instance Metadata
      description: Provides meta-information about the running Weaviate instance,
        including its version, loaded modules, and network hostname. This information
        can be useful for monitoring, compatibility checks, or inter-instance communication.
      tags:
      - meta
      operationId: meta.get
      responses:
        '200':
          description: Successfully retrieved meta information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Meta'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An internal server error occurred while retrieving meta information.
            Check the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /tokenize:
    post:
      summary: Weaviate Tokenize Text
      description: Tokenizes the provided text using the specified tokenization method.
        This is a stateless utility endpoint useful for debugging and understanding
        how text will be processed during indexing and querying. The response includes
        both the indexed tokens (as stored in the inverted index) and query tokens
        (after optional stopword removal).
      tags:
      - tokenize
      operationId: tokenize
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TokenizeRequest'
      responses:
        '200':
          description: Successfully tokenized the text.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TokenizeResponse'
        '400':
          description: Invalid or malformed request body.
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Request binding or validation error. Check the ErrorResponse
            for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An unexpected error occurred while tokenizing the text. Check
            the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /schema:
    get:
      summary: Weaviate Get All Collection Definitions
      description: Retrieves the definitions of all collections (classes) currently
        in the database schema.
      tags:
      - schema
      operationId: schema.dump
      parameters:
      - name: consistency
        in: header
        required: false
        description: If true, the request is proxied to the cluster leader to ensure
          strong schema consistency. Default is true.
        schema:
          type: boolean
          default: true
      responses:
        '200':
          description: Successfully retrieved the database schema.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Schema'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error occurred while retrieving the schema. Check the ErrorResponse
            for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    post:
      summary: Weaviate Create A New Collection
      description: Defines and creates a new collection (class).<br/><br/>If [`AutoSchema`](https://docs.weaviate.io/weaviate/config-refs/collections#auto-schema)
        is enabled (not recommended for production), Weaviate might attempt to infer
        schema from data during import. Manual definition via this endpoint provides
        explicit control.
      tags:
      - schema
      operationId: schema.objects.create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Class'
      responses:
        '200':
          description: Collection created successfully and its definition returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Class'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Invalid collection definition provided. Check the definition
            structure and properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error occurred during collection creation. Check the ErrorResponse
            for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /schema/{className}:
    get:
      summary: Weaviate Get A Single Collection
      description: Retrieve the definition of a specific collection (`className`),
        including its properties, configuration, and vectorizer settings.
      tags:
      - schema
      operationId: schema.objects.get
      parameters:
      - name: className
        in: path
        required: true
        description: The name of the collection (class) to retrieve.
        schema:
          type: string
      - name: consistency
        in: header
        required: false
        description: If true, the request is proxied to the cluster leader to ensure
          strong schema consistency. Default is true.
        schema:
          type: boolean
          default: true
      responses:
        '200':
          description: Successfully retrieved the collection definition.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Class'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Collection not found.
        '500':
          description: An error occurred while retrieving the collection definition.
            Check the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    delete:
      summary: Weaviate Delete A Collection (And All Associated Data)
      description: 'Removes a collection definition from the schema. WARNING: This
        action permanently deletes all data objects stored within the collection.'
      tags:
      - schema
      operationId: schema.objects.delete
      parameters:
      - name: className
        in: path
        required: true
        description: The name of the collection (class) to delete.
        schema:
          type: string
      responses:
        '200':
          description: Collection deleted successfully.
        '400':
          description: Could not delete the collection. See the error response for
            details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error occurred during collection deletion. Check the ErrorResponse
            for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    put:
      summary: Weaviate Update Collection Definition
      description: 'Updates the configuration settings of an existing collection (`className`)
        based on the provided definition. Note: This operation modifies mutable settings
        specified in the request body. It does not add properties (use `POST /schema/{className}/properties`
        for that) or change the collection name.'
      tags:
      - schema
      operationId: schema.objects.update
      parameters:
      - name: className
        in: path
        required: true
        description: The name of the collection (class) to update.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Class'
      responses:
        '200':
          description: Collection settings updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Class'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Collection not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Invalid update attempt.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error occurred while updating the collection. Check the
            ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /schema/{className}/properties:
    post:
      summary: Weaviate Add A Property To A Collection
      description: Adds a new property definition to an existing collection (`className`)
        definition.
      tags:
      - schema
      operationId: schema.objects.properties.add
      parameters:
      - name: className
        in: path
        required: true
        description: The name of the collection (class) to add the property to.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Property'
      responses:
        '200':
          description: Property added successfully and its definition returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Property'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Invalid property definition provided.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error occurred while adding the property. Check the ErrorResponse
            for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /schema/{className}/properties/{propertyName}/index/{indexName}:
    delete:
      summary: Weaviate Delete A Property'S Inverted Index
      description: Deletes an inverted index of a specific property within a collection
        (`className`). The index to delete is identified by `indexName` and must be
        one of `filterable`, `searchable`, or `rangeFilters`.
      tags:
      - schema
      operationId: schema.objects.properties.delete
      parameters:
      - name: className
        in: path
        required: true
        description: The name of the collection (class) containing the property.
        schema:
          type: string
      - name: propertyName
        in: path
        required: true
        description: The name of the property whose inverted index should be deleted.
        schema:
          type: string
      - name: indexName
        in: path
        required: true
        description: The name of the inverted index to delete from the property.
        schema:
          type: string
          enum:
          - filterable
          - searchable
          - rangeFilters
      responses:
        '200':
          description: Index deleted successfully.
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Invalid index, property or collection provided.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error occurred while deleting the index. Check the ErrorResponse
            for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /schema/{className}/properties/{propertyName}/tokenize:
    post:
      summary: Weaviate Tokenize Text Using A Property'S Configuration
      description: Tokenizes the provided text using the tokenization method configured
        for the specified property. This endpoint automatically applies the property's
        tokenization setting and the collection's stopword configuration, making it
        useful for understanding exactly how text will be processed for a given property
        during indexing and querying.
      tags:
      - schema
      operationId: schema.objects.properties.tokenize
      parameters:
      - name: className
        in: path
        required: true
        description: The name of the collection (class) containing the property.
        schema:
          type: string
      - name: propertyName
        in: path
        required: true
        description: The name of the property whose tokenization configuration should
          be used.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PropertyTokenizeRequest'
      responses:
        '200':
          description: Successfully tokenized the text using the property's configuration.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TokenizeResponse'
        '400':
          description: Invalid request body, missing required fields, or property
            does not have tokenization configured.
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Collection or property not found.
        '422':
          description: Validation error, such as invalid class or property configuration
            for tokenization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Unexpected server error while tokenizing the text.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /schema/{className}/vectors/{vectorIndexName}/index:
    delete:
      summary: Weaviate Delete A Collection'S Vector Index.
      description: Deletes a specific vector index within a collection (`className`).
        The vector index to delete is identified by `vectorIndexName`.
      tags:
      - schema
      operationId: schema.objects.vectors.delete
      parameters:
      - name: className
        in: path
        required: true
        description: The name of the collection (class) containing the property.
        schema:
          type: string
      - name: vectorIndexName
        in: path
        required: true
        description: The name of the vector index.
        schema:
          type: string
      responses:
        '200':
          description: Vector index deleted successfully.
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Invalid vector index or collection provided.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error occurred while deleting the vector index. Check the
            ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /schema/{className}/shards:
    get:
      summary: Weaviate Get The Shards Status Of A Collection
      description: Retrieves the status of all shards associated with the specified
        collection (`className`). For multi-tenant collections, use the `tenant` query
        parameter to retrieve status for a specific tenant's shards.
      tags:
      - schema
      operationId: schema.objects.shards.get
      parameters:
      - name: className
        in: path
        required: true
        description: The name of the collection (class) whose shards to query.
        schema:
          type: string
      - name: tenant
        in: query
        required: false
        description: The name of the tenant for which to retrieve shard statuses (only
          applicable for multi-tenant collections).
        schema:
          type: string
      responses:
        '200':
          description: Shard statuses retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShardStatusList'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Collection not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error occurred while retrieving shard statuses. Check the
            ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /schema/{className}/shards/{shardName}:
    put:
      summary: Weaviate Update A Shard Status
      description: Updates the status of a specific shard within a collection (e.g.,
        sets it to `READY` or `READONLY`). This is typically used after resolving
        an underlying issue (like disk space) that caused a shard to become non-operational.
        There is also a convenience function in each client to set the status of all
        shards of a collection.
      tags:
      - schema
      operationId: schema.objects.shards.update
      parameters:
      - name: className
        in: path
        required: true
        description: The name of the collection (class) containing the shard.
        schema:
          type: string
      - name: shardName
        in: path
        required: true
        description: The name of the shard to update.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShardStatus'
      responses:
        '200':
          description: Shard status updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShardStatus'
        '422':
          description: Invalid update attempt
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Collection or shard not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error occurred while updating the shard status. Check the
            ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /schema/{className}/tenants:
    post:
      summary: Weaviate Create A New Tenant
      description: Creates one or more new tenants for a specified collection (`className`).
        Multi-tenancy must be enabled for the collection via its definition.
      tags:
      - schema
      operationId: tenants.create
      parameters:
      - name: className
        in: path
        required: true
        description: The name of the multi-tenant enabled collection (class).
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Tenant'
      responses:
        '200':
          description: Tenants created successfully.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Tenant'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error occurred while creating tenants. Check the ErrorResponse
            for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    put:
      summary: Weaviate Update A Tenant
      description: Updates the activity status (e.g., `ACTIVE`, `INACTIVE`, etc.)
        of one or more specified tenants within a collection (`className`).
      tags:
      - schema
      operationId: tenants.update
      parameters:
      - name: className
        in: path
        required: true
        description: The name of the collection (class) containing the tenants.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Tenant'
      responses:
        '200':
          description: Tenant statuses updated successfully.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Tenant'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Invalid update request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error occurred while updating tenants. Check the ErrorResponse
            for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    delete:
      summary: Weaviate Delete Tenants
      description: 'Deletes one or more specified tenants from a collection (`className`).
        WARNING: This action permanently deletes all data associated with the specified
        tenants.'
      tags:
      - schema
      operationId: tenants.delete
      parameters:
      - name: className
        in: path
        required: true
        description: The name of the collection (class) from which to delete tenants.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
                description: Name of a tenant to delete.
      responses:
        '200':
          description: Tenants deleted successfully.
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error occurred while deleting tenants. Check the ErrorResponse
            for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    get:
      summary: Weaviate Get The List Of Tenants
      description: Retrieves a list of all tenants currently associated with the specified
        collection.
      tags:
      - schema
      operationId: tenants.get
      parameters:
      - name: className
        in: path
        required: true
        description: The name of the collection (class) whose tenants to list.
        schema:
          type: string
      - name: consistency
        in: header
        required: false
        description: If true, the request is proxied to the cluster leader to ensure
          strong schema consistency. Default is true.
        schema:
          type: boolean
          default: true
      responses:
        '200':
          description: Successfully retrieved tenants.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Tenant'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error occurred while listing tenants. Check the ErrorResponse
            for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /schema/{className}/tenants/{tenantName}:
    head:
      summary: Weaviate Check If A Tenant Exists
      description: Checks for the existence of a specific tenant within the given
        collection (`className`).
      tags:
      - schema
      operationId: tenant.exists
      parameters:
      - name: className
        in: path
        required: true
        description: The name of the collection (class) to check within.
        schema:
          type: string
      - name: tenantName
        in: path
        required: true
        description: The name of the tenant to check for.
        schema:
          type: string
      - name: consistency
        in: header
        required: false
        description: If true, the request is proxied to the cluster leader to ensure
          strong schema consistency. Default is true.
        schema:
          type: boolean
          default: true
      responses:
        '200':
          description: The tenant exists in the specified collection.
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Tenant or collection not found.
        '422':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error occurred during the check. Check the ErrorResponse
            for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    get:
      summary: Weaviate Get A Specific Tenant
      description: Retrieves details about a specific tenant within the given collection
        (`className`), such as its current activity status.
      tags:
      - schema
      operationId: tenants.get.one
      parameters:
      - name: className
        in: path
        required: true
        description: The name of the collection (class) containing the tenant.
        schema:
          type: string
      - name: tenantName
        in: path
        required: true
        description: The name of the tenant to retrieve.
        schema:
          type: string
      - name: consistency
        in: header
        required: false
        description: If true, the request is proxied to the cluster leader to ensure
          strong schema consistency. Default is true.
        schema:
          type: boolean
          default: true
      responses:
        '200':
          description: Successfully retrieved tenant details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tenant'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Tenant or collection not found.
        '422':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error occurred while retrieving the tenant. Check the ErrorResponse
            for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /aliases:
    get:
      summary: Weaviate List Aliases
      description: Retrieve a list of all aliases in the system. Results can be filtered
        by specifying a collection (class) name to get aliases for a specific collection
        only.
      tags:
      - schema
      operationId: aliases.get
      parameters:
      - name: class
        in: query
        required: false
        description: Optional filter to retrieve aliases for a specific collection
          (class) only. If not provided, returns all aliases.
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the list of aliases
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AliasResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Invalid collection (class) parameter provided
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    post:
      summary: Weaviate Create A New Alias
      description: Create a new alias mapping between an alias name and a collection
        (class). The alias acts as an alternative name for accessing the collection.
      tags:
      - schema
      operationId: aliases.create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Alias'
      responses:
        '200':
          description: Successfully created a new alias for the specified collection
            (class)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Alias'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Invalid create alias request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /aliases/{aliasName}:
    get:
      summary: Weaviate Get An Alias
      description: Retrieve details about a specific alias by its name, including
        which collection (class) it points to.
      tags:
      - schema
      operationId: aliases.get.alias
      parameters:
      - name: aliasName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the alias details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Alias'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found - Alias does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Invalid alias name provided.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    put:
      summary: Weaviate Update An Alias
      description: Update an existing alias to point to a different collection (class).
        This allows you to redirect an alias from one collection to another without
        changing the alias name.
      tags:
      - schema
      operationId: aliases.update
      parameters:
      - name: aliasName
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                class:
                  type: string
                  description: The new collection (class) that the alias should point
                    to.
      responses:
        '200':
          description: Successfully updated the alias to point to the new collection
            (class).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Alias'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found - Alias does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Invalid update alias request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    delete:
      summary: Weaviate Delete An Alias
      description: Remove an existing alias from the system. This will delete the
        alias mapping but will not affect the underlying collection (class).
      tags:
      - schema
      operationId: aliases.delete
      parameters:
      - name: aliasName
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Successfully deleted the alias.
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found - Alias does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Invalid delete alias request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /namespaces:
    get:
      summary: Weaviate List Namespaces
      description: Retrieve the list of all namespaces the caller has permission to
        see. Callers without any applicable `manage_namespaces` permission receive
        an empty list (never 403).
      tags:
      - namespaces
      operationId: listNamespaces
      responses:
        '200':
          description: Successfully retrieved the list of namespaces (possibly empty).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NamespaceListResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '404':
          description: Not Found - The namespaces feature is not enabled on this cluster.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: The request syntax is correct, but the server couldn't process
            it.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /namespaces/{namespace_id}:
    post:
      summary: Weaviate Create A New Namespace
      description: Create a new cluster-level namespace with the given name. Names
        must start with a lowercase letter, contain only lowercase letters and digits,
        be 3-36 characters long, and must not be a reserved name.
      tags:
      - namespaces
      operationId: createNamespace
      parameters:
      - name: namespace_id
        in: path
        required: true
        description: The name of the namespace. Must start with a lowercase letter,
          contain only lowercase letters and digits, length 3-36, and not be a reserved
          name.
        schema:
          type: string
      responses:
        '201':
          description: Namespace created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Namespace'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found - The namespaces feature is not enabled on this cluster.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: A namespace with the specified name already exists.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues (e.g. invalid name format or reserved name).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    get:
      summary: Weaviate Get A Namespace
      description: Retrieve details about a specific namespace by its name.
      tags:
      - namespaces
      operationId: getNamespace
      parameters:
      - name: namespace_id
        in: path
        required: true
        description: The name of the namespace.
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the namespace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Namespace'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found - Namespace does not exist, or the namespaces feature
            is not enabled on this cluster.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues (e.g. invalid name format or reserved name).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    delete:
      summary: Weaviate Delete A Namespace
      description: Hard-delete a namespace by its name.
      tags:
      - namespaces
      operationId: deleteNamespace
      parameters:
      - name: namespace_id
        in: path
        required: true
        description: The name of the namespace.
        schema:
          type: string
      responses:
        '204':
          description: Successfully deleted.
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found - Namespace does not exist, or the namespaces feature
            is not enabled on this cluster.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: The request syntax is correct, but the server couldn't process
            it due to semantic issues (e.g. invalid name format or reserved name).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An error has occurred while trying to fulfill the request.
            Most likely the ErrorResponse will contain more information about the
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /backups/{backend}:
    post:
      summary: Weaviate Create A Backup
      description: Initiates the creation of a backup for specified collections on
        a designated backend storage.<br/><br/>Notes:<br/>- Backups are compressed
        using gzip by default.<br/>- Weaviate remains operational during the backup
        process.
      tags:
      - backups
      operationId: backups.create
      parameters:
      - name: backend
        in: path
        required: true
        description: Specifies the backend storage system where the backup will be
          stored (e.g., `filesystem`, `gcs`, `s3`, `azure`).
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackupCreateRequest'
      responses:
        '200':
          description: Backup creation process initiated successfully. Check the status
            endpoint for progress.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupCreateResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Invalid backup creation request. Check the request body and
            backend configuration.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An internal server error occurred during backup initiation.
            Check the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    get:
      summary: Weaviate List All Created Backups
      description: List all created backups IDs, Status
      tags:
      - backups
      operationId: backups.list
      parameters:
      - name: backend
        in: path
        required: true
        description: Specifies the backend storage system to list backups from (e.g.,
          `filesystem`, `gcs`, `s3`, `azure`).
        schema:
          type: string
      - name: order
        in: query
        required: false
        description: Order of returned list of backups based on creation time. (asc
          or desc)
        schema:
          type: string
          enum:
          - asc
          - desc
          default: desc
      responses:
        '200':
          description: Successfully retrieved the list of backups in progress.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupListResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Invalid request to list backups.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An internal server error occurred while listing backups. Check
            the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /backups/{backend}/{id}:
    get:
      summary: Weaviate Get Backup Creation Status
      description: Checks the status of a specific backup creation process identified
        by its ID on the specified backend.<br/><br/>Client libraries often provide
        a 'wait for completion' feature that polls this endpoint automatically. Use
        this endpoint for manual status checks or if 'wait for completion' is disabled.
      tags:
      - backups
      operationId: backups.create.status
      parameters:
      - name: backend
        in: path
        required: true
        description: Specifies the backend storage system where the backup resides
          (e.g., `filesystem`, `gcs`, `s3`, `azure`).
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: The unique identifier of the backup. Must be URL-safe and compatible
          with filesystem paths (only lowercase, numbers, underscore, minus characters
          allowed).
        schema:
          type: string
      - name: bucket
        in: query
        required: false
        description: 'Optional: Specifies the bucket, container, or volume name if
          required by the backend.'
        schema:
          type: string
      - name: path
        in: query
        required: false
        description: 'Optional: Specifies the path within the bucket/container/volume
          if the backup is not at the root.'
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the status of the backup creation process.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupCreateStatusResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Backup not found on the specified backend with the given ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Invalid request to check backup creation status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An internal server error occurred while checking backup status.
            Check the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    delete:
      summary: Weaviate Cancel A Backup
      description: Cancels an ongoing backup operation identified by its ID.
      tags:
      - backups
      operationId: backups.cancel
      parameters:
      - name: backend
        in: path
        required: true
        description: Specifies the backend storage system where the backup resides
          (e.g., `filesystem`, `gcs`, `s3`, `azure`).
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: The unique identifier of the backup to cancel. Must be URL-safe
          and compatible with filesystem paths (only lowercase, numbers, underscore,
          minus characters allowed).
        schema:
          type: string
      - name: bucket
        in: query
        required: false
        description: 'Optional: Specifies the bucket, container, or volume name if
          required by the backend.'
        schema:
          type: string
      - name: path
        in: query
        required: false
        description: 'Optional: Specifies the path within the bucket/container/volume
          if the backup is not at the root.'
        schema:
          type: string
      responses:
        '204':
          description: Backup canceled successfully.
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Invalid backup cancellation request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An internal server error occurred during backup cancellation.
            Check the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /backups/{backend}/{id}/restore:
    post:
      summary: Weaviate Restore From A Backup
      description: Initiates the restoration of collections from a specified backup
        located on a designated backend.<br/><br/>Requirements:<br/>- Target cluster
        must have the same number of nodes as the source cluster where the backup
        was created.<br/>- Collections included in the restore must not already exist
        on the target cluster.<br/>- Node names must match between the backup and
        the target cluster.
      tags:
      - backups
      operationId: backups.restore
      parameters:
      - name: backend
        in: path
        required: true
        description: Specifies the backend storage system where the backup resides
          (e.g., `filesystem`, `gcs`, `s3`, `azure`).
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: The unique identifier of the backup to restore from. Must be
          URL-safe and compatible with filesystem paths (only lowercase, numbers,
          underscore, minus characters allowed).
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackupRestoreRequest'
      responses:
        '200':
          description: Backup restoration process initiated successfully. Check the
            status endpoint for progress.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupRestoreResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Backup not found on the specified backend with the given ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Invalid backup restoration request. Check requirements and
            request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An internal server error occurred during restore initiation.
            Check the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    get:
      summary: Weaviate Get Backup Restoration Status
      description: Checks the status of a specific backup restoration process identified
        by the backup ID on the specified backend.<br/><br/>Client libraries often
        provide a 'wait for completion' feature that polls this endpoint automatically.
        Use this endpoint for manual status checks or if 'wait for completion' is
        disabled.
      tags:
      - backups
      operationId: backups.restore.status
      parameters:
      - name: backend
        in: path
        required: true
        description: Specifies the backend storage system where the backup resides
          (e.g., `filesystem`, `gcs`, `s3`, `azure`).
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: The unique identifier of the backup being restored. Must be URL-safe
          and compatible with filesystem paths (only lowercase, numbers, underscore,
          minus characters allowed).
        schema:
          type: string
      - name: bucket
        in: query
        required: false
        description: 'Optional: Specifies the bucket, container, or volume name if
          required by the backend.'
        schema:
          type: string
      - name: path
        in: query
        required: false
        description: 'Optional: Specifies the path within the bucket.'
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the status of the backup restoration
            process.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupRestoreStatusResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Backup not found on the specified backend with the given ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An internal server error occurred while checking restore status.
            Check the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    delete:
      summary: Weaviate Cancel A Backup Restoration
      description: Cancels an ongoing backup restoration process identified by its
        ID on the specified backend storage.
      tags:
      - backups
      operationId: backups.restore.cancel
      parameters:
      - name: backend
        in: path
        required: true
        description: Specifies the backend storage system where the backup resides
          (e.g., `filesystem`, `gcs`, `s3`, `azure`).
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: The unique identifier of the backup restoration to cancel. Must
          be URL-safe and compatible with filesystem paths (only lowercase, numbers,
          underscore, minus characters allowed).
        schema:
          type: string
      - name: bucket
        in: query
        required: false
        description: 'Optional: Specifies the bucket, container, or volume name if
          required by the backend.'
        schema:
          type: string
      - name: path
        in: query
        required: false
        description: 'Optional: Specifies the path within the bucket/container/volume
          if the backup is not at the root.'
        schema:
          type: string
      responses:
        '204':
          description: Backup restoration cancelled successfully.
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Invalid backup restoration cancellation request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An internal server error occurred during backup restoration
            cancellation. Check the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /export/{backend}:
    post:
      summary: Weaviate Start A New Export
      description: Initiates an export operation on the specified backend storage
        (S3, GCS, Azure, or filesystem). The output format is controlled by the required
        'file_format' field in the request body (currently only 'parquet' is supported).
        Each collection is exported to a separate file.
      tags:
      - export
      operationId: export.create
      parameters:
      - name: backend
        in: path
        required: true
        description: The backend storage system to use for the export (e.g., `filesystem`,
          `gcs`, `s3`, `azure`).
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExportCreateRequest'
      responses:
        '200':
          description: Successfully started export operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportCreateResponse'
        '401':
          description: Unauthorized or invalid credentials
        '403':
          description: Forbidden - insufficient permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Export already exists or another export is already in progress
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Invalid export request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error occurred while starting export
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /export/{backend}/{id}:
    get:
      summary: Weaviate Get Export Status
      description: Retrieves the current status of an export operation, including
        progress for each collection being exported.
      tags:
      - export
      operationId: export.status
      parameters:
      - name: backend
        in: path
        required: true
        description: The backend storage system where the export is stored.
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: The unique identifier of the export.
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved export status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportStatusResponse'
        '401':
          description: Unauthorized or invalid credentials
        '403':
          description: Forbidden - insufficient permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Export not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Invalid request (e.g., unsupported backend)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error occurred while retrieving export status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
    delete:
      summary: Weaviate Cancel An Export
      description: Cancels an ongoing export operation identified by its ID.
      tags:
      - export
      operationId: export.cancel
      parameters:
      - name: backend
        in: path
        required: true
        description: The backend storage system where the export is stored.
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: The unique identifier of the export to cancel.
        schema:
          type: string
      responses:
        '204':
          description: Export cancelled successfully.
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden - insufficient permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Export not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Export has already finished and cannot be cancelled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Invalid request (e.g., unsupported backend)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error occurred while cancelling export
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /cluster/statistics:
    get:
      summary: Weaviate Get Cluster Statistics
      description: Provides statistics about the internal Raft consensus protocol
        state for the Weaviate cluster.
      tags:
      - cluster
      operationId: cluster.get.statistics
      responses:
        '200':
          description: Successfully retrieved Raft cluster statistics.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterStatisticsResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Invalid request for cluster statistics.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An internal server error occurred while retrieving cluster
            statistics. Check the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /nodes:
    get:
      summary: Weaviate Get Node Status
      description: Retrieves status information about all nodes in the cluster. Use
        the `output` query parameter to control the level of detail.
      tags:
      - nodes
      operationId: nodes.get
      parameters:
      - name: output
        in: query
        required: false
        description: 'Controls the verbosity of the output, possible values are: `minimal`,
          `verbose`. Defaults to `minimal`.'
        schema:
          type: string
          default: minimal
      responses:
        '200':
          description: Successfully retrieved the status for all nodes.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NodesStatusResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Invalid request for node status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An internal server error occurred while retrieving node status.
            Check the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /nodes/{className}:
    get:
      summary: Weaviate Get Node Status By Collection
      description: Retrieves status information only for the nodes that host shards
        for the specified collection (`className`). Use the `output` query parameter
        to control the level of detail.
      tags:
      - nodes
      operationId: nodes.get.class
      parameters:
      - name: className
        in: path
        required: true
        description: The name of the collection (class) for which to retrieve node
          status.
        schema:
          type: string
      - name: shardName
        in: query
        required: false
        schema:
          type: string
      - name: output
        in: query
        required: false
        description: 'Controls the verbosity of the output, possible values are: `minimal`,
          `verbose`. Defaults to `minimal`.'
        schema:
          type: string
          default: minimal
      responses:
        '200':
          description: Successfully retrieved the status for nodes relevant to the
            specified collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NodesStatusResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Invalid request for node status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An internal server error occurred while retrieving node status
            for the collection. Check the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /tasks:
    get:
      summary: Weaviate Lists All Distributed Tasks In The Cluster
      tags:
      - distributedTasks
      operationId: distributedTasks.get
      responses:
        '200':
          description: Distributed tasks successfully returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DistributedTasks'
        '403':
          description: Unauthorized or invalid credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An internal server error occurred while retrieving distributed
            tasks. Check the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /classifications/:
    post:
      summary: Weaviate Start A Classification
      description: Initiates a background classification task based on the provided
        parameters. Use the GET /classifications/{id} endpoint to monitor the status
        and retrieve results.
      tags:
      - classifications
      operationId: classifications.post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Classification'
      responses:
        '201':
          description: Classification task successfully initiated. The response body
            contains the classification details including its ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Classification'
        '400':
          description: Invalid request body or parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An internal server error occurred while starting the classification
            task. Check the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /classifications/{id}:
    get:
      summary: Weaviate Get Classification Status
      description: Retrieves the status, metadata, and results (if completed) of a
        classification task identified by its unique ID.
      tags:
      - classifications
      operationId: classifications.get
      parameters:
      - name: id
        in: path
        required: true
        description: The unique identifier (UUID) of the classification task.
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the classification details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Classification'
        '401':
          description: Unauthorized or invalid credentials.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Classification with the given ID not found.
        '500':
          description: An internal server error occurred while retrieving the classification
            status. Check the ErrorResponse for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 100
  /mcp:
    post:
      summary: Weaviate MCP Streamable HTTP Endpoint
      description: MCP Streamable HTTP endpoint. Handles JSON-RPC requests for tool
        discovery and invocation.
      tags:
      - mcp
      operationId: mcp.post
      responses:
        '200':
          description: JSON-RPC response or SSE stream
      x-microcks-operation:
        delay: 100
    get:
      summary: Weaviate Opens An SSE Stream For Receiving MCP Server-Sent Events
      description: Opens an SSE stream for receiving MCP server-sent events.
      tags:
      - mcp
      operationId: mcp.get
      responses:
        '200':
          description: SSE event stream
      x-microcks-operation:
        delay: 100
    delete:
      summary: Weaviate Terminates An MCP Session
      description: Terminates an MCP session.
      tags:
      - mcp
      operationId: mcp.delete
      responses:
        '200':
          description: Session terminated
      x-microcks-operation:
        delay: 100
components:
  schemas:
    UserTypeInput:
      type: string
      description: The type of the user. `db` users are managed by Weaviate, `oidc`
        users are managed by an external OIDC provider.
      enum:
      - db
      - oidc
    GroupType:
      type: string
      description: If the group contains OIDC or database users.
      enum:
      - oidc
    UserTypeOutput:
      type: string
      description: The type of the user. `db_user` users are created through the `users`
        API, `db_env_user` users are created through environment variables, and `oidc`
        users are managed by an external OIDC provider.
      enum:
      - db_user
      - db_env_user
      - oidc
    UserOwnInfo:
      type: object
      required:
      - username
      properties:
        groups:
          type: array
          description: The groups associated with the user.
          items:
            type: string
        roles:
          type: array
          items:
            $ref: '#/components/schemas/Role'
        username:
          type: string
          description: The name (ID) of the user.
    DBUserInfo:
      type: object
      required:
      - userId
      - dbUserType
      - roles
      - active
      properties:
        roles:
          type: array
          description: The roles associated with the user.
          items:
            type: string
        userId:
          type: string
          description: The name (ID) of the user.
        dbUserType:
          type: string
          description: Type of the returned user.
          enum:
          - db_user
          - db_env_user
        active:
          type: boolean
          description: Activity status of the returned user.
        createdAt:
          type:
          - string
          - 'null'
          format: date-time
          description: 'Date and time in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.'
        apiKeyFirstLetters:
          type:
          - string
          - 'null'
          description: First 3 letters of the associated API key.
          maxLength: 3
        lastUsedAt:
          type:
          - string
          - 'null'
          format: date-time
          description: 'Date and time in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.'
        namespace:
          type: string
          description: The namespace this user is bound to. Only populated for callers
            with global-operator privileges; omitted otherwise.
    UserApiKey:
      type: object
      required:
      - apikey
      properties:
        apikey:
          type: string
          description: The API key associated with the user.
    Role:
      type: object
      required:
      - name
      - permissions
      properties:
        name:
          type: string
          description: The name (ID) of the role.
        permissions:
          type: array
          items:
            $ref: '#/components/schemas/Permission'
    Permission:
      type: object
      description: Permissions attached to a role.
      required:
      - action
      properties:
        backups:
          type: object
          description: Resources applicable for backup actions.
          properties:
            collection:
              type: string
              description: A string that specifies which collections this permission
                applies to. Can be an exact collection name or a regex pattern. The
                default value `*` applies the permission to all collections.
              default: '*'
        data:
          type: object
          description: Resources applicable for data actions.
          properties:
            collection:
              type: string
              description: A string that specifies which collections this permission
                applies to. Can be an exact collection name or a regex pattern. The
                default value `*` applies the permission to all collections.
              default: '*'
            tenant:
              type: string
              description: A string that specifies which tenants this permission applies
                to. Can be an exact tenant name or a regex pattern. The default value
                `*` applies the permission to all tenants.
              default: '*'
            object:
              type: string
              description: A string that specifies which objects this permission applies
                to. Can be an exact object ID or a regex pattern. The default value
                `*` applies the permission to all objects.
              default: '*'
        nodes:
          type: object
          description: Resources applicable for cluster actions.
          properties:
            verbosity:
              type: string
              description: Whether to allow (verbose) returning shards and stats data
                in the response.
              enum:
              - verbose
              - minimal
              default: minimal
            collection:
              type: string
              description: A string that specifies which collections this permission
                applies to. Can be an exact collection name or a regex pattern. The
                default value `*` applies the permission to all collections.
              default: '*'
        users:
          type: object
          description: Resources applicable for user actions.
          properties:
            users:
              type: string
              description: A string that specifies which users this permission applies
                to. Can be an exact user name or a regex pattern. The default value
                `*` applies the permission to all users.
              default: '*'
        groups:
          type: object
          description: Resources applicable for group actions.
          properties:
            group:
              type: string
              description: A string that specifies which groups this permission applies
                to. Can be an exact group name or a regex pattern. The default value
                `*` applies the permission to all groups.
              default: '*'
            groupType:
              $ref: '#/components/schemas/GroupType'
        tenants:
          type: object
          description: Resources applicable for tenant actions.
          properties:
            collection:
              type: string
              description: A string that specifies which collections this permission
                applies to. Can be an exact collection name or a regex pattern. The
                default value `*` applies the permission to all collections.
              default: '*'
            tenant:
              type: string
              description: A string that specifies which tenants this permission applies
                to. Can be an exact tenant name or a regex pattern. The default value
                `*` applies the permission to all tenants.
              default: '*'
        roles:
          type: object
          description: Resources applicable for role actions.
          properties:
            role:
              type: string
              description: A string that specifies which roles this permission applies
                to. Can be an exact role name or a regex pattern. The default value
                `*` applies the permission to all roles.
              default: '*'
            scope:
              type: string
              description: Set the scope for the manage role permission.
              enum:
              - all
              - match
              default: match
        collections:
          type: object
          description: Resources applicable for collection and/or tenant actions.
          properties:
            collection:
              type: string
              description: A string that specifies which collections this permission
                applies to. Can be an exact collection name or a regex pattern. The
                default value `*` applies the permission to all collections.
              default: '*'
        replicate:
          type: object
          description: resources applicable for replicate actions
          properties:
            collection:
              type: string
              description: string or regex. if a specific collection name, if left
                empty it will be ALL or *
              default: '*'
            shard:
              type: string
              description: string or regex. if a specific shard name, if left empty
                it will be ALL or *
              default: '*'
        aliases:
          type: object
          description: Resource definition for alias-related actions and permissions.
            Used to specify which aliases and collections can be accessed or modified.
          properties:
            collection:
              type: string
              description: A string that specifies which collections this permission
                applies to. Can be an exact collection name or a regex pattern. The
                default value `*` applies the permission to all collections.
              default: '*'
            alias:
              type: string
              description: A string that specifies which aliases this permission applies
                to. Can be an exact alias name or a regex pattern. The default value
                `*` applies the permission to all aliases.
              default: '*'
        namespaces:
          type: object
          description: Resources applicable for namespace actions.
          properties:
            namespace:
              type: string
              description: A string that specifies which namespaces this permission
                applies to. Can be an exact namespace name or a regex pattern. The
                default value `*` applies the permission to all namespaces.
              default: '*'
        action:
          type: string
          description: Allowed actions in weaviate.
          enum:
          - manage_backups
          - read_cluster
          - create_data
          - read_data
          - update_data
          - delete_data
          - read_nodes
          - create_roles
          - read_roles
          - update_roles
          - delete_roles
          - create_collections
          - read_collections
          - update_collections
          - delete_collections
          - assign_and_revoke_users
          - create_users
          - read_users
          - update_users
          - delete_users
          - create_tenants
          - read_tenants
          - update_tenants
          - delete_tenants
          - create_replicate
          - read_replicate
          - update_replicate
          - delete_replicate
          - create_aliases
          - read_aliases
          - update_aliases
          - delete_aliases
          - assign_and_revoke_groups
          - read_groups
          - create_mcp
          - read_mcp
          - update_mcp
          - manage_namespaces
    RolesListResponse:
      type: array
      description: List of roles.
      items:
        $ref: '#/components/schemas/Role'
    Link:
      type: object
      properties:
        href:
          type: string
          description: Target of the link.
        rel:
          type: string
          description: Relationship if both resources are related, e.g. 'next', 'previous',
            'parent', etc.
        name:
          type: string
          description: Human readable name of the resource group.
        documentationHref:
          type: string
          description: Weaviate documentation about this resource group.
    Principal:
      type: object
      properties:
        username:
          type: string
          description: The username that was extracted either from the authentication
            information
        groups:
          type: array
          items:
            type: string
        userType:
          $ref: '#/components/schemas/UserTypeInput'
        namespace:
          type: string
          description: The namespace this principal is bound to. Empty for global
            principals (e.g. static API keys).
        isGlobalOperator:
          type: boolean
          description: True for principals that operate across all namespaces (e.g.
            static API keys). Authoritative marker for operator-level principals;
            do not infer from an empty namespace.
    C11yWordsResponse:
      description: An array of available words and contexts.
      properties:
        concatenatedWord:
          type: object
          description: Weighted results for all words
          properties:
            concatenatedWord:
              type: string
            singleWords:
              type: array
              items:
                format: string
            concatenatedVector:
              $ref: '#/components/schemas/C11yVector'
            concatenatedNearestNeighbors:
              $ref: '#/components/schemas/C11yNearestNeighbors'
        individualWords:
          type: array
          description: Weighted results for per individual word
          items:
            type: object
            properties:
              word:
                type: string
              present:
                type: boolean
              info:
                type: object
                properties:
                  vector:
                    $ref: '#/components/schemas/C11yVector'
                  nearestNeighbors:
                    $ref: '#/components/schemas/C11yNearestNeighbors'
    C11yExtension:
      description: A resource describing an extension to the contextinoary, containing
        both the identifier and the definition of the extension
      properties:
        concept:
          type: string
          description: 'The new concept you want to extend. Must be an all-lowercase
            single word, or a space delimited compound word. Examples: ''foobarium'',
            ''my custom concept'''
          example: foobarium
        definition:
          type: string
          description: 'A list of space-delimited words or a sentence describing what
            the custom concept is about. Avoid using the custom concept itself. An
            Example definition for the custom concept ''foobarium'': would be ''a
            naturally occurring element which can only be seen by programmers'''
        weight:
          type: number
          format: float
          description: Weight of the definition of the new concept where 1='override
            existing definition entirely' and 0='ignore custom definition'. Note that
            if the custom concept is not present in the contextionary yet, the weight
            cannot be less than 1.
    C11yNearestNeighbors:
      type: array
      description: C11y function to show the nearest neighbors to a word.
      items:
        type: object
        properties:
          word:
            type: string
          distance:
            type: number
            format: float
    C11yVector:
      type: array
      description: A vector representation of the object in the Contextionary. If
        provided at object creation, this wil take precedence over any vectorizer
        setting.
      items:
        type: number
        format: float
    Vector:
      type: object
      description: A vector representation of the object. If provided at object creation,
        this wil take precedence over any vectorizer setting.
    Vectors:
      type: object
      description: A map of named vectors for multi-vector representations.
      additionalProperties:
        $ref: '#/components/schemas/Vector'
    Deprecation:
      type: object
      properties:
        id:
          type: string
          description: The id that uniquely identifies this particular deprecation
            (mostly used internally).
        status:
          type: string
          description: Whether the problematic API functionality is deprecated (planned
            to be removed) or already removed.
        apiType:
          type: string
          description: 'Describes which API is affected, usually one of: REST, GraphQL
            and gRPC.'
        msg:
          type: string
          description: What this deprecation is about.
        mitigation:
          type: string
          description: User-required object to not be affected by the (planned) removal.
        sinceVersion:
          type: string
          description: The deprecation was introduced in this version.
        plannedRemovalVersion:
          type: string
          description: A best-effort guess of which upcoming version will remove the
            feature entirely.
        removedIn:
          type: string
          description: If the feature has already been removed, it was removed in
            this version.
        removedTime:
          type: string
          format: date-time
          description: If the feature has already been removed, it was removed at
            this timestamp.
        sinceTime:
          type: string
          format: date-time
          description: The deprecation was introduced at this timestamp.
        locations:
          type: array
          description: The locations within the specified API affected by this deprecation.
          items:
            type: string
    ErrorResponse:
      type: object
      description: An error response returned by Weaviate endpoints.
      properties:
        error:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
    ExportCreateRequest:
      type: object
      description: Request to create a new export operation
      required:
      - id
      - file_format
      properties:
        id:
          type: string
          description: Unique identifier for this export. Must be URL-safe.
        file_format:
          type: string
          description: Output file format for the export.
          enum:
          - parquet
        include:
          type: array
          description: List of collection names to include in the export. Cannot be
            used with 'exclude'.
          items:
            type: string
        exclude:
          type: array
          description: List of collection names to exclude from the export. Cannot
            be used with 'include'.
          items:
            type: string
    ExportCreateResponse:
      type: object
      description: Response from creating an export operation
      properties:
        id:
          type: string
          description: Unique identifier for this export
        backend:
          type: string
          description: The backend storage system used
        path:
          type: string
          description: Full path where the export is being written
        status:
          type: string
          description: Current status of the export
          enum:
          - STARTED
        startedAt:
          type: string
          format: date-time
          description: When the export started
        classes:
          type: array
          description: List of collections being exported
          items:
            type: string
    ExportStatusResponse:
      type: object
      description: Current status of an export operation
      properties:
        id:
          type: string
          description: Unique identifier for this export
        backend:
          type: string
          description: The backend storage system used
        path:
          type: string
          description: Full path where the export is stored
        status:
          type: string
          description: Current status of the export
          enum:
          - STARTED
          - TRANSFERRING
          - SUCCESS
          - FAILED
          - CANCELED
        startedAt:
          type: string
          format: date-time
          description: When the export started
        completedAt:
          type: string
          format: date-time
          description: When the export completed (successfully, with failure, or was
            canceled)
        tookInMs:
          type: integer
          format: int64
          description: Duration of the export in milliseconds
        classes:
          type: array
          description: List of collections in this export
          items:
            type: string
        shardStatus:
          type: object
          description: 'Per-shard progress: className -> shardName -> status'
          additionalProperties:
            type: object
            additionalProperties:
              $ref: '#/components/schemas/ShardProgress'
        error:
          type: string
          description: Error message if export failed
    ShardProgress:
      type: object
      description: Progress information for exporting a single shard
      properties:
        status:
          type: string
          description: Status of this shard's export
          enum:
          - TRANSFERRING
          - SUCCESS
          - FAILED
          - SKIPPED
        objectsExported:
          type: integer
          format: int64
          description: Number of objects exported from this shard
        error:
          type: string
          description: Error message if this shard's export failed
        skipReason:
          type: string
          description: Reason why this shard was skipped (e.g. tenant status)
    GraphQLError:
      description: An error response caused by a GraphQL query.
      properties:
        locations:
          type: array
          items:
            type: object
            properties:
              column:
                type: integer
                format: int64
              line:
                type: integer
                format: int64
        message:
          type: string
        path:
          type: array
          items:
            type: string
    GraphQLQuery:
      type: object
      description: 'GraphQL query based on: http://facebook.github.io/graphql/.'
      properties:
        operationName:
          type: string
          description: The name of the operation if multiple exist in the query.
        query:
          type: string
          description: Query based on GraphQL syntax.
        variables:
          type: object
          description: Additional variables for the query.
    GraphQLQueries:
      type: array
      description: A list of GraphQL queries.
      items:
        $ref: '#/components/schemas/GraphQLQuery'
    GraphQLResponse:
      description: 'GraphQL based response: http://facebook.github.io/graphql/.'
      properties:
        data:
          type: object
          description: GraphQL data object.
          additionalProperties:
            $ref: '#/components/schemas/JsonObject'
        errors:
          type: array
          description: Array with errors.
          items:
            $ref: '#/components/schemas/GraphQLError'
    GraphQLResponses:
      type: array
      description: A list of GraphQL responses.
      items:
        $ref: '#/components/schemas/GraphQLResponse'
    InvertedIndexConfig:
      type: object
      description: 'Configure the inverted index built into Weaviate. See [Reference:
        Inverted index](https://docs.weaviate.io/weaviate/config-refs/indexing/inverted-index#inverted-index-parameters)
        for details.'
      properties:
        cleanupIntervalSeconds:
          type: number
          format: int
          description: 'Asynchronous index clean up happens every n seconds (default:
            60).'
        bm25:
          $ref: '#/components/schemas/BM25Config'
        stopwords:
          $ref: '#/components/schemas/StopwordConfig'
        indexTimestamps:
          type: boolean
          description: 'Index each object by its internal timestamps (default: `false`).'
        indexNullState:
          type: boolean
          description: 'Index each object with the null state (default: `false`).'
        indexPropertyLength:
          type: boolean
          description: 'Index length of properties (default: `false`).'
        usingBlockMaxWAND:
          type: boolean
          description: 'Using BlockMax WAND for query execution (default: `false`,
            will be `true` for new collections created after 1.30).'
        tokenizerUserDict:
          type: array
          description: User-defined dictionary for tokenization.
          items:
            $ref: '#/components/schemas/TokenizerUserDictConfig'
        stopwordPresets:
          type: object
          description: User-defined named stopword lists. Each key is a preset name
            that can be referenced by a property's textAnalyzer.stopwordPreset field.
            The value is an array of stopword strings. Preset names must not be empty
            or whitespace-only; each list must contain at least one word; individual
            words must not be empty or whitespace-only.
          additionalProperties:
            type: array
            items:
              type: string
    ReplicationConfig:
      type: object
      description: Configure how replication is executed in a cluster
      properties:
        factor:
          type: integer
          description: 'Number of times a collection (class) is replicated (default:
            1).'
        asyncEnabled:
          type: boolean
          description: 'Enable asynchronous replication (default: `false`).'
        asyncConfig:
          $ref: '#/components/schemas/ReplicationAsyncConfig'
        deletionStrategy:
          type: string
          description: Conflict resolution strategy for deleted objects.
          enum:
          - NoAutomatedResolution
          - DeleteOnConflict
          - TimeBasedResolution
    BM25Config:
      type: object
      description: Tuning parameters for the BM25 algorithm.
      properties:
        k1:
          type: number
          format: float
          description: 'Calibrates term-weight scaling based on the term frequency
            within a document (default: 1.2).'
        b:
          type: number
          format: float
          description: 'Calibrates term-weight scaling based on the document length
            (default: 0.75).'
    StopwordConfig:
      type: object
      description: Fine-grained control over stopword list usage.
      properties:
        preset:
          type: string
          description: 'Pre-existing list of common words by language (default: `en`).
            Options: [`en`, `none`].'
        additions:
          type: array
          description: 'Stopwords to be considered additionally (default: []). Can
            be any array of custom strings.'
          items:
            type: string
        removals:
          type: array
          description: 'Stopwords to be removed from consideration (default: []).
            Can be any array of custom strings.'
          items:
            type: string
    TokenizerUserDictConfig:
      type: object
      description: A list of pairs of strings that should be replaced with another
        string during tokenization.
      properties:
        tokenizer:
          type: string
          description: The tokenizer to which the user dictionary should be applied.
            Currently, only the `kagame` ja and kr tokenizers supports user dictionaries.
        replacements:
          type: array
          items:
            type: object
            required:
            - source
            - target
            properties:
              source:
                type: string
                description: The string to be replaced.
              target:
                type: string
                description: The string to replace with.
    TokenizeRequest:
      type: object
      description: Request body for the generic tokenize endpoint.
      required:
      - text
      - tokenization
      properties:
        text:
          type: string
          description: The text to tokenize.
        tokenization:
          type: string
          description: The tokenization method to apply.
          enum:
          - word
          - lowercase
          - whitespace
          - field
          - trigram
          - gse
          - kagome_kr
          - kagome_ja
          - gse_ch
        analyzerConfig:
          $ref: '#/components/schemas/TextAnalyzerConfig'
        stopwords:
          $ref: '#/components/schemas/StopwordConfig'
        stopwordPresets:
          type: object
          description: 'Optional user-defined named stopword presets. Shape matches
            InvertedIndexConfig.stopwordPresets on a collection: each key is a preset
            name, each value is a plain list of stopwords. A preset name that matches
            a built-in (''en'', ''none'') fully replaces the built-in. Preset names
            must not be empty or whitespace-only; each word list must contain at least
            one word; individual words must not be empty or whitespace-only. Mutually
            exclusive with stopwords — pass one or the other, not both.'
          additionalProperties:
            type: array
            items:
              type: string
    TokenizeResponse:
      type: object
      description: Response from the tokenize endpoints. Returns `indexed` text and
        text used at `query` time
      properties:
        indexed:
          type: array
          description: The tokens as they would be stored in the inverted index.
          items:
            type: string
        query:
          type: array
          description: The tokens as they would be used for query matching (e.g.,
            after stopword removal).
          items:
            type: string
    PropertyTokenizeRequest:
      type: object
      description: Request body for the property-specific tokenize endpoint.
      required:
      - text
      properties:
        text:
          type: string
          description: The text to tokenize using the property's configured tokenization.
    MultiTenancyConfig:
      description: Configuration related to multi-tenancy within a collection (class)
      properties:
        enabled:
          type: boolean
          description: 'Whether or not multi-tenancy is enabled for this collection
            (class) (default: `false`).'
        autoTenantCreation:
          type: boolean
          description: 'Nonexistent tenants should (not) be created implicitly (default:
            `false`).'
        autoTenantActivation:
          type: boolean
          description: 'Existing tenants should (not) be turned HOT implicitly when
            they are accessed and in another activity status (default: `false`).'
    ObjectTtlConfig:
      description: Configuration of objects' time-to-live
      properties:
        enabled:
          type: boolean
          description: 'Whether or not object ttl is enabled for this collection (default:
            `false`).'
        defaultTtl:
          type: integer
          description: 'Interval (in seconds) to be added to `deleteOn` value, denoting
            object''s expiration time. Has to be positive for `deleteOn` set to `_creationTimeUnix`
            or `_lastUpdateTimeUnix`, any for custom property (default: `0`).'
        deleteOn:
          type: string
          description: Name of the property holding base time to compute object's
            expiration time (ttl = value of deleteOn property + defaultTtl). Can be
            set to `_creationTimeUnix`, `_lastUpdateTimeUnix` or custom property of
            `date` datatype.
        filterExpiredObjects:
          type: boolean
          description: 'Whether remove from resultset expired, but not yet deleted
            by background process objects (default: `false`).'
    JsonObject:
      type: object
      description: JSON object value.
    Meta:
      type: object
      description: Contains meta information of the current Weaviate instance.
      properties:
        hostname:
          type: string
          format: url
          description: The url of the host.
        version:
          type: string
          description: The Weaviate server version.
        modules:
          type: object
          description: Module-specific meta information.
        grpcMaxMessageSize:
          type: integer
          description: Max message size for GRPC connection in bytes.
    MultipleRef:
      type: array
      description: Multiple instances of references to other objects.
      items:
        $ref: '#/components/schemas/SingleRef'
    ReplicationReplicateReplicaRequest:
      type: object
      description: Specifies the parameters required to initiate a shard replica movement
        operation between two nodes for a given collection and shard. This request
        defines the source and target node, the collection and type of transfer.
      required:
      - sourceNode
      - targetNode
      - collection
      - shard
      properties:
        sourceNode:
          type: string
          description: The name of the Weaviate node currently hosting the shard replica
            that needs to be moved or copied.
        targetNode:
          type: string
          description: The name of the Weaviate node where the new shard replica will
            be created as part of the movement or copy operation.
        collection:
          type: string
          description: The name of the collection to which the target shard belongs.
        shard:
          type: string
          description: The name of the shard whose replica is to be moved or copied.
        type:
          type: string
          description: Specifies the type of replication operation to perform. `COPY`
            creates a new replica on the target node while keeping the source replica.
            `MOVE` creates a new replica on the target node and then removes the source
            replica upon successful completion. Defaults to `COPY` if omitted.
          enum:
          - COPY
          - MOVE
          default: COPY
    ReplicationReplicateReplicaResponse:
      type: object
      description: Contains the unique identifier for a successfully initiated asynchronous
        replica movement operation. This ID can be used to track the progress of the
        operation.
      required:
      - id
      properties:
        id:
          type: string
          format: uuid
          description: The unique identifier (ID) assigned to the registered replication
            operation.
    ReplicationShardingStateResponse:
      type: object
      description: Provides the detailed sharding state for one or more collections,
        including the distribution of shards and their replicas across the cluster
        nodes.
      properties:
        shardingState:
          $ref: '#/components/schemas/ReplicationShardingState'
    ReplicationScalePlan:
      type: object
      description: Defines a complete plan for scaling replication within a collection.
        Each shard entry specifies nodes to remove and nodes to add. Added nodes may
        either be initialized empty (null) or created by replicating data from a source
        node specified as a string. If a source node is also marked for removal in
        the same shard, it represents a move operation and can only be used once as
        a source for that shard. If a source node is not marked for removal, it represents
        a copy operation and can be used as the source for multiple additions in that
        shard. Nodes listed in 'removeNodes' cannot also appear as targets in 'addNodes'
        for the same shard, and the same node cannot be specified for both addition
        and removal in a single shard.
      required:
      - planId
      - collection
      - shardScaleActions
      properties:
        planId:
          type: string
          format: uuid
          description: A unique identifier for this replication scaling plan, useful
            for tracking and auditing purposes.
        collection:
          type: string
          description: The name of the collection to which this replication scaling
            plan applies.
        shardScaleActions:
          type: object
          description: A mapping of shard names to their corresponding scaling actions.
            Each key corresponds to a shard name, and its value defines which nodes
            should be removed and which should be added for that shard. If a source
            node listed for an addition is also in 'removeNodes' for the same shard,
            that addition is treated as a move operation. Such a node can appear only
            once as a source in that shard. Otherwise, if the source node is not being
            removed, it represents a copy operation and can be referenced multiple
            times as a source for additions.
          additionalProperties:
            type: object
            description: Scaling actions for a single shard, including which nodes
              to remove and which to add. Nodes listed in 'removeNodes' cannot appear
              as targets in 'addNodes' for the same shard. If a source node is also
              marked for removal, it is treated as a move operation and can only appear
              once as a source node in that shard. A source node that is not being
              removed can appear multiple times as a source node for additions in
              that shard (copy operations).
            properties:
              removeNodes:
                type: array
                description: List of node identifiers from which replicas of this
                  shard should be removed. Nodes listed here must not appear in 'addNodes'
                  for the same shard, and cannot be used as a source node for any
                  addition in this shard except in the implicit move case, where they
                  appear as both a source and a node to remove.
                items:
                  type: string
              addNodes:
                type: object
                description: A mapping of target node identifiers to their addition
                  configuration. Each key represents a target node where a new replica
                  will be added. The value may be null, which means an empty replica
                  will be created, or a string specifying the source node from which
                  shard data will be copied. If the source node is also marked for
                  removal in the same shard, this addition is treated as a move operation,
                  and that source node can only appear once as a source node for that
                  shard. If the source node is not being removed, it can be used as
                  the source for multiple additions (copy operations).
                additionalProperties:
                  type:
                  - string
                  - 'null'
                  description: Defines how the new replica should be created. If null,
                    an empty shard is created. If a string, it specifies the source
                    node from which data for this shard should be replicated.
    ReplicationScaleApplyResponse:
      type: object
      description: Response for the POST /replication/scale endpoint containing the
        list of initiated shard copy operation IDs.
      required:
      - operationIds
      - planId
      - collection
      properties:
        operationIds:
          type: array
          description: List of shard copy operation IDs created during scaling.
          items:
            type: string
            format: uuid
        planId:
          type: string
          format: uuid
          description: The unique identifier of the replication scaling plan that
            generated these operations.
        collection:
          type: string
          description: The name of the collection associated with this replication
            scaling plan.
    ReplicationShardReplicas:
      type: object
      description: Represents a shard and lists the nodes that currently host its
        replicas.
      properties:
        shard:
          type: string
        replicas:
          type: array
          items:
            type: string
    ReplicationShardingState:
      type: object
      description: Details the sharding layout for a specific collection, mapping
        each shard to its set of replicas across the cluster.
      properties:
        collection:
          type: string
          description: The name of the collection.
        shards:
          type: array
          description: An array detailing each shard within the collection and the
            nodes hosting its replicas.
          items:
            $ref: '#/components/schemas/ReplicationShardReplicas'
    ReplicationReplicateDetailsReplicaStatusError:
      type: object
      description: Represents an error encountered during a replication operation,
        including its timestamp and a human-readable message.
      properties:
        whenErroredUnixMs:
          type: integer
          format: int64
          description: The unix timestamp in ms when the error occurred. This is an
            approximate time and so should not be used for precise timing.
        message:
          type: string
          description: A human-readable message describing the error.
    ReplicationReplicateDetailsReplicaStatus:
      type: object
      description: Represents the current or historical status of a shard replica
        involved in a replication operation, including its operational state and any
        associated errors.
      properties:
        state:
          type: string
          description: The current operational state of the replica during the replication
            process.
          enum:
          - REGISTERED
          - HYDRATING
          - FINALIZING
          - DEHYDRATING
          - READY
          - CANCELLED
        whenStartedUnixMs:
          type: integer
          format: int64
          description: The UNIX timestamp in ms when this state was first entered.
            This is an approximate time and so should not be used for precise timing.
        errors:
          type: array
          description: A list of error messages encountered by this replica during
            the replication operation, if any.
          items:
            $ref: '#/components/schemas/ReplicationReplicateDetailsReplicaStatusError'
    ReplicationReplicateDetailsReplicaResponse:
      description: Provides a comprehensive overview of a specific replication operation,
        detailing its unique ID, the involved collection, shard, source and target
        nodes, transfer type, current status, and optionally, its status history.
      required:
      - id
      - shard
      - sourceNode
      - targetNode
      - collection
      - status
      - type
      properties:
        id:
          type: string
          format: uuid
          description: The unique identifier (ID) of this specific replication operation.
        shard:
          type: string
          description: The name of the shard involved in this replication operation.
        collection:
          type: string
          description: The name of the collection to which the shard being replicated
            belongs.
        sourceNode:
          type: string
          description: The identifier of the node from which the replica is being
            moved or copied (the source node).
        targetNode:
          type: string
          description: The identifier of the node to which the replica is being moved
            or copied (the target node).
        type:
          type: string
          description: Indicates whether the operation is a `COPY` (source replica
            remains) or a `MOVE` (source replica is removed after successful transfer).
          enum:
          - COPY
          - MOVE
        uncancelable:
          type: boolean
          description: Whether the replica operation can't be cancelled.
        scheduledForCancel:
          type: boolean
          description: Whether the replica operation is scheduled for cancellation.
        scheduledForDelete:
          type: boolean
          description: Whether the replica operation is scheduled for deletion.
        status:
          $ref: '#/components/schemas/ReplicationReplicateDetailsReplicaStatus'
        statusHistory:
          type: array
          description: An array detailing the historical sequence of statuses the
            replication operation has transitioned through, if requested and available.
          items:
            $ref: '#/components/schemas/ReplicationReplicateDetailsReplicaStatus'
        whenStartedUnixMs:
          type: integer
          format: int64
          description: The UNIX timestamp in ms when the replication operation was
            initiated. This is an approximate time and so should not be used for precise
            timing.
    ReplicationReplicateForceDeleteRequest:
      type: object
      description: Specifies the parameters available when force deleting replication
        operations.
      properties:
        id:
          type: string
          format: uuid
          description: The unique identifier (ID) of the replication operation to
            be forcefully deleted.
        collection:
          type: string
          description: The name of the collection to which the shard being replicated
            belongs.
        shard:
          type: string
          description: The identifier of the shard involved in the replication operations.
        node:
          type: string
          description: The name of the target node where the replication operations
            are registered.
        dryRun:
          type: boolean
          description: If true, the operation will not actually delete anything but
            will return the expected outcome of the deletion.
          default: false
    ReplicationReplicateForceDeleteResponse:
      type: object
      description: Provides the UUIDs that were successfully force deleted as part
        of the replication operation. If dryRun is true, this will return the expected
        outcome without actually deleting anything.
      properties:
        deleted:
          type: array
          description: The unique identifiers (IDs) of the replication operations
            that were forcefully deleted.
          items:
            type: string
            format: uuid
        dryRun:
          type: boolean
          description: Indicates whether the operation was a dry run (true) or an
            actual deletion (false).
    PeerUpdate:
      description: A single peer in the network.
      properties:
        id:
          type: string
          format: uuid
          description: The session ID of the peer.
        name:
          type: string
          description: Human readable name.
        uri:
          type: string
          format: uri
          description: The location where the peer is exposed to the internet.
        schemaHash:
          type: string
          description: The latest known hash of the peer's schema.
    VectorWeights:
      type: object
      description: 'Allow custom overrides of vector weights as math expressions.
        E.g. `pancake`: `7` will set the weight for the word pancake to 7 in the vectorization,
        whereas `w * 3` would triple the originally calculated word. This is an open
        object, with OpenAPI Specification 3.0 this will be more detailed. See Weaviate
        docs for more info. In the future this will become a key/value (string/string)
        object.'
    PropertySchema:
      type: object
      description: Names and values of an individual property. A returned response
        may also contain additional metadata, such as from classification or feature
        projection.
    Schema:
      type: object
      description: 'Definitions of semantic schemas (also see: https://github.com/weaviate/weaviate-semantic-schemas).'
      properties:
        classes:
          type: array
          description: Semantic classes that are available.
          items:
            $ref: '#/components/schemas/Class'
        maintainer:
          type: string
          format: email
          description: Email of the maintainer.
        name:
          type: string
          description: Name of the schema.
    Class:
      type: object
      properties:
        class:
          type: string
          description: Name of the collection (formerly 'class') (required). Multiple
            words should be concatenated in CamelCase, e.g. `ArticleAuthor`.
        vectorConfig:
          type: object
          description: Configure named vectors. Either use this field or `vectorizer`,
            `vectorIndexType`, and `vectorIndexConfig` fields. Available from `v1.24.0`.
          additionalProperties:
            $ref: '#/components/schemas/VectorConfig'
        vectorIndexType:
          type: string
          description: Name of the vector index type to use for the collection (e.g.
            `hnsw` or `flat`).
        vectorIndexConfig:
          type: object
          description: Vector-index config, that is specific to the type of index
            selected in vectorIndexType
        shardingConfig:
          type: object
          description: Manage how the index should be sharded and distributed in the
            cluster
        replicationConfig:
          $ref: '#/components/schemas/ReplicationConfig'
        invertedIndexConfig:
          $ref: '#/components/schemas/InvertedIndexConfig'
        multiTenancyConfig:
          $ref: '#/components/schemas/MultiTenancyConfig'
        objectTtlConfig:
          $ref: '#/components/schemas/ObjectTtlConfig'
        vectorizer:
          type: string
          description: Specify how the vectors for this collection should be determined.
            The options are either `none` - this means you have to import a vector
            with each object yourself - or the name of a module that provides vectorization
            capabilities, such as `text2vec-weaviate`. If left empty, it will use
            the globally configured default ([`DEFAULT_VECTORIZER_MODULE`](https://docs.weaviate.io/deploy/configuration/env-vars))
            which can itself either be `none` or a specific module.
        moduleConfig:
          type: object
          description: Configuration specific to modules in a collection context.
        description:
          type: string
          description: Description of the collection for metadata purposes.
        properties:
          type: array
          description: Define properties of the collection.
          items:
            $ref: '#/components/schemas/Property'
    Property:
      type: object
      properties:
        dataType:
          type: array
          description: Data type of the property (required). If it starts with a capital
            (for example Person), may be a reference to another type.
          items:
            type: string
        description:
          type: string
          description: Description of the property.
        moduleConfig:
          type: object
          description: Configuration specific to modules in a collection context.
        name:
          type: string
          description: The name of the property (required). Multiple words should
            be concatenated in camelCase, e.g. `nameOfAuthor`.
        indexInverted:
          type: boolean
          description: (Deprecated). Whether to include this property in the inverted
            index. If `false`, this property cannot be used in `where` filters, `bm25`
            or `hybrid` search. <br/><br/>Unrelated to vectorization behavior (deprecated
            as of v1.19; use indexFilterable or/and indexSearchable instead)
        indexFilterable:
          type: boolean
          description: 'Whether to include this property in the filterable, Roaring
            Bitmap index. If `false`, this property cannot be used in `where` filters.
            <br/><br/>Note: Unrelated to vectorization behavior.'
        indexSearchable:
          type: boolean
          description: Optional. Should this property be indexed in the inverted index.
            Defaults to true. Applicable only to properties of data type text and
            text[]. If you choose false, you will not be able to use this property
            in bm25 or hybrid search. This property has no affect on vectorization
            decisions done by modules
        indexRangeFilters:
          type: boolean
          description: Whether to include this property in the filterable, range-based
            Roaring Bitmap index. Provides better performance for range queries compared
            to filterable index in large datasets. Applicable only to properties of
            data type int, number, date.
        tokenization:
          type: string
          description: 'Determines how a property is indexed. This setting applies
            to `text` and `text[]` data types. The following tokenization methods
            are available:<br/><br/>- `word` (default): Splits the text on any non-alphanumeric
            characters and lowercases the tokens.<br/>- `lowercase`: Splits the text
            on whitespace and lowercases the tokens.<br/>- `whitespace`: Splits the
            text on whitespace. This tokenization is case-sensitive.<br/>- `field`:
            Indexes the entire property value as a single token after trimming whitespace.<br/>-
            `trigram`: Splits the property into rolling trigrams (three-character
            sequences).<br/>- `gse`: Uses the `gse` tokenizer, suitable for Chinese
            language text. [See `gse` docs](https://pkg.go.dev/github.com/go-ego/gse#section-readme).<br/>-
            `kagome_ja`: Uses the `Kagome` tokenizer with a Japanese (IPA) dictionary.
            [See `kagome` docs](https://github.com/ikawaha/kagome).<br/>- `kagome_kr`:
            Uses the `Kagome` tokenizer with a Korean dictionary. [See `kagome` docs](https://github.com/ikawaha/kagome).<br/><br/>See
            [Reference: Tokenization](https://docs.weaviate.io/weaviate/config-refs/collections#tokenization)
            for details.'
          enum:
          - word
          - lowercase
          - whitespace
          - field
          - trigram
          - gse
          - kagome_kr
          - kagome_ja
          - gse_ch
        nestedProperties:
          type: array
          description: The properties of the nested object(s). Applies to object and
            object[] data types.
          items:
            $ref: '#/components/schemas/NestedProperty'
        disableDuplicatedReferences:
          type: boolean
          description: If set to false, allows multiple references to the same target
            object within this property. Setting it to true will enforce uniqueness
            of references within this property. By default, this is set to true.
          default: true
        textAnalyzer:
          $ref: '#/components/schemas/TextAnalyzerConfig'
    TextAnalyzerConfig:
      type: object
      description: Text analysis options for a property. These settings are immutable
        after the property is created. Applies only to text and text[] data types
        that use an inverted index (searchable or filterable).
      properties:
        asciiFold:
          type: boolean
          description: If true, accent/diacritic marks are folded to their base characters
            during indexing and search. For example, 'école' matches 'ecole'. Defaults
            to false.
        asciiFoldIgnore:
          type: array
          description: If provided, specifies a list of characters that should be
            excluded from ascii folding. For example, if ['é'] is provided, then 'é'
            will not be folded to 'e' during indexing and search. This list is immutable
            after the property is created.
          items:
            type: string
        stopwordPreset:
          type: string
          description: Stopword preset name. Overrides the collection-level invertedIndexConfig.stopwords
            for this property. Only applies to properties using 'word' tokenization.
            Can be a built-in preset ('en', 'none') or a user-defined preset from
            invertedIndexConfig.stopwordPresets.
    VectorConfig:
      type: object
      properties:
        vectorizer:
          type: object
          description: Configuration of a specific vectorizer used by this vector
        vectorIndexType:
          type: string
          description: Name of the vector index to use, eg. (HNSW)
        vectorIndexConfig:
          type: object
          description: Vector-index config, that is specific to the type of index
            selected in vectorIndexType
    NestedProperty:
      type: object
      properties:
        dataType:
          type: array
          items:
            type: string
        description:
          type: string
        name:
          type: string
        indexFilterable:
          type: boolean
        indexSearchable:
          type: boolean
        indexRangeFilters:
          type: boolean
        tokenization:
          type: string
          enum:
          - word
          - lowercase
          - whitespace
          - field
          - trigram
          - gse
          - kagome_kr
          - kagome_ja
          - gse_ch
        nestedProperties:
          type: array
          description: The properties of the nested object(s). Applies to object and
            object[] data types.
          items:
            $ref: '#/components/schemas/NestedProperty'
        textAnalyzer:
          $ref: '#/components/schemas/TextAnalyzerConfig'
    ShardStatusList:
      type: array
      description: The status of all the shards of a Class
      items:
        $ref: '#/components/schemas/ShardStatusGetResponse'
    ShardStatusGetResponse:
      description: Response body of shard status get request
      properties:
        name:
          type: string
          description: Name of the shard
        status:
          type: string
          description: Status of the shard
        vectorQueueSize:
          type: integer
          description: Size of the vector queue of the shard
    ShardStatus:
      description: The status of a single shard
      properties:
        status:
          type: string
          description: Status of the shard
    BackupCreateStatusResponse:
      description: The definition of a backup create metadata
      properties:
        id:
          type: string
          description: The ID of the backup. Must be URL-safe and work as a filesystem
            path, only lowercase, numbers, underscore, minus characters allowed.
        backend:
          type: string
          description: Backup backend name e.g. filesystem, gcs, s3.
        path:
          type: string
          description: Destination path of backup files valid for the selected backend.
        error:
          type: string
          description: error message if creation failed
        status:
          type: string
          description: phase of backup creation process
          enum:
          - STARTED
          - TRANSFERRING
          - TRANSFERRED
          - FINALIZING
          - SUCCESS
          - FAILED
          - CANCELLING
          - CANCELED
          default: STARTED
        startedAt:
          type: string
          format: date-time
          description: Timestamp when the backup process started
        completedAt:
          type: string
          format: date-time
          description: Timestamp when the backup process completed (successfully or
            with failure)
        size:
          type: number
          format: float64
          description: Size of the backup in Gibs
    BackupRestoreStatusResponse:
      description: The definition of a backup restore metadata.
      properties:
        id:
          type: string
          description: The ID of the backup. Must be URL-safe and work as a filesystem
            path, only lowercase, numbers, underscore, minus characters allowed.
        backend:
          type: string
          description: Backup backend name e.g. filesystem, gcs, s3.
        path:
          type: string
          description: Destination path of backup files valid for the selected backup
            backend, contains bucket and path.
        error:
          type: string
          description: Error message if backup restoration failed.
        status:
          type: string
          description: Phase of backup restoration process.
          enum:
          - STARTED
          - TRANSFERRING
          - TRANSFERRED
          - FINALIZING
          - SUCCESS
          - FAILED
          - CANCELLING
          - CANCELED
          default: STARTED
    BackupConfig:
      type: object
      description: Backup custom configuration.
      properties:
        Endpoint:
          type: string
          description: Name of the endpoint, e.g. s3.amazonaws.com.
        Bucket:
          type: string
          description: Name of the bucket, container, volume, etc.
        Path:
          type: string
          description: Path or key within the bucket.
        CPUPercentage:
          type: integer
          description: Desired CPU core utilization ranging from 1%-80%
          default: 50
          minimum: 1
          maximum: 80
        ChunkSize:
          type: integer
          description: Deprecated, has no effect.
        CompressionLevel:
          type: string
          description: compression level used by compression algorithm
          enum:
          - DefaultCompression
          - BestSpeed
          - BestCompression
          - ZstdDefaultCompression
          - ZstdBestSpeed
          - ZstdBestCompression
          - NoCompression
          default: DefaultCompression
    RestoreConfig:
      type: object
      description: Backup custom configuration
      properties:
        Endpoint:
          type: string
          description: name of the endpoint, e.g. s3.amazonaws.com
        Bucket:
          type: string
          description: Name of the bucket, container, volume, etc
        Path:
          type: string
          description: Path within the bucket
        CPUPercentage:
          type: integer
          description: Desired CPU core utilization ranging from 1%-80%
          default: 50
          minimum: 1
          maximum: 80
        rolesOptions:
          type: string
          description: How roles should be restored
          enum:
          - noRestore
          - all
          default: noRestore
        usersOptions:
          type: string
          description: How users should be restored
          enum:
          - noRestore
          - all
          default: noRestore
    BackupCreateRequest:
      description: Request body for creating a backup for a set of collections.
      properties:
        id:
          type: string
          description: The ID of the backup (required). Must be URL-safe and work
            as a filesystem path, only lowercase, numbers, underscore, minus characters
            allowed.
        config:
          $ref: '#/components/schemas/BackupConfig'
        include:
          type: array
          description: List of collections to include in the backup creation process.
            If not set, all collections are included. Cannot be used together with
            `exclude`.
          items:
            type: string
        exclude:
          type: array
          description: List of collections to exclude from the backup creation process.
            If not set, all collections are included. Cannot be used together with
            `include`.
          items:
            type: string
        incremental_base_backup_id:
          type: string
          description: The ID of an existing backup to use as the base for a file-based
            incremental backup. If set, only files that have changed since the base
            backup will be included in the new backup.
          default: null
    BackupCreateResponse:
      description: The definition of a backup create response body
      properties:
        id:
          type: string
          description: The ID of the backup. Must be URL-safe and work as a filesystem
            path, only lowercase, numbers, underscore, minus characters allowed.
        classes:
          type: array
          description: The list of collections (classes) for which the backup creation
            process was started.
          items:
            type: string
        backend:
          type: string
          description: Backup backend name e.g. filesystem, gcs, s3.
        bucket:
          type: string
          description: Name of the bucket, container, volume, etc
        path:
          type: string
          description: Path within bucket of backup
        error:
          type: string
          description: error message if creation failed
        status:
          type: string
          description: phase of backup creation process
          enum:
          - STARTED
          - TRANSFERRING
          - TRANSFERRED
          - FINALIZING
          - SUCCESS
          - FAILED
          - CANCELLING
          - CANCELED
          default: STARTED
    BackupListResponse:
      type: array
      description: The definition of a backup create response body.
      items:
        type: object
        properties:
          id:
            type: string
            description: The ID of the backup. Must be URL-safe and work as a filesystem
              path, only lowercase, numbers, underscore, minus characters allowed.
          classes:
            type: array
            description: The list of collections (classes) for which the backup process
              was started.
            items:
              type: string
          status:
            type: string
            description: Status of backup process.
            enum:
            - STARTED
            - TRANSFERRING
            - TRANSFERRED
            - FINALIZING
            - SUCCESS
            - FAILED
            - CANCELLING
            - CANCELED
          startedAt:
            type: string
            format: date-time
            description: Timestamp when the backup process started
          completedAt:
            type: string
            format: date-time
            description: Timestamp when the backup process completed (successfully
              or with failure)
          size:
            type: number
            format: float64
            description: Size of the backup in Gibs
    BackupRestoreRequest:
      description: Request body for restoring a backup for a set of collections (classes).
      properties:
        config:
          $ref: '#/components/schemas/RestoreConfig'
        include:
          type: array
          description: List of collections (classes) to include in the backup restoration
            process.
          items:
            type: string
        exclude:
          type: array
          description: List of collections (classes) to exclude from the backup restoration
            process.
          items:
            type: string
        node_mapping:
          type: object
          description: Allows overriding the node names stored in the backup with
            different ones. Useful when restoring backups to a different environment.
          additionalProperties:
            type: string
        overwriteAlias:
          type: boolean
          description: Allows ovewriting the collection alias if there is a conflict
    BackupRestoreResponse:
      description: The definition of a backup restore response body.
      properties:
        id:
          type: string
          description: The ID of the backup. Must be URL-safe and work as a filesystem
            path, only lowercase, numbers, underscore, minus characters allowed.
        classes:
          type: array
          description: The list of collections (classes) for which the backup restoration
            process was started.
          items:
            type: string
        backend:
          type: string
          description: Backup backend name e.g. filesystem, gcs, s3.
        path:
          type: string
          description: Destination path of backup files valid for the selected backend.
        error:
          type: string
          description: Error message if backup restoration failed.
        status:
          type: string
          description: Phase of backup restoration process.
          enum:
          - STARTED
          - TRANSFERRING
          - TRANSFERRED
          - FINALIZING
          - SUCCESS
          - FAILED
          - CANCELLING
          - CANCELED
          default: STARTED
    NodeStats:
      description: The summary of Weaviate's statistics.
      properties:
        shardCount:
          type: number
          format: int
          description: The count of Weaviate's shards. To see this value, set `output`
            to `verbose`.
        objectCount:
          type: number
          format: int64
          description: The total number of objects in DB.
    BatchStats:
      description: The summary of a nodes batch queue congestion status.
      properties:
        queueLength:
          type: number
          format: int
          description: How many objects are currently in the batch queue.
        ratePerSecond:
          type: number
          format: int
          description: How many objects are approximately processed from the batch
            queue per second.
    NodeShardStatus:
      description: The definition of a node shard status response body
      properties:
        name:
          type: string
          description: The name of the shard.
        class:
          type: string
          description: The name of shard's collection (class).
        objectCount:
          type: number
          format: int64
          description: The number of objects in shard.
        vectorIndexingStatus:
          type: string
          description: The status of the vector indexing process.
        compressed:
          type: boolean
          description: The status of vector compression/quantization.
        vectorQueueLength:
          type: number
          format: int64
          description: The length of the vector indexing queue.
        loaded:
          type: boolean
          description: The load status of the shard.
        asyncReplicationStatus:
          type: array
          description: The status of the async replication.
          items:
            $ref: '#/components/schemas/AsyncReplicationStatus'
        numberOfReplicas:
          type:
          - integer
          - 'null'
          format: int64
          description: Number of replicas for the shard.
        replicationFactor:
          type:
          - integer
          - 'null'
          format: int64
          description: Minimum number of replicas for the shard.
    AsyncReplicationStatus:
      description: The status of the async replication.
      properties:
        objectsPropagated:
          type: number
          format: uint64
          description: The number of objects propagated in the most recent iteration.
        startDiffTimeUnixMillis:
          type: number
          format: int64
          description: The start time of the most recent iteration.
        targetNode:
          type: string
          description: The target node of the replication, if set, otherwise empty.
    ReplicationAsyncConfig:
      type: object
      description: Configuration for asynchronous replication.
      properties:
        maxWorkers:
          type: integer
          format: int64
          description: Maximum number of async replication workers.
        hashtreeHeight:
          type: integer
          format: int64
          description: Height of the hashtree used for diffing.
        frequency:
          type: integer
          format: int64
          description: Base frequency in milliseconds at which async replication runs
            diff calculations.
        frequencyWhilePropagating:
          type: integer
          format: int64
          description: Frequency in milliseconds at which async replication runs while
            propagation is active.
        aliveNodesCheckingFrequency:
          type: integer
          format: int64
          description: Interval in milliseconds at which liveness of target nodes
            is checked.
        loggingFrequency:
          type: integer
          format: int64
          description: Interval in seconds at which async replication logs its status.
        diffBatchSize:
          type: integer
          format: int64
          description: Maximum number of object keys included in a single diff batch.
        diffPerNodeTimeout:
          type: integer
          format: int64
          description: Timeout in seconds for computing a diff against a single node.
        prePropagationTimeout:
          type: integer
          format: int64
          description: Overall timeout in seconds for the pre-propagation phase.
        propagationTimeout:
          type: integer
          format: int64
          description: Timeout in seconds for propagating batch of changes to a node.
        propagationLimit:
          type: integer
          format: int64
          description: Maximum number of objects to propagate in a single async replication
            run.
        propagationDelay:
          type: integer
          format: int64
          description: Delay in milliseconds before newly added or updated objects
            are propagated.
        propagationConcurrency:
          type: integer
          format: int64
          description: Maximum number of concurrent propagation workers.
        propagationBatchSize:
          type: integer
          format: int64
          description: Number of objects to include in a single propagation batch.
    NodeStatus:
      description: The definition of a backup node status response body
      properties:
        name:
          type: string
          description: The name of the node.
        status:
          type: string
          description: Node's status.
          enum:
          - HEALTHY
          - UNHEALTHY
          - UNAVAILABLE
          - TIMEOUT
          default: HEALTHY
        version:
          type: string
          description: The version of Weaviate.
        gitHash:
          type: string
          description: The gitHash of Weaviate.
        stats:
          $ref: '#/components/schemas/NodeStats'
        batchStats:
          $ref: '#/components/schemas/BatchStats'
        shards:
          type: array
          description: The list of the shards with it's statistics.
          items:
            $ref: '#/components/schemas/NodeShardStatus'
        operationalMode:
          type: string
          description: Which mode of operation the node is running in.
          enum:
          - ReadWrite
          - WriteOnly
          - ReadOnly
          - ScaleOut
    NodesStatusResponse:
      type: object
      description: The status of all of the Weaviate nodes
      properties:
        nodes:
          type: array
          items:
            $ref: '#/components/schemas/NodeStatus'
    DistributedTask:
      type: object
      description: Distributed task metadata.
      properties:
        id:
          type: string
          description: The ID of the task.
        version:
          type: integer
          description: The version of the task.
        status:
          type: string
          description: The status of the task.
        startedAt:
          type: string
          format: date-time
          description: The time when the task was created.
        finishedAt:
          type: string
          format: date-time
          description: The time when the task was finished.
        finishedNodes:
          type: array
          description: The nodes that finished the task.
          items:
            type: string
        error:
          type: string
          description: The high level reason why the task failed.
        payload:
          type: object
          description: The payload of the task.
        units:
          type: array
          description: Units of the task. Only present for tasks that use unit tracking.
          items:
            $ref: '#/components/schemas/DistributedTaskUnit'
    DistributedTaskUnit:
      type: object
      description: A unit of a distributed task.
      properties:
        id:
          type: string
          description: The ID of the unit.
        nodeId:
          type: string
          description: The node that owns this unit.
        status:
          type: string
          description: The status of the unit.
        progress:
          type: number
          format: float
          description: The progress of the unit (0.0 to 1.0).
        error:
          type: string
          description: The error message if the unit failed.
        updatedAt:
          type: string
          format: date-time
          description: The time when the unit was last updated.
        finishedAt:
          type: string
          format: date-time
          description: The time when the unit finished.
    DistributedTasks:
      type: object
      description: Active distributed tasks by namespace.
      additionalProperties:
        type: array
        items:
          $ref: '#/components/schemas/DistributedTask'
    RaftStatistics:
      description: The definition of Raft statistics.
      properties:
        appliedIndex:
          type: string
        commitIndex:
          type: string
        fsmPending:
          type: string
        lastContact:
          type: string
        lastLogIndex:
          type: string
        lastLogTerm:
          type: string
        lastSnapshotIndex:
          type: string
        lastSnapshotTerm:
          type: string
        latestConfiguration:
          type: object
          description: Weaviate Raft nodes.
        latestConfigurationIndex:
          type: string
        numPeers:
          type: string
        protocolVersion:
          type: string
        protocolVersionMax:
          type: string
        protocolVersionMin:
          type: string
        snapshotVersionMax:
          type: string
        snapshotVersionMin:
          type: string
        state:
          type: string
        term:
          type: string
    Statistics:
      description: The definition of node statistics.
      properties:
        name:
          type: string
          description: The name of the node.
        status:
          type: string
          description: Node's status.
          enum:
          - HEALTHY
          - UNHEALTHY
          - UNAVAILABLE
          - TIMEOUT
          default: HEALTHY
        bootstrapped:
          type: boolean
        dbLoaded:
          type: boolean
        initialLastAppliedIndex:
          type: number
          format: uint64
        lastAppliedIndex:
          type: number
        isVoter:
          type: boolean
        leaderId:
          type: object
        leaderAddress:
          type: object
        open:
          type: boolean
        ready:
          type: boolean
        candidates:
          type: object
        raft:
          $ref: '#/components/schemas/RaftStatistics'
    ClusterStatisticsResponse:
      type: object
      description: The cluster statistics of all of the Weaviate nodes
      properties:
        statistics:
          type: array
          items:
            $ref: '#/components/schemas/Statistics'
        synchronized:
          type: boolean
    SingleRef:
      description: Either set beacon (direct reference) or set collection (class)
        and schema (concept reference)
      properties:
        class:
          type: string
          format: uri
          description: If using a concept reference (rather than a direct reference),
            specify the desired collection (class) name here.
        schema:
          $ref: '#/components/schemas/PropertySchema'
        beacon:
          type: string
          format: uri
          description: If using a direct reference, specify the URI to point to the
            cross-reference here. Should be in the form of weaviate://localhost/<uuid>
            for the example of a local cross-reference to an object
        href:
          type: string
          format: uri
          description: If using a direct reference, this read-only fields provides
            a link to the referenced resource. If 'origin' is globally configured,
            an absolute URI is shown - a relative URI otherwise.
        classification:
          $ref: '#/components/schemas/ReferenceMetaClassification'
    AdditionalProperties:
      type: object
      description: (Response only) Additional meta information about a single object.
      additionalProperties:
        type: object
    ReferenceMetaClassification:
      description: This meta field contains additional info about the classified reference
        property
      properties:
        overallCount:
          type: number
          format: int64
          description: overall neighbors checked as part of the classification. In
            most cases this will equal k, but could be lower than k - for example
            if not enough data was present
        winningCount:
          type: number
          format: int64
          description: size of the winning group, a number between 1..k
        losingCount:
          type: number
          format: int64
          description: size of the losing group, can be 0 if the winning group size
            equals k
        closestOverallDistance:
          type: number
          format: float32
          description: The lowest distance of any neighbor, regardless of whether
            they were in the winning or losing group
        winningDistance:
          type: number
          format: float32
          description: deprecated - do not use, to be removed in 0.23.0
        meanWinningDistance:
          type: number
          format: float32
          description: Mean distance of all neighbors from the winning group
        closestWinningDistance:
          type: number
          format: float32
          description: Closest distance of a neighbor from the winning group
        closestLosingDistance:
          type: number
          format: float32
          description: The lowest distance of a neighbor in the losing group. Optional.
            If k equals the size of the winning group, there is no losing group
        losingDistance:
          type: number
          format: float32
          description: deprecated - do not use, to be removed in 0.23.0
        meanLosingDistance:
          type: number
          format: float32
          description: Mean distance of all neighbors from the losing group. Optional.
            If k equals the size of the winning group, there is no losing group.
    BatchReference:
      properties:
        from:
          type: string
          format: uri
          description: Long-form beacon-style URI to identify the source of the cross-reference,
            including the property name. Should be in the form of `weaviate://localhost/objects/<uuid>/<className>/<propertyName>`,
            where `<className>` and `<propertyName>` must represent the cross-reference
            property of the source class to be used.
          example: weaviate://localhost/Zoo/a5d09582-4239-4702-81c9-92a6e0122bb4/hasAnimals
        to:
          type: string
          format: uri
          description: Short-form URI to point to the cross-reference. Should be in
            the form of `weaviate://localhost/<uuid>` for the example of a local cross-reference
            to an object.
          example: weaviate://localhost/97525810-a9a5-4eb0-858a-71449aeb007f
        tenant:
          type: string
          description: Name of the reference tenant.
    BatchReferenceResponse:
      allOf:
      - $ref: '#/components/schemas/BatchReference'
      - properties:
          result:
            format: object
            description: Results for this specific reference.
            properties:
              status:
                type: string
                enum:
                - SUCCESS
                - FAILED
                default: SUCCESS
              errors:
                $ref: '#/components/schemas/ErrorResponse'
    GeoCoordinates:
      properties:
        latitude:
          type: number
          format: float
          description: The latitude of the point on earth in decimal form.
        longitude:
          type: number
          format: float
          description: The longitude of the point on earth in decimal form.
    PhoneNumber:
      properties:
        input:
          type: string
          description: The raw input as the phone number is present in your raw data
            set. It will be parsed into the standardized formats if valid.
        internationalFormatted:
          type: string
          description: Read-only. Parsed result in the international format (e.g.
            `+49 123 456789`).
        defaultCountry:
          type: string
          description: Optional. The ISO 3166-1 alpha-2 country code. This is used
            to figure out the correct `countryCode` and international format if only
            a national number (e.g. `0123 4567`) is provided.
        countryCode:
          type: number
          format: uint64
          description: Read-only. The numerical country code (e.g. `49`).
        national:
          type: number
          format: uint64
          description: Read-only. The numerical representation of the national part.
        nationalFormatted:
          type: string
          description: Read-only. Parsed result in the national format (e.g. `0123
            456789`).
        valid:
          type: boolean
          description: Read-only. Indicates whether the parsed number is a valid phone
            number.
    Object:
      type: object
      properties:
        class:
          type: string
          description: Name of the collection (class) the object belongs to.
        vectorWeights:
          $ref: '#/components/schemas/VectorWeights'
        properties:
          $ref: '#/components/schemas/PropertySchema'
        id:
          type: string
          format: uuid
          description: The UUID of the object.
        creationTimeUnix:
          type: integer
          format: int64
          description: (Response only) Timestamp of creation of this object in milliseconds
            since epoch UTC.
        lastUpdateTimeUnix:
          type: integer
          format: int64
          description: (Response only) Timestamp of the last object update in milliseconds
            since epoch UTC.
        vector:
          $ref: '#/components/schemas/C11yVector'
        vectors:
          $ref: '#/components/schemas/Vectors'
        tenant:
          type: string
          description: The name of the tenant the object belongs to.
        additional:
          $ref: '#/components/schemas/AdditionalProperties'
    ObjectsGetResponse:
      allOf:
      - $ref: '#/components/schemas/Object'
      - properties:
          deprecations:
            type: array
            items:
              $ref: '#/components/schemas/Deprecation'
      - properties:
          result:
            format: object
            description: Results for this specific object.
            properties:
              status:
                type: string
                enum:
                - SUCCESS
                - FAILED
                default: SUCCESS
              errors:
                $ref: '#/components/schemas/ErrorResponse'
    BatchDelete:
      type: object
      properties:
        match:
          type: object
          description: Outlines how to find the objects to be deleted.
          properties:
            class:
              type: string
              description: The name of the collection (class) from which to delete
                objects.
              example: City
            where:
              $ref: '#/components/schemas/WhereFilter'
        output:
          type: string
          description: 'Controls the verbosity of the output, possible values are:
            `minimal`, `verbose`. Defaults to `minimal`.'
          default: minimal
        deletionTimeUnixMilli:
          type: integer
          format: int64
          description: Timestamp of deletion in milliseconds since epoch UTC.
        dryRun:
          type: boolean
          description: If true, the call will show which objects would be matched
            using the specified filter without deleting any objects. <br/><br/>Depending
            on the configured verbosity, you will either receive a count of affected
            objects, or a list of IDs.
          default: false
    BatchDeleteResponse:
      type: object
      description: Delete Objects response.
      properties:
        match:
          type: object
          description: Outlines how to find the objects to be deleted.
          properties:
            class:
              type: string
              description: The name of the collection (class) from which to delete
                objects.
              example: City
            where:
              $ref: '#/components/schemas/WhereFilter'
        output:
          type: string
          description: 'Controls the verbosity of the output, possible values are:
            `minimal`, `verbose`. Defaults to `minimal`.'
          default: minimal
        deletionTimeUnixMilli:
          type: integer
          format: int64
          description: Timestamp of deletion in milliseconds since epoch UTC.
        dryRun:
          type: boolean
          description: If true, objects will not be deleted yet, but merely listed.
            Defaults to false.
          default: false
        results:
          type: object
          properties:
            matches:
              type: number
              format: int64
              description: How many objects were matched by the filter.
            limit:
              type: number
              format: int64
              description: The most amount of objects that can be deleted in a single
                query, equals [`QUERY_MAXIMUM_RESULTS`](https://docs.weaviate.io/deploy/configuration/env-vars#QUERY_MAXIMUM_RESULTS).
            successful:
              type: number
              format: int64
              description: How many objects were successfully deleted in this round.
            failed:
              type: number
              format: int64
              description: How many objects should have been deleted but could not
                be deleted.
            objects:
              type: array
              description: With output set to `minimal` only objects with error occurred
                will the be described. Successfully deleted objects would be omitted.
                Output set to `verbose` will list all of the objects with their respective
                statuses.
              items:
                format: object
                description: Results for this specific Object.
                properties:
                  id:
                    type: string
                    format: uuid
                    description: The UUID of the object.
                  status:
                    type: string
                    enum:
                    - SUCCESS
                    - DRYRUN
                    - FAILED
                    default: SUCCESS
                  errors:
                    $ref: '#/components/schemas/ErrorResponse'
    ObjectsListResponse:
      type: object
      description: List of objects.
      properties:
        objects:
          type: array
          description: The actual list of objects.
          items:
            $ref: '#/components/schemas/Object'
        deprecations:
          type: array
          items:
            $ref: '#/components/schemas/Deprecation'
        totalResults:
          type: integer
          format: int64
          description: The total number of objects for the query. The number of items
            in a response may be smaller due to paging.
    Classification:
      type: object
      description: Manage classifications, trigger them and view status of past classifications.
      properties:
        id:
          type: string
          format: uuid
          description: ID to uniquely identify this classification run.
          example: ee722219-b8ec-4db1-8f8d-5150bb1a9e0c
        class:
          type: string
          description: The name of the collection (class) which is used in this classification.
          example: City
        classifyProperties:
          type: array
          description: Which ref-property to set as part of the classification.
          example:
          - inCountry
          items:
            type: string
        basedOnProperties:
          type: array
          description: Base the text-based classification on these fields (of type
            text).
          example:
          - description
          items:
            type: string
        status:
          type: string
          description: Status of this classification.
          enum:
          - running
          - completed
          - failed
          example: running
        meta:
          $ref: '#/components/schemas/ClassificationMeta'
        type:
          type: string
          description: Which algorithm to use for classifications.
        settings:
          type: object
          description: Classification-type specific settings.
        error:
          type: string
          description: Error message if status == failed.
          default: ''
          example: 'classify xzy: something went wrong'
        filters:
          type: object
          properties:
            sourceWhere:
              $ref: '#/components/schemas/WhereFilter'
            trainingSetWhere:
              $ref: '#/components/schemas/WhereFilter'
            targetWhere:
              $ref: '#/components/schemas/WhereFilter'
    ClassificationMeta:
      type: object
      description: Additional information to a specific classification.
      properties:
        started:
          type: string
          format: date-time
          description: Time when this classification was started.
          example: '2017-07-21T17:32:28Z'
        completed:
          type: string
          format: date-time
          description: Time when this classification finished.
          example: '2017-07-21T17:32:28Z'
        count:
          type: integer
          description: Number of objects which were taken into consideration for classification.
          example: 147
        countSucceeded:
          type: integer
          description: Number of objects successfully classified.
          example: 140
        countFailed:
          type: integer
          description: Number of objects which could not be classified - see error
            message for details.
          example: 7
    WhereFilter:
      type: object
      description: Filter search results using a where filter.
      properties:
        operands:
          type: array
          description: Combine multiple where filters, requires 'And' or 'Or' operator.
          items:
            $ref: '#/components/schemas/WhereFilter'
        operator:
          type: string
          description: Operator to use.
          enum:
          - And
          - Or
          - Equal
          - Like
          - NotEqual
          - GreaterThan
          - GreaterThanEqual
          - LessThan
          - LessThanEqual
          - WithinGeoRange
          - IsNull
          - ContainsAny
          - ContainsAll
          - ContainsNone
          - Not
          example: GreaterThanEqual
        path:
          type: array
          description: Path to the property currently being filtered.
          example:
          - inCity
          - city
          - name
          items:
            type: string
        valueInt:
          type: integer
          format: int64
          description: value as integer
          example: 2000
        valueNumber:
          type: number
          format: float64
          description: value as number/float
          example: 3.14
        valueBoolean:
          type: boolean
          description: value as boolean
          example: false
        valueString:
          type: string
          description: value as text (deprecated as of v1.19; alias for valueText)
          example: my search term
        valueText:
          type: string
          description: value as text
          example: my search term
        valueDate:
          type: string
          description: value as date (as string)
          example: TODO
        valueIntArray:
          type: array
          description: value as integer
          example: '[100, 200]'
          items:
            type: integer
            format: int64
        valueNumberArray:
          type: array
          description: value as number/float
          example:
          - 3.14
          items:
            type: number
            format: float64
        valueBooleanArray:
          type: array
          description: value as boolean
          example:
          - true
          - false
          items:
            type: boolean
        valueStringArray:
          type: array
          description: value as text (deprecated as of v1.19; alias for valueText)
          example:
          - my search term
          items:
            type: string
        valueTextArray:
          type: array
          description: value as text
          example:
          - my search term
          items:
            type: string
        valueDateArray:
          type: array
          description: value as date (as string)
          example: TODO
          items:
            type: string
        valueGeoRange:
          $ref: '#/components/schemas/WhereFilterGeoRange'
    WhereFilterGeoRange:
      type: object
      description: Filter within a distance of a georange.
      properties:
        geoCoordinates:
          $ref: '#/components/schemas/GeoCoordinates'
        distance:
          type: object
          properties:
            max:
              type: number
              format: float64
    Tenant:
      type: object
      description: Attributes representing a single tenant within Weaviate.
      properties:
        name:
          type: string
          description: The name of the tenant (required).
        activityStatus:
          type: string
          description: 'The activity status of the tenant, which determines if it
            is queryable and where its data is stored.<br/><br/><b>Available Statuses:</b><br/>-
            `ACTIVE`: The tenant is fully operational and ready for queries. Data
            is stored on local, hot storage.<br/>- `INACTIVE`: The tenant is not queryable.
            Data is stored locally.<br/>- `OFFLOADED`: The tenant is inactive and
            its data is stored in a remote cloud backend.<br/><br/><b>Usage Rules:</b><br/>-
            <b>On Create:</b> This field is optional and defaults to `ACTIVE`. Allowed
            values are `ACTIVE` and `INACTIVE`.<br/>- <b>On Update:</b> This field
            is required. Allowed values are `ACTIVE`, `INACTIVE`, and `OFFLOADED`.<br/><br/><b>Read-Only
            Statuses:</b><br/>The following statuses are set by the server and indicate
            a tenant is transitioning between states:<br/>- `OFFLOADING`<br/>- `ONLOADING`<br/><br/><b>Note
            on Deprecated Names:</b><br/>For backward compatibility, deprecated names
            are still accepted and are mapped to their modern equivalents: `HOT` (now
            `ACTIVE`), `COLD` (now `INACTIVE`), `FROZEN` (now `OFFLOADED`), `FREEZING`
            (now `OFFLOADING`), `UNFREEZING` (now `ONLOADING`).'
          enum:
          - ACTIVE
          - INACTIVE
          - OFFLOADED
          - OFFLOADING
          - ONLOADING
          - HOT
          - COLD
          - FROZEN
          - FREEZING
          - UNFREEZING
    Alias:
      type: object
      description: Represents the mapping between an alias name and a collection.
        An alias provides an alternative name for accessing a collection.
      properties:
        alias:
          type: string
          description: The unique name of the alias that serves as an alternative
            identifier for the collection.
        class:
          type: string
          description: The name of the collection (class) to which this alias is mapped.
    AliasResponse:
      type: object
      description: Response object containing a list of alias mappings.
      properties:
        aliases:
          type: array
          description: Array of alias objects, each containing an alias-to-collection
            mapping.
          items:
            $ref: '#/components/schemas/Alias'
    Namespace:
      type: object
      description: A cluster-level namespace used to group resources under a common
        administrative unit. Namespace names must start with a lowercase letter, contain
        only lowercase letters and digits, be 3-36 characters long, and must not be
        a reserved name.
      properties:
        name:
          type: string
          description: The unique name of the namespace.
    NamespaceListResponse:
      type: array
      description: Response object containing a list of namespaces.
      items:
        $ref: '#/components/schemas/Namespace'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: API key authentication
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OIDC/JWT bearer authentication