openapi: 3.1.1
info:
  description: "This OpenAPI specification is a part of the Lance namespace specification.\
    \ It contains 2 parts:\n\nThe `components/schemas`, `components/responses`, `components/examples`,\
    \ `tags` sections define\nthe request and response shape for each operation in\
    \ a Lance Namespace across all implementations.\nSee https://lance.org/format/namespace/operations\
    \ for more details.\n\nThe `servers`, `security`, `paths`, `components/parameters`\
    \ sections are for the \nLance REST Namespace implementation, which defines a\
    \ complete REST server that can work with Lance datasets.\nSee https://lance.org/format/namespace/rest\
    \ for more details.\n"
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  title: Lance Namespace Specification
  version: 1.0.0
servers:
- description: Generic server URL with all parts configurable
  url: "{scheme}://{host}:{port}/{basePath}"
  variables:
    scheme:
      default: http
    host:
      default: localhost
    port:
      default: "2333"
    basePath:
      default: ""
- description: Server URL when the port can be inferred from the scheme
  url: "{scheme}://{host}/{basePath}"
  variables:
    scheme:
      default: http
    host:
      default: localhost
    basePath:
      default: ""
security:
- OAuth2: []
- BearerAuth: []
- ApiKeyAuth: []
tags:
- description: |
    Operations that are related to a namespace
  name: Namespace
- description: |
    Operations that are related to a table
  name: Table
- description: |
    Operations that are related to an index
  name: Index
- description: |
    Operations that are related to tags
  name: Tag
- description: |
    Operations that are related to a transaction
  name: Transaction
- description: |
    Operations that only interact with object metadata and should be computationally lightweight
  name: Metadata
- description: |
    Operations that interact with object data and might be computationally intensive
  name: Data
paths:
  /v1/namespace/{id}/create:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    post:
      description: "Create new namespace `id`.\n\nDuring the creation process, the\
        \ implementation may modify user-provided `properties`, \nsuch as adding additional\
        \ properties like `created_at` to user-provided properties, \nomitting any\
        \ specific property, or performing actions based on any property value.\n"
      operationId: CreateNamespace
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateNamespaceRequest'
        required: true
      responses:
        "200":
          $ref: '#/components/responses/CreateNamespaceResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "406":
          $ref: '#/components/responses/UnsupportedOperationErrorResponse'
        "409":
          $ref: '#/components/responses/ConflictErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Create a new namespace
      tags:
      - Namespace
      - Metadata
      x-content-type: application/json
      x-accepts:
      - application/json
  /v1/namespace/{id}/list:
    get:
      description: |
        List all child namespace names of the parent namespace `id`.

        REST NAMESPACE ONLY
        REST namespace uses GET to perform this operation without a request body.
        It passes in the `ListNamespacesRequest` information in the following way:
        - `id`: pass through path parameter of the same name
        - `page_token`: pass through query parameter of the same name
        - `limit`: pass through query parameter of the same name
      operationId: ListNamespaces
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      - $ref: '#/components/parameters/page_token'
      - $ref: '#/components/parameters/limit'
      responses:
        "200":
          $ref: '#/components/responses/ListNamespacesResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "406":
          $ref: '#/components/responses/UnsupportedOperationErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: List namespaces
      tags:
      - Namespace
      - Metadata
      x-accepts:
      - application/json
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    - $ref: '#/components/parameters/page_token'
    - $ref: '#/components/parameters/limit'
  /v1/namespace/{id}/describe:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    post:
      description: |
        Describe the detailed information for namespace `id`.
      operationId: DescribeNamespace
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeNamespaceRequest'
        required: true
      responses:
        "200":
          $ref: '#/components/responses/DescribeNamespaceResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Describe a namespace
      tags:
      - Namespace
      - Metadata
      x-content-type: application/json
      x-accepts:
      - application/json
  /v1/namespace/{id}/drop:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    post:
      description: |
        Drop namespace `id` from its parent namespace.
      operationId: DropNamespace
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DropNamespaceRequest'
        required: true
      responses:
        "200":
          $ref: '#/components/responses/DropNamespaceResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "409":
          $ref: '#/components/responses/ConflictErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Drop a namespace
      tags:
      - Namespace
      - Metadata
      x-content-type: application/json
      x-accepts:
      - application/json
  /v1/namespace/{id}/exists:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    post:
      description: "Check if namespace `id` exists.\n\nThis operation must behave\
        \ exactly like the DescribeNamespace API, \nexcept it does not contain a response\
        \ body.\n"
      operationId: NamespaceExists
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NamespaceExistsRequest'
        required: true
      responses:
        "200":
          description: "Success, no content"
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Check if a namespace exists
      tags:
      - Namespace
      - Metadata
      x-content-type: application/json
      x-accepts:
      - application/json
  /v1/namespace/{id}/table/list:
    get:
      description: |
        List all child table names of the parent namespace `id`.

        REST NAMESPACE ONLY
        REST namespace uses GET to perform this operation without a request body.
        It passes in the `ListTablesRequest` information in the following way:
        - `id`: pass through path parameter of the same name
        - `page_token`: pass through query parameter of the same name
        - `limit`: pass through query parameter of the same name
      operationId: ListTables
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      - $ref: '#/components/parameters/page_token'
      - $ref: '#/components/parameters/limit'
      responses:
        "200":
          $ref: '#/components/responses/ListTablesResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "406":
          $ref: '#/components/responses/UnsupportedOperationErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: List tables in a namespace
      tags:
      - Namespace
      - Table
      - Metadata
      x-accepts:
      - application/json
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    - $ref: '#/components/parameters/page_token'
    - $ref: '#/components/parameters/limit'
  /v1/table:
    get:
      description: |
        List all tables across all namespaces.

        REST NAMESPACE ONLY
        REST namespace uses GET to perform this operation without a request body.
        It passes in the `ListAllTablesRequest` information in the following way:
        - `page_token`: pass through query parameter of the same name
        - `limit`: pass through query parameter of the same name
        - `delimiter`: pass through query parameter of the same name
      operationId: ListAllTables
      parameters:
      - $ref: '#/components/parameters/delimiter'
      - $ref: '#/components/parameters/page_token'
      - $ref: '#/components/parameters/limit'
      responses:
        "200":
          $ref: '#/components/responses/ListTablesResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: List all tables
      tags:
      - Table
      x-accepts:
      - application/json
  /v1/table/{id}/register:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    post:
      description: |
        Register an existing table at a given storage location as `id`.
      operationId: RegisterTable
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterTableRequest'
        required: true
      responses:
        "200":
          $ref: '#/components/responses/RegisterTableResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "406":
          $ref: '#/components/responses/UnsupportedOperationErrorResponse'
        "409":
          $ref: '#/components/responses/ConflictErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Register a table to a namespace
      tags:
      - Table
      - Metadata
      x-content-type: application/json
      x-accepts:
      - application/json
  /v1/table/{id}/describe:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    - $ref: '#/components/parameters/with_table_uri'
    - $ref: '#/components/parameters/load_detailed_metadata'
    post:
      description: |
        Describe the detailed information for table `id`.

        REST NAMESPACE ONLY
        REST namespace passes `with_table_uri` and `load_detailed_metadata` as query parameters instead of in the request body.
      operationId: DescribeTable
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      - $ref: '#/components/parameters/with_table_uri'
      - $ref: '#/components/parameters/load_detailed_metadata'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeTableRequest'
        required: true
      responses:
        "200":
          $ref: '#/components/responses/DescribeTableResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Describe information of a table
      tags:
      - Table
      - Metadata
      x-content-type: application/json
      x-accepts:
      - application/json
  /v1/table/{id}/exists:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    post:
      description: "Check if table `id` exists.\n\nThis operation should behave exactly\
        \ like DescribeTable, \nexcept it does not contain a response body.\n\nFor\
        \ DirectoryNamespace implementation, a table exists if either:\n- The table\
        \ has Lance data versions (regular table created with CreateTable)\n- A `.lance-reserved`\
        \ file exists in the table directory (declared table created with DeclareTable)\n"
      operationId: TableExists
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TableExistsRequest'
        required: true
      responses:
        "200":
          description: "Success, no content"
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Check if a table exists
      tags:
      - Table
      - Metadata
      x-content-type: application/json
      x-accepts:
      - application/json
  /v1/table/{id}/drop:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    post:
      description: |
        Drop table `id` and delete its data.

        REST NAMESPACE ONLY
        REST namespace does not use a request body for this operation.
        The `DropTableRequest` information is passed in the following way:
        - `id`: pass through path parameter of the same name
      operationId: DropTable
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      responses:
        "200":
          $ref: '#/components/responses/DropTableResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Drop a table
      tags:
      - Table
      - Metadata
      x-accepts:
      - application/json
  /v1/table/{id}/deregister:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    post:
      description: |
        Deregister table `id` from its namespace.
      operationId: DeregisterTable
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeregisterTableRequest'
        required: true
      responses:
        "200":
          $ref: '#/components/responses/DeregisterTableResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Deregister a table
      tags:
      - Table
      - Metadata
      x-content-type: application/json
      x-accepts:
      - application/json
  /v1/table/{id}/restore:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    post:
      description: |
        Restore table `id` to a specific version.
      operationId: RestoreTable
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestoreTableRequest'
        required: true
      responses:
        "200":
          $ref: '#/components/responses/RestoreTableResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Restore table to a specific version
      tags:
      - Table
      - Metadata
      x-content-type: application/json
      x-accepts:
      - application/json
  /v1/table/{id}/rename:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    post:
      description: |
        Rename table `id` to a new name.
      operationId: RenameTable
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RenameTableRequest'
        required: true
      responses:
        "200":
          $ref: '#/components/responses/RenameTableResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "409":
          $ref: '#/components/responses/ConflictErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Rename a table
      tags:
      - Table
      - Metadata
      x-content-type: application/json
      x-accepts:
      - application/json
  /v1/table/{id}/schema_metadata/update:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    post:
      description: |
        Replace the schema metadata for table `id` with the provided key-value pairs.

        REST NAMESPACE ONLY
        REST namespace uses a direct object (map of string to string) as both request and response body
        instead of the wrapped `UpdateTableSchemaMetadataRequest` and `UpdateTableSchemaMetadataResponse`.
      operationId: UpdateTableSchemaMetadata
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties:
                type: string
              description: Schema metadata key-value pairs
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                description: The updated schema metadata
          description: Schema metadata update result
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Update table schema metadata
      tags:
      - Table
      - Metadata
      x-content-type: application/json
      x-accepts:
      - application/json
  /v1/table/{id}/version/list:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    - $ref: '#/components/parameters/page_token'
    - $ref: '#/components/parameters/limit'
    post:
      description: |
        List all versions (commits) of table `id` with their metadata.

        REST NAMESPACE ONLY
        REST namespace does not use a request body for this operation.
        The `ListTableVersionsRequest` information is passed in the following way:
        - `id`: pass through path parameter of the same name
        - `page_token`: pass through query parameter of the same name
        - `limit`: pass through query parameter of the same name
      operationId: ListTableVersions
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      - $ref: '#/components/parameters/page_token'
      - $ref: '#/components/parameters/limit'
      responses:
        "200":
          $ref: '#/components/responses/ListTableVersionsResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: List all versions of a table
      tags:
      - Table
      - Metadata
      x-accepts:
      - application/json
  /v1/table/{id}/alter_columns:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    post:
      description: |
        Modify existing columns in table `id`, such as renaming or changing data types.
      operationId: AlterTableAlterColumns
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlterTableAlterColumnsRequest'
        required: true
      responses:
        "200":
          $ref: '#/components/responses/AlterTableAlterColumnsResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Modify existing columns
      tags:
      - Table
      - Metadata
      x-content-type: application/json
      x-accepts:
      - application/json
  /v1/table/{id}/drop_columns:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    post:
      description: |
        Remove specified columns from table `id`.
      operationId: AlterTableDropColumns
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlterTableDropColumnsRequest'
        required: true
      responses:
        "200":
          $ref: '#/components/responses/AlterTableDropColumnsResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Remove columns from table
      tags:
      - Table
      - Metadata
      x-content-type: application/json
      x-accepts:
      - application/json
  /v1/table/{id}/stats:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    post:
      description: |
        Get statistics for table `id`, including row counts, data sizes, and column statistics.
      operationId: GetTableStats
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetTableStatsRequest'
        required: true
      responses:
        "200":
          $ref: '#/components/responses/GetTableStatsResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Get table statistics
      tags:
      - Table
      - Metadata
      x-content-type: application/json
      x-accepts:
      - application/json
  /v1/table/{id}/insert:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    - description: |
        How the insert should behave. Case insensitive, supports both PascalCase and snake_case. Valid values are:
        - Append (default): insert data to the existing table
        - Overwrite: remove all data in the table and then insert data to it
      explode: true
      in: query
      name: mode
      required: false
      schema:
        default: append
        type: string
      style: form
    post:
      description: |
        Insert new records into table `id`.

        REST NAMESPACE ONLY
        REST namespace uses Arrow IPC stream as the request body.
        It passes in the `InsertIntoTableRequest` information in the following way:
        - `id`: pass through path parameter of the same name
        - `mode`: pass through query parameter of the same name
      operationId: InsertIntoTable
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      - description: |
          How the insert should behave. Case insensitive, supports both PascalCase and snake_case. Valid values are:
          - Append (default): insert data to the existing table
          - Overwrite: remove all data in the table and then insert data to it
        explode: true
        in: query
        name: mode
        required: false
        schema:
          default: append
          type: string
        style: form
      requestBody:
        content:
          application/vnd.apache.arrow.stream:
            schema:
              format: binary
              type: string
        description: Arrow IPC stream containing the records to insert
        required: true
      responses:
        "200":
          $ref: '#/components/responses/InsertIntoTableResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Insert records into a table
      tags:
      - Table
      - Data
      x-content-type: application/vnd.apache.arrow.stream
      x-accepts:
      - application/json
  /v1/table/{id}/merge_insert:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    - description: Column name to use for matching rows (required)
      explode: true
      in: query
      name: "on"
      required: true
      schema:
        type: string
      style: form
    - description: Update all columns when rows match
      explode: true
      in: query
      name: when_matched_update_all
      required: false
      schema:
        default: false
        type: boolean
      style: form
    - description: The row is updated (similar to UpdateAll) only for rows where the
        SQL expression evaluates to true
      explode: true
      in: query
      name: when_matched_update_all_filt
      required: false
      schema:
        type: string
      style: form
    - description: Insert all columns when rows don't match
      explode: true
      in: query
      name: when_not_matched_insert_all
      required: false
      schema:
        default: false
        type: boolean
      style: form
    - description: Delete all rows from target table that don't match a row in the
        source table
      explode: true
      in: query
      name: when_not_matched_by_source_delete
      required: false
      schema:
        default: false
        type: boolean
      style: form
    - description: Delete rows from the target table if there is no match AND the
        SQL expression evaluates to true
      explode: true
      in: query
      name: when_not_matched_by_source_delete_filt
      required: false
      schema:
        type: string
      style: form
    - description: "Timeout for the operation (e.g., \"30s\", \"5m\")"
      explode: true
      in: query
      name: timeout
      required: false
      schema:
        type: string
      style: form
    - description: Whether to use index for matching rows
      explode: true
      in: query
      name: use_index
      required: false
      schema:
        default: false
        type: boolean
      style: form
    post:
      description: |
        Performs a merge insert (upsert) operation on table `id`.
        This operation updates existing rows
        based on a matching column and inserts new rows that don't match.
        It returns the number of rows inserted and updated.

        REST NAMESPACE ONLY
        REST namespace uses Arrow IPC stream as the request body.
        It passes in the `MergeInsertIntoTableRequest` information in the following way:
        - `id`: pass through path parameter of the same name
        - `on`: pass through query parameter of the same name
        - `when_matched_update_all`: pass through query parameter of the same name
        - `when_matched_update_all_filt`: pass through query parameter of the same name
        - `when_not_matched_insert_all`: pass through query parameter of the same name
        - `when_not_matched_by_source_delete`: pass through query parameter of the same name
        - `when_not_matched_by_source_delete_filt`: pass through query parameter of the same name
      operationId: MergeInsertIntoTable
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      - description: Column name to use for matching rows (required)
        explode: true
        in: query
        name: "on"
        required: true
        schema:
          type: string
        style: form
      - description: Update all columns when rows match
        explode: true
        in: query
        name: when_matched_update_all
        required: false
        schema:
          default: false
          type: boolean
        style: form
      - description: The row is updated (similar to UpdateAll) only for rows where
          the SQL expression evaluates to true
        explode: true
        in: query
        name: when_matched_update_all_filt
        required: false
        schema:
          type: string
        style: form
      - description: Insert all columns when rows don't match
        explode: true
        in: query
        name: when_not_matched_insert_all
        required: false
        schema:
          default: false
          type: boolean
        style: form
      - description: Delete all rows from target table that don't match a row in the
          source table
        explode: true
        in: query
        name: when_not_matched_by_source_delete
        required: false
        schema:
          default: false
          type: boolean
        style: form
      - description: Delete rows from the target table if there is no match AND the
          SQL expression evaluates to true
        explode: true
        in: query
        name: when_not_matched_by_source_delete_filt
        required: false
        schema:
          type: string
        style: form
      - description: "Timeout for the operation (e.g., \"30s\", \"5m\")"
        explode: true
        in: query
        name: timeout
        required: false
        schema:
          type: string
        style: form
      - description: Whether to use index for matching rows
        explode: true
        in: query
        name: use_index
        required: false
        schema:
          default: false
          type: boolean
        style: form
      requestBody:
        content:
          application/vnd.apache.arrow.stream:
            schema:
              format: binary
              type: string
        description: Arrow IPC stream containing the records to merge
        required: true
      responses:
        "200":
          $ref: '#/components/responses/MergeInsertIntoTableResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Merge insert (upsert) records into a table
      tags:
      - Table
      - Data
      x-content-type: application/vnd.apache.arrow.stream
      x-accepts:
      - application/json
  /v1/table/{id}/update:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    post:
      description: |
        Update existing rows in table `id`.
      operationId: UpdateTable
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTableRequest'
        description: Update request
        required: true
      responses:
        "200":
          $ref: '#/components/responses/UpdateTableResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Update rows in a table
      tags:
      - Table
      - Data
      x-content-type: application/json
      x-accepts:
      - application/json
  /v1/table/{id}/delete:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    post:
      description: |
        Delete rows from table `id`.
      operationId: DeleteFromTable
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteFromTableRequest'
        description: Delete request
        required: true
      responses:
        "200":
          $ref: '#/components/responses/DeleteFromTableResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Delete rows from a table
      tags:
      - Table
      - Data
      x-content-type: application/json
      x-accepts:
      - application/json
  /v1/table/{id}/query:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    post:
      description: |
        Query table `id` with vector search, full text search and optional SQL filtering.
        Returns results in Arrow IPC file or stream format.

        REST NAMESPACE ONLY
        REST namespace returns the response as Arrow IPC file binary data
        instead of the `QueryTableResponse` JSON object.
      operationId: QueryTable
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryTableRequest'
        description: Query request
        required: true
      responses:
        "200":
          $ref: '#/components/responses/QueryTableResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Query a table
      tags:
      - Table
      - Data
      x-content-type: application/json
      x-accepts:
      - application/json
      - application/vnd.apache.arrow.file
  /v1/table/{id}/count_rows:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    post:
      description: |
        Count the number of rows in table `id`

        REST NAMESPACE ONLY
        REST namespace returns the response as a plain integer
        instead of the `CountTableRowsResponse` JSON object.
      operationId: CountTableRows
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CountTableRowsRequest'
        required: true
      responses:
        "200":
          $ref: '#/components/responses/CountTableRowsResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Count rows in a table
      tags:
      - Table
      - Data
      x-content-type: application/json
      x-accepts:
      - application/json
  /v1/table/{id}/create:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    - explode: true
      in: query
      name: mode
      required: false
      schema:
        type: string
      style: form
    post:
      description: |
        Create table `id` in the namespace with the given data in Arrow IPC stream.

        The schema of the Arrow IPC stream is used as the table schema.
        If the stream is empty, the API creates a new empty table.

        REST NAMESPACE ONLY
        REST namespace uses Arrow IPC stream as the request body.
        It passes in the `CreateTableRequest` information in the following way:
        - `id`: pass through path parameter of the same name
        - `mode`: pass through query parameter of the same name
      operationId: CreateTable
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      - explode: true
        in: query
        name: mode
        required: false
        schema:
          type: string
        style: form
      requestBody:
        content:
          application/vnd.apache.arrow.stream:
            schema:
              format: binary
              type: string
        description: Arrow IPC data
        required: true
      responses:
        "200":
          $ref: '#/components/responses/CreateTableResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Create a table with the given name
      tags:
      - Table
      - Data
      x-content-type: application/vnd.apache.arrow.stream
      x-accepts:
      - application/json
  /v1/table/{id}/explain_plan:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    post:
      description: |
        Get the query execution plan for a query against table `id`.
        Returns a human-readable explanation of how the query will be executed.

        REST NAMESPACE ONLY
        REST namespace returns the response as a plain string
        instead of the `ExplainTableQueryPlanResponse` JSON object.
      operationId: ExplainTableQueryPlan
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExplainTableQueryPlanRequest'
        required: true
      responses:
        "200":
          $ref: '#/components/responses/ExplainTableQueryPlanResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Get query execution plan explanation
      tags:
      - Table
      - Data
      x-content-type: application/json
      x-accepts:
      - application/json
  /v1/table/{id}/analyze_plan:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    post:
      description: |
        Analyze the query execution plan for a query against table `id`.
        Returns detailed statistics and analysis of the query execution plan.

        REST NAMESPACE ONLY
        REST namespace returns the response as a plain string
        instead of the `AnalyzeTableQueryPlanResponse` JSON object.
      operationId: AnalyzeTableQueryPlan
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnalyzeTableQueryPlanRequest'
        required: true
      responses:
        "200":
          $ref: '#/components/responses/AnalyzeTableQueryPlanResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Analyze query execution plan
      tags:
      - Table
      - Data
      x-content-type: application/json
      x-accepts:
      - application/json
  /v1/table/{id}/add_columns:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    post:
      description: |
        Add new columns to table `id` using SQL expressions or default values.
      operationId: AlterTableAddColumns
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlterTableAddColumnsRequest'
        required: true
      responses:
        "200":
          $ref: '#/components/responses/AlterTableAddColumnsResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Add new columns to table schema
      tags:
      - Table
      - Data
      x-content-type: application/json
      x-accepts:
      - application/json
  /v1/table/{id}/create_index:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    post:
      description: "Create an index on a table column for faster search operations.\n\
        Supports vector indexes (IVF_FLAT, IVF_HNSW_SQ, IVF_PQ, etc.) and scalar indexes\
        \ (BTREE, BITMAP, FTS, etc.).\nIndex creation is handled asynchronously. \n\
        Use the `ListTableIndices` and `DescribeTableIndexStats` operations to monitor\
        \ index creation progress.\n"
      operationId: CreateTableIndex
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTableIndexRequest'
        description: Index creation request
        required: true
      responses:
        "200":
          $ref: '#/components/responses/CreateTableIndexResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Create an index on a table
      tags:
      - Table
      - Index
      - Metadata
      x-content-type: application/json
      x-accepts:
      - application/json
  /v1/table/{id}/create_scalar_index:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    post:
      description: |
        Create a scalar index on a table column for faster filtering operations.
        Supports scalar indexes (BTREE, BITMAP, LABEL_LIST, FTS, etc.).
        This is an alias for CreateTableIndex specifically for scalar indexes.
        Index creation is handled asynchronously.
        Use the `ListTableIndices` and `DescribeTableIndexStats` operations to monitor index creation progress.
      operationId: CreateTableScalarIndex
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTableIndexRequest'
        description: Scalar index creation request
        required: true
      responses:
        "200":
          $ref: '#/components/responses/CreateTableScalarIndexResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Create a scalar index on a table
      tags:
      - Table
      - Index
      - Metadata
      x-content-type: application/json
      x-accepts:
      - application/json
  /v1/table/{id}/index/list:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    post:
      description: |
        List all indices created on a table. Returns information about each index
        including name, columns, status, and UUID.
      operationId: ListTableIndices
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListTableIndicesRequest'
        description: Index list request
        required: true
      responses:
        "200":
          $ref: '#/components/responses/ListTableIndicesResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: List indexes on a table
      tags:
      - Table
      - Index
      - Metadata
      x-content-type: application/json
      x-accepts:
      - application/json
  /v1/table/{id}/index/{index_name}/stats:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    - description: Name of the index to get stats for
      explode: false
      in: path
      name: index_name
      required: true
      schema:
        type: string
      style: simple
    post:
      description: |
        Get statistics for a specific index on a table. Returns information about
        the index type, distance type (for vector indices), and row counts.
      operationId: DescribeTableIndexStats
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      - description: Name of the index to get stats for
        explode: false
        in: path
        name: index_name
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeTableIndexStatsRequest'
        description: Index stats request
        required: true
      responses:
        "200":
          $ref: '#/components/responses/DescribeTableIndexStatsResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Get table index statistics
      tags:
      - Table
      - Index
      - Metadata
      x-content-type: application/json
      x-accepts:
      - application/json
  /v1/table/{id}/index/{index_name}/drop:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    - description: Name of the index to drop
      explode: false
      in: path
      name: index_name
      required: true
      schema:
        type: string
      style: simple
    post:
      description: |
        Drop the specified index from table `id`.

        REST NAMESPACE ONLY
        REST namespace does not use a request body for this operation.
        The `DropTableIndexRequest` information is passed in the following way:
        - `id`: pass through path parameter of the same name
        - `index_name`: pass through path parameter of the same name
      operationId: DropTableIndex
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      - description: Name of the index to drop
        explode: false
        in: path
        name: index_name
        required: true
        schema:
          type: string
        style: simple
      responses:
        "200":
          $ref: '#/components/responses/DropTableIndexResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Drop a specific index
      tags:
      - Table
      - Index
      - Metadata
      x-accepts:
      - application/json
  /v1/table/{id}/tags/list:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    - $ref: '#/components/parameters/page_token'
    - $ref: '#/components/parameters/limit'
    post:
      description: |
        List all tags that have been created for table `id`.
        Returns a map of tag names to their corresponding version numbers and metadata.

        REST NAMESPACE ONLY
        REST namespace does not use a request body for this operation.
        The `ListTableTagsRequest` information is passed in the following way:
        - `id`: pass through path parameter of the same name
        - `page_token`: pass through query parameter of the same name
        - `limit`: pass through query parameter of the same name
      operationId: ListTableTags
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      - $ref: '#/components/parameters/page_token'
      - $ref: '#/components/parameters/limit'
      responses:
        "200":
          $ref: '#/components/responses/ListTableTagsResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: List all tags for a table
      tags:
      - Table
      - Tag
      - Metadata
      x-accepts:
      - application/json
  /v1/table/{id}/tags/version:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    post:
      description: |
        Get the version number that a specific tag points to for table `id`.
      operationId: GetTableTagVersion
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetTableTagVersionRequest'
        required: true
      responses:
        "200":
          $ref: '#/components/responses/GetTableTagVersionResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Get version for a specific tag
      tags:
      - Table
      - Tag
      - Metadata
      x-content-type: application/json
      x-accepts:
      - application/json
  /v1/table/{id}/declare:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    post:
      description: |
        Declare a table with the given name without touching storage.
        This is a metadata-only operation that records the table existence and sets up aspects like access control.

        For DirectoryNamespace implementation, this creates a `.lance-reserved` file in the table directory
        to mark the table's existence without creating actual Lance data files.
      operationId: DeclareTable
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeclareTableRequest'
        required: true
      responses:
        "200":
          $ref: '#/components/responses/DeclareTableResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "409":
          $ref: '#/components/responses/ConflictErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Declare a table
      tags:
      - Table
      - Metadata
      x-content-type: application/json
      x-accepts:
      - application/json
  /v1/table/{id}/create-empty:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    post:
      deprecated: true
      description: |
        Create an empty table with the given name without touching storage.
        This is a metadata-only operation that records the table existence and sets up aspects like access control.

        For DirectoryNamespace implementation, this creates a `.lance-reserved` file in the table directory
        to mark the table's existence without creating actual Lance data files.

        **Deprecated**: Use `DeclareTable` instead.
      operationId: CreateEmptyTable
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEmptyTableRequest'
        required: true
      responses:
        "200":
          $ref: '#/components/responses/CreateEmptyTableResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "409":
          $ref: '#/components/responses/ConflictErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Create an empty table
      tags:
      - Table
      - Metadata
      x-content-type: application/json
      x-accepts:
      - application/json
  /v1/table/{id}/tags/create:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    post:
      description: |
        Create a new tag for table `id` that points to a specific version.
      operationId: CreateTableTag
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTableTagRequest'
        required: true
      responses:
        "200":
          $ref: '#/components/responses/CreateTableTagResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "409":
          $ref: '#/components/responses/ConflictErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Create a new tag
      tags:
      - Table
      - Tag
      - Metadata
      x-content-type: application/json
      x-accepts:
      - application/json
  /v1/table/{id}/tags/delete:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    post:
      description: |
        Delete an existing tag from table `id`.
      operationId: DeleteTableTag
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteTableTagRequest'
        required: true
      responses:
        "200":
          $ref: '#/components/responses/DeleteTableTagResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Delete a tag
      tags:
      - Table
      - Tag
      - Metadata
      x-content-type: application/json
      x-accepts:
      - application/json
  /v1/table/{id}/tags/update:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    post:
      description: |
        Update an existing tag for table `id` to point to a different version.
      operationId: UpdateTableTag
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTableTagRequest'
        required: true
      responses:
        "200":
          $ref: '#/components/responses/UpdateTableTagResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Update a tag to point to a different version
      tags:
      - Table
      - Tag
      - Metadata
      x-content-type: application/json
      x-accepts:
      - application/json
  /v1/transaction/{id}/describe:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    post:
      description: |
        Return a detailed information for a given transaction
      operationId: DescribeTransaction
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeTransactionRequest'
        required: true
      responses:
        "200":
          $ref: '#/components/responses/DescribeTransactionResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Describe information about a transaction
      tags:
      - Transaction
      - Metadata
      x-content-type: application/json
      x-accepts:
      - application/json
  /v1/transaction/{id}/alter:
    parameters:
    - $ref: '#/components/parameters/id'
    - $ref: '#/components/parameters/delimiter'
    post:
      description: |
        Alter a transaction with a list of actions such as setting status or properties.
        The server should either succeed and apply all actions, or fail and apply no action.
      operationId: AlterTransaction
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/delimiter'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlterTransactionRequest'
        required: true
      responses:
        "200":
          $ref: '#/components/responses/AlterTransactionResponse'
        "400":
          $ref: '#/components/responses/BadRequestErrorResponse'
        "401":
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        "403":
          $ref: '#/components/responses/ForbiddenErrorResponse'
        "404":
          $ref: '#/components/responses/NotFoundErrorResponse'
        "409":
          $ref: '#/components/responses/ConflictErrorResponse'
        "503":
          $ref: '#/components/responses/ServiceUnavailableErrorResponse'
        "5XX":
          $ref: '#/components/responses/ServerErrorResponse'
      summary: Alter information of a transaction.
      tags:
      - Transaction
      - Metadata
      x-content-type: application/json
      x-accepts:
      - application/json
components:
  examples:
    ListNamespacesEmptyExample:
      summary: An empty list of namespaces
      value:
        namespaces: []
    ListNamespacesNonEmptyExample:
      summary: A non-empty list of namespaces
      value:
        namespaces:
        - accounting
        - credits
  parameters:
    id:
      description: |
        `string identifier` of an object in a namespace, following the Lance Namespace spec.
        When the value is equal to the delimiter, it represents the root namespace.
        For example, `v1/namespace/$/list` performs a `ListNamespace` on the root namespace.
      explode: false
      in: path
      name: id
      required: true
      schema:
        type: string
      style: simple
    delimiter:
      description: |
        An optional delimiter of the `string identifier`, following the Lance Namespace spec.
        When not specified, the `$` delimiter must be used.
      explode: true
      in: query
      name: delimiter
      required: false
      schema:
        type: string
      style: form
    page_token:
      description: Pagination token from a previous request
      explode: true
      in: query
      name: page_token
      required: false
      schema:
        $ref: '#/components/schemas/PageToken'
      style: form
    limit:
      description: Maximum number of items to return
      explode: true
      in: query
      name: limit
      required: false
      schema:
        $ref: '#/components/schemas/PageLimit'
      style: form
    with_table_uri:
      description: Whether to include the table URI in the response
      explode: true
      in: query
      name: with_table_uri
      required: false
      schema:
        default: false
        type: boolean
      style: form
    load_detailed_metadata:
      description: |
        Whether to load detailed metadata that requires opening the dataset.
        When false (default), only `location` is required in the response.
        When true, the response includes additional metadata such as `version`, `schema`, and `stats`.
      explode: true
      in: query
      name: load_detailed_metadata
      required: false
      schema:
        default: false
        type: boolean
      style: form
  responses:
    ListNamespacesResponse:
      content:
        application/json:
          examples:
            NonEmptyResponse:
              $ref: '#/components/examples/ListNamespacesNonEmptyExample'
            EmptyResponse:
              $ref: '#/components/examples/ListNamespacesEmptyExample'
          schema:
            $ref: '#/components/schemas/ListNamespacesResponse'
      description: A list of namespaces
    DescribeNamespaceResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DescribeNamespaceResponse'
      description: "Returns a namespace, as well as any properties stored on the namespace\
        \ if namespace properties are supported by the server."
    CreateNamespaceResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateNamespaceResponse'
      description: Result of creating a namespace
    DropNamespaceResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DropNamespaceResponse'
      description: Result of dropping a namespace
    ListTablesResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ListTablesResponse'
      description: A list of tables
    DescribeTableResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DescribeTableResponse'
      description: Table properties result when loading a table
    CountTableRowsResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CountTableRowsResponse'
      description: Result of counting rows in a table
    CreateTableResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateTableResponse'
      description: Table properties result when creating a table
    InsertIntoTableResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/InsertIntoTableResponse'
      description: Result of inserting records into a table
    MergeInsertIntoTableResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MergeInsertIntoTableResponse'
      description: Result of merge insert operation
    RegisterTableResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RegisterTableResponse'
      description: Table properties result when registering a table
    DescribeTransactionResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DescribeTransactionResponse'
      description: Response of DescribeTransaction
    AlterTransactionResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AlterTransactionResponse'
      description: Response of AlterTransaction
    DropTableResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DropTableResponse'
      description: Response of DropTable
    DeregisterTableResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DeregisterTableResponse'
      description: Response of DeregisterTable
    UpdateTableResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UpdateTableResponse'
      description: Update successful
    DeleteFromTableResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DeleteFromTableResponse'
      description: Delete successful
    QueryTableResponse:
      content:
        application/vnd.apache.arrow.file:
          schema:
            format: binary
            type: string
      description: Query results in Arrow IPC file format
    CreateTableIndexResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateTableIndexResponse'
      description: Index created successfully
    CreateTableScalarIndexResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateTableScalarIndexResponse'
      description: Scalar index created successfully
    ListTableIndicesResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ListTableIndicesResponse'
      description: List of indices on the table
    DescribeTableIndexStatsResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DescribeTableIndexStatsResponse'
      description: Index statistics
    ListTableTagsResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ListTableTagsResponse'
      description: List of table tags
    GetTableTagVersionResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GetTableTagVersionResponse'
      description: Tag version information
    CreateTableTagResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateTableTagResponse'
      description: Create tag response
    DeleteTableTagResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DeleteTableTagResponse'
      description: Delete tag response
    UpdateTableTagResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UpdateTableTagResponse'
      description: Update tag response
    ListTableVersionsResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ListTableVersionsResponse'
      description: List of table versions
    ExplainTableQueryPlanResponse:
      content:
        application/json:
          schema:
            description: Human-readable query execution plan
            type: string
      description: Query execution plan explanation
    AnalyzeTableQueryPlanResponse:
      content:
        application/json:
          schema:
            description: Human-readable query execution plan analysis
            type: string
      description: Query execution plan analysis
    AlterTableAddColumnsResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AlterTableAddColumnsResponse'
      description: Add columns operation result
    AlterTableAlterColumnsResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AlterTableAlterColumnsResponse'
      description: Alter columns operation result
    AlterTableDropColumnsResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AlterTableDropColumnsResponse'
      description: Drop columns operation result
    GetTableStatsResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GetTableStatsResponse'
      description: Table statistics
    RestoreTableResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RestoreTableResponse'
      description: Table restore operation result
    RenameTableResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RenameTableResponse'
      description: Table rename operation result
    DropTableIndexResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DropTableIndexResponse'
      description: Index drop operation result
    DeclareTableResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DeclareTableResponse'
      description: Table properties result when declaring a table
    CreateEmptyTableResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateEmptyTableResponse'
      description: Table properties result when creating an empty table
    BadRequestErrorResponse:
      content:
        application/json:
          example:
            type: /errors/bad-request
            title: Malformed request
            status: 400
            detail: ""
            instance: /v1/namespaces
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: "Indicates a bad request error. It could be caused by an unexpected\
        \ request body format or other forms of request validation failure, such as\
        \ invalid json. Usually serves application/json content, although in some\
        \ cases simple text/plain content might be returned by the server's middleware."
    UnauthorizedErrorResponse:
      content:
        application/json:
          example:
            type: /errors/unauthorized-request
            title: No valid authentication credentials for the operation
            status: 401
            detail: ""
            instance: /v1/namespaces
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Unauthorized. The request lacks valid authentication credentials
        for the operation.
    ForbiddenErrorResponse:
      content:
        application/json:
          example:
            type: /errors/forbidden-request
            title: Not authorized to make this request
            status: 403
            detail: ""
            instance: /v1/namespaces
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Forbidden. Authenticated user does not have the necessary permissions.
    NotFoundErrorResponse:
      content:
        application/json:
          example:
            type: /errors/not-found-error
            title: Not found Error
            status: 404
            detail: ""
            instance: "/v1/namespaces/{ns}"
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: A server-side problem that means can not find the specified resource.
    UnsupportedOperationErrorResponse:
      content:
        application/json:
          example:
            type: /errors/unsupported-operation
            title: The server does not support this operation
            status: 406
            detail: ""
            instance: /v1/namespaces
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Not Acceptable / Unsupported Operation. The server does not support
        this operation.
    ConflictErrorResponse:
      content:
        application/json:
          example:
            type: /errors/conflict
            title: The namespace has been concurrently modified
            status: 409
            detail: ""
            instance: "/v1/namespaces/{ns}"
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: The request conflicts with the current state of the target resource.
    ServiceUnavailableErrorResponse:
      content:
        application/json:
          example:
            type: /errors/service-unavailable
            title: Slow down
            status: 503
            detail: ""
            instance: /v1/namespaces
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: The service is not ready to handle the request. The client should
        wait and retry. The service may additionally send a Retry-After header to
        indicate when to retry.
    ServerErrorResponse:
      content:
        application/json:
          example:
            type: /errors/server-error
            title: Internal Server Error
            status: 500
            detail: ""
            instance: /v1/namespaces
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: A server-side problem that might not be addressable from the client
        side. Used for server 5xx errors without more specific documentation in individual
        routes.
  schemas:
    ErrorResponse:
      description: Common JSON error response model
      example:
        code: 4
        instance: /v1/table/production$users/describe
        detail: The table may have been dropped or renamed
        error: Table 'users' not found in namespace 'production'
      properties:
        error:
          description: "A brief, human-readable message about the error."
          example: Table 'users' not found in namespace 'production'
          type: string
        code:
          description: |
            Lance Namespace error code identifying the error type.

            Error codes:
              0 - Unsupported: Operation not supported by this backend
              1 - NamespaceNotFound: The specified namespace does not exist
              2 - NamespaceAlreadyExists: A namespace with this name already exists
              3 - NamespaceNotEmpty: Namespace contains tables or child namespaces
              4 - TableNotFound: The specified table does not exist
              5 - TableAlreadyExists: A table with this name already exists
              6 - TableIndexNotFound: The specified table index does not exist
              7 - TableIndexAlreadyExists: A table index with this name already exists
              8 - TableTagNotFound: The specified table tag does not exist
              9 - TableTagAlreadyExists: A table tag with this name already exists
              10 - TransactionNotFound: The specified transaction does not exist
              11 - TableVersionNotFound: The specified table version does not exist
              12 - TableColumnNotFound: The specified table column does not exist
              13 - InvalidInput: Malformed request or invalid parameters
              14 - ConcurrentModification: Optimistic concurrency conflict
              15 - PermissionDenied: User lacks permission for this operation
              16 - Unauthenticated: Authentication credentials are missing or invalid
              17 - ServiceUnavailable: Service is temporarily unavailable
              18 - Internal: Unexpected server/implementation error
              19 - InvalidTableState: Table is in an invalid state for the operation
              20 - TableSchemaValidationError: Table schema validation failed
          example: 4
          minimum: 0
          type: integer
        detail:
          description: |
            An optional human-readable explanation of the error.
            This can be used to record additional information such as stack trace.
          example: The table may have been dropped or renamed
          type: string
        instance:
          description: |
            A string that identifies the specific occurrence of the error.
            This can be a URI, a request or response ID,
            or anything that the implementation can recognize to trace specific occurrence of the error.
          example: /v1/table/production$users/describe
          type: string
      required:
      - code
    Identity:
      description: |
        Identity information of a request.
      example:
        api_key: api_key
        auth_token: auth_token
      properties:
        api_key:
          description: |
            API key for authentication.

            REST NAMESPACE ONLY
            This is passed via the `x-api-key` header.
          type: string
        auth_token:
          description: |
            Bearer token for authentication.

            REST NAMESPACE ONLY
            This is passed via the `Authorization` header
            with the Bearer scheme (e.g., `Bearer <token>`).
          type: string
    Context:
      additionalProperties:
        type: string
      description: |
        Arbitrary context for a request as key-value pairs.
        How to use the context is custom to the specific implementation.

        REST NAMESPACE ONLY
        Context entries are passed via HTTP headers using the naming convention
        `x-lance-ctx-<key>: <value>`. For example, a context entry
        `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
    CreateNamespaceRequest:
      example:
        mode: mode
        identity:
          api_key: api_key
          auth_token: auth_token
        context:
          key: context
        id:
        - id
        - id
        properties:
          key: properties
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          items:
            type: string
          type: array
        mode:
          description: |
            There are three modes when trying to create a namespace,
            to differentiate the behavior when a namespace of the same name already exists.
            Case insensitive, supports both PascalCase and snake_case. Valid values are:
              * Create: the operation fails with 409.
              * ExistOk: the operation succeeds and the existing namespace is kept.
              * Overwrite: the existing namespace is dropped and a new empty namespace with this name is created.
          type: string
        properties:
          additionalProperties:
            type: string
    CreateNamespaceResponse:
      example:
        transaction_id: transaction_id
        properties:
          key: properties
      properties:
        transaction_id:
          description: Optional transaction identifier
          type: string
        properties:
          additionalProperties:
            type: string
          description: |
            Properties after the namespace is created.

            If the server does not support namespace properties, it should return null for this field.
            If namespace properties are supported, but none are set, it should return an empty object.
    ListNamespacesRequest:
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          items:
            type: string
          type: array
        page_token:
          description: "An opaque token that allows pagination for list operations\
            \ (e.g. ListNamespaces).\n\nFor an initial request of a list operation,\
            \ \nif the implementation cannot return all items in one response,\nor\
            \ if there are more items than the page limit specified in the request,\n\
            the implementation must return a page token in the response,\nindicating\
            \ there are more results available.\n\nAfter the initial request, \nthe\
            \ value of the page token from each response must be used\nas the page\
            \ token value for the next request.\n\nCaller must interpret either `null`,\
            \ \nmissing value or empty string value of the page token from\nthe implementation's\
            \ response as the end of the listing results.\n"
          type: string
          nullable: true
        limit:
          description: "An inclusive upper bound of the \nnumber of results that a\
            \ caller will receive.\n"
          type: integer
          nullable: true
    ListNamespacesResponse:
      example:
        page_token: page_token
        namespaces:
        - namespaces
        - namespaces
      properties:
        namespaces:
          description: |
            The list of names of the child namespaces relative to the parent namespace `id` in the request.
          items:
            type: string
          type: array
          uniqueItems: true
        page_token:
          description: "An opaque token that allows pagination for list operations\
            \ (e.g. ListNamespaces).\n\nFor an initial request of a list operation,\
            \ \nif the implementation cannot return all items in one response,\nor\
            \ if there are more items than the page limit specified in the request,\n\
            the implementation must return a page token in the response,\nindicating\
            \ there are more results available.\n\nAfter the initial request, \nthe\
            \ value of the page token from each response must be used\nas the page\
            \ token value for the next request.\n\nCaller must interpret either `null`,\
            \ \nmissing value or empty string value of the page token from\nthe implementation's\
            \ response as the end of the listing results.\n"
          type: string
          nullable: true
      required:
      - namespaces
    DescribeNamespaceRequest:
      example:
        identity:
          api_key: api_key
          auth_token: auth_token
        context:
          key: context
        id:
        - id
        - id
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          items:
            type: string
          type: array
    DescribeNamespaceResponse:
      example:
        properties:
          owner: Ralph
          created_at: "1452120468"
      properties:
        properties:
          additionalProperties:
            type: string
          default: {}
          description: "Properties stored on the namespace, if supported by the server.\
            \ If the server does not support namespace properties, it should return\
            \ null for this field. If namespace properties are supported, but none\
            \ are set, it should return an empty object."
          example:
            owner: Ralph
            created_at: "1452120468"
          nullable: true
    DropNamespaceRequest:
      example:
        mode: mode
        identity:
          api_key: api_key
          auth_token: auth_token
        context:
          key: context
        id:
        - id
        - id
        behavior: behavior
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          items:
            type: string
          type: array
        mode:
          description: |
            The mode for dropping a namespace, deciding the server behavior when the namespace to drop is not found.
            Case insensitive, supports both PascalCase and snake_case. Valid values are:
            - Fail (default): the server must return 400 indicating the namespace to drop does not exist.
            - Skip: the server must return 204 indicating the drop operation has succeeded.
          type: string
        behavior:
          description: |
            The behavior for dropping a namespace.
            Case insensitive, supports both PascalCase and snake_case. Valid values are:
            - Restrict (default): the namespace should not contain any table or child namespace when drop is initiated.
                If tables are found, the server should return error and not drop the namespace.
            - Cascade: all tables and child namespaces in the namespace are dropped before the namespace is dropped.
          type: string
    DropNamespaceResponse:
      example:
        transaction_id:
        - transaction_id
        - transaction_id
        properties:
          key: properties
      properties:
        properties:
          additionalProperties:
            type: string
        transaction_id:
          description: |
            If present, indicating the operation is long running and should be tracked using DescribeTransaction
          items:
            type: string
          type: array
    NamespaceExistsRequest:
      example:
        identity:
          api_key: api_key
          auth_token: auth_token
        context:
          key: context
        id:
        - id
        - id
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          items:
            type: string
          type: array
    PageToken:
      description: "An opaque token that allows pagination for list operations (e.g.\
        \ ListNamespaces).\n\nFor an initial request of a list operation, \nif the\
        \ implementation cannot return all items in one response,\nor if there are\
        \ more items than the page limit specified in the request,\nthe implementation\
        \ must return a page token in the response,\nindicating there are more results\
        \ available.\n\nAfter the initial request, \nthe value of the page token from\
        \ each response must be used\nas the page token value for the next request.\n\
        \nCaller must interpret either `null`, \nmissing value or empty string value\
        \ of the page token from\nthe implementation's response as the end of the\
        \ listing results.\n"
      type: string
      nullable: true
    PageLimit:
      description: "An inclusive upper bound of the \nnumber of results that a caller\
        \ will receive.\n"
      type: integer
      nullable: true
    RegisterTableRequest:
      example:
        mode: mode
        identity:
          api_key: api_key
          auth_token: auth_token
        context:
          key: context
        location: location
        id:
        - id
        - id
        properties:
          key: properties
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          items:
            type: string
          type: array
        location:
          type: string
        mode:
          description: |
            There are two modes when trying to register a table,
            to differentiate the behavior when a table of the same name already exists.
            Case insensitive, supports both PascalCase and snake_case. Valid values are:
              * Create (default): the operation fails with 409.
              * Overwrite: the existing table registration is replaced with the new registration.
          type: string
        properties:
          additionalProperties:
            type: string
      required:
      - location
    RegisterTableResponse:
      example:
        transaction_id: transaction_id
        location: location
        properties:
          key: properties
      properties:
        transaction_id:
          description: Optional transaction identifier
          type: string
        location:
          type: string
        properties:
          additionalProperties:
            type: string
    ListTablesRequest:
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          items:
            type: string
          type: array
        page_token:
          description: "An opaque token that allows pagination for list operations\
            \ (e.g. ListNamespaces).\n\nFor an initial request of a list operation,\
            \ \nif the implementation cannot return all items in one response,\nor\
            \ if there are more items than the page limit specified in the request,\n\
            the implementation must return a page token in the response,\nindicating\
            \ there are more results available.\n\nAfter the initial request, \nthe\
            \ value of the page token from each response must be used\nas the page\
            \ token value for the next request.\n\nCaller must interpret either `null`,\
            \ \nmissing value or empty string value of the page token from\nthe implementation's\
            \ response as the end of the listing results.\n"
          type: string
          nullable: true
        limit:
          description: "An inclusive upper bound of the \nnumber of results that a\
            \ caller will receive.\n"
          type: integer
          nullable: true
    ListTablesResponse:
      example:
        tables:
        - tables
        - tables
        page_token: page_token
      properties:
        tables:
          description: |
            The list of names of all the tables under the connected namespace implementation.
            This should recursively list all the tables in all child namespaces.
            Each string in the list is the full identifier in string form.
          items:
            type: string
          type: array
          uniqueItems: true
        page_token:
          description: "An opaque token that allows pagination for list operations\
            \ (e.g. ListNamespaces).\n\nFor an initial request of a list operation,\
            \ \nif the implementation cannot return all items in one response,\nor\
            \ if there are more items than the page limit specified in the request,\n\
            the implementation must return a page token in the response,\nindicating\
            \ there are more results available.\n\nAfter the initial request, \nthe\
            \ value of the page token from each response must be used\nas the page\
            \ token value for the next request.\n\nCaller must interpret either `null`,\
            \ \nmissing value or empty string value of the page token from\nthe implementation's\
            \ response as the end of the listing results.\n"
          type: string
          nullable: true
      required:
      - tables
    DescribeTableRequest:
      example:
        identity:
          api_key: api_key
          auth_token: auth_token
        context:
          key: context
        id:
        - id
        - id
        version: 0
        with_table_uri: false
        load_detailed_metadata: true
        vend_credentials: true
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          items:
            type: string
          type: array
        version:
          description: |
            Version of the table to describe.
            If not specified, server should resolve it to the latest version.
          format: int64
          minimum: 0
          type: integer
        with_table_uri:
          default: false
          description: |
            Whether to include the table URI in the response.
            Default is false.
          type: boolean
        load_detailed_metadata:
          description: |
            Whether to load detailed metadata that requires opening the dataset.
            When true, the response must include all detailed metadata such as `version`, `schema`, and `stats`
            which require reading the dataset.
            When not set, the implementation can decide whether to return detailed metadata
            and which parts of detailed metadata to return.
          type: boolean
        vend_credentials:
          description: |
            Whether to include vended credentials in the response `storage_options`.
            When true, the implementation should provide vended credentials for accessing storage.
            When not set, the implementation can decide whether to return vended credentials.
          type: boolean
    DescribeTableResponse:
      example:
        schema:
          metadata:
            key: metadata
          fields:
          - metadata:
              key: metadata
            nullable: true
            name: name
            type:
              length: 0
              fields:
              - null
              - null
              type: type
          - metadata:
              key: metadata
            nullable: true
            name: name
            type:
              length: 0
              fields:
              - null
              - null
              type: type
        metadata:
          key: metadata
        table_uri: table_uri
        stats:
          num_deleted_rows: 0
          num_fragments: 0
        namespace:
        - namespace
        - namespace
        location: location
        version: 0
        table: table
        storage_options:
          key: storage_options
      properties:
        table:
          description: |
            Table name.
            Only populated when `load_detailed_metadata` is true.
          type: string
        namespace:
          description: |
            The namespace identifier as a list of parts.
            Only populated when `load_detailed_metadata` is true.
          items:
            type: string
          type: array
        version:
          description: |
            Table version number.
            Only populated when `load_detailed_metadata` is true.
          format: int64
          minimum: 0
          type: integer
        location:
          description: |
            Table storage location (e.g., S3/GCS path).
          type: string
        table_uri:
          description: |
            Table URI. Unlike location, this field must be a complete and valid URI.
            Only returned when `with_table_uri` is true.
          type: string
        schema:
          $ref: '#/components/schemas/JsonArrowSchema'
        storage_options:
          additionalProperties:
            type: string
          description: |
            Configuration options to be used to access storage. The available
            options depend on the type of storage in use. These will be
            passed directly to Lance to initialize storage access.
            When `vend_credentials` is true, this field may include vended credentials.
            If the vended credentials are temporary, the `expires_at_millis` key should be
            included to indicate the millisecond timestamp when the credentials expire.
        stats:
          $ref: '#/components/schemas/TableBasicStats'
        metadata:
          additionalProperties:
            type: string
          description: |
            Optional table metadata as key-value pairs.
    TableBasicStats:
      example:
        num_deleted_rows: 0
        num_fragments: 0
      properties:
        num_deleted_rows:
          description: Number of deleted rows in the table
          minimum: 0
          type: integer
        num_fragments:
          description: Number of fragments in the table
          minimum: 0
          type: integer
      required:
      - num_deleted_rows
      - num_fragments
    CountTableRowsRequest:
      example:
        predicate: predicate
        identity:
          api_key: api_key
          auth_token: auth_token
        context:
          key: context
        id:
        - id
        - id
        version: 0
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          items:
            type: string
          type: array
        version:
          description: |
            Version of the table to describe.
            If not specified, server should resolve it to the latest version.
          format: int64
          minimum: 0
          type: integer
        predicate:
          description: |
            Optional SQL predicate to filter rows for counting
          type: string
    CountTableRowsResponse:
      description: "Response containing the count of rows. \nSerializes transparently\
        \ as just the number for backward compatibility.\n"
      format: int64
      minimum: 0
      type: integer
    InsertIntoTableRequest:
      description: |
        Request for inserting records into a table, excluding the Arrow IPC stream.
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          items:
            type: string
          type: array
        mode:
          default: append
          description: |
            How the insert should behave. Case insensitive, supports both PascalCase and snake_case. Valid values are:
            - Append (default): insert data to the existing table
            - Overwrite: remove all data in the table and then insert data to it
          type: string
    InsertIntoTableResponse:
      description: Response from inserting records into a table
      example:
        transaction_id: transaction_id
      properties:
        transaction_id:
          description: Optional transaction identifier
          type: string
    MergeInsertIntoTableRequest:
      description: |
        Request for merging or inserting records into a table, excluding the Arrow IPC stream.
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          items:
            type: string
          type: array
        "on":
          description: Column name to use for matching rows (required)
          type: string
        when_matched_update_all:
          default: false
          description: Update all columns when rows match
          type: boolean
        when_matched_update_all_filt:
          description: The row is updated (similar to UpdateAll) only for rows where
            the SQL expression evaluates to true
          type: string
        when_not_matched_insert_all:
          default: false
          description: Insert all columns when rows don't match
          type: boolean
        when_not_matched_by_source_delete:
          default: false
          description: Delete all rows from target table that don't match a row in
            the source table
          type: boolean
        when_not_matched_by_source_delete_filt:
          description: Delete rows from the target table if there is no match AND
            the SQL expression evaluates to true
          type: string
        timeout:
          description: "Timeout for the operation (e.g., \"30s\", \"5m\")"
          type: string
        use_index:
          default: false
          description: Whether to use index for matching rows
          type: boolean
    MergeInsertIntoTableResponse:
      description: Response from merge insert operation
      example:
        transaction_id: transaction_id
        num_inserted_rows: 0
        num_updated_rows: 0
        num_deleted_rows: 0
        version: 0
      properties:
        transaction_id:
          description: Optional transaction identifier
          type: string
        num_updated_rows:
          description: Number of rows updated
          format: int64
          minimum: 0
          type: integer
        num_inserted_rows:
          description: Number of rows inserted
          format: int64
          minimum: 0
          type: integer
        num_deleted_rows:
          description: Number of rows deleted (typically 0 for merge insert)
          format: int64
          minimum: 0
          type: integer
        version:
          description: The commit version associated with the operation
          format: int64
          minimum: 0
          type: integer
    UpdateTableRequest:
      description: |
        Each update consists of a column name and an SQL expression that will be
        evaluated against the current row's value. Optionally, a predicate can be
        provided to filter which rows to update.
      example:
        predicate: predicate
        identity:
          api_key: api_key
          auth_token: auth_token
        context:
          key: context
        id:
        - id
        - id
        updates:
        - - updates
          - updates
        - - updates
          - updates
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          items:
            type: string
          type: array
        predicate:
          description: Optional SQL predicate to filter rows for update
          type: string
          nullable: true
        updates:
          description: "List of column updates as [column_name, expression] pairs"
          items:
            items:
              type: string
            maxItems: 2
            minItems: 2
            type: array
          type: array
      required:
      - updates
    UpdateTableResponse:
      example:
        transaction_id: transaction_id
        updated_rows: 0
        version: 0
      properties:
        transaction_id:
          description: Optional transaction identifier
          type: string
        updated_rows:
          description: Number of rows updated
          format: int64
          minimum: 0
          type: integer
        version:
          description: The commit version associated with the operation
          format: int64
          minimum: 0
          type: integer
      required:
      - updated_rows
      - version
    DeleteFromTableRequest:
      description: |
        Delete data from table based on a SQL predicate.
        Returns the number of rows that were deleted.
      example:
        predicate: predicate
        identity:
          api_key: api_key
          auth_token: auth_token
        context:
          key: context
        id:
        - id
        - id
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          description: The namespace identifier
          items:
            type: string
          type: array
        predicate:
          description: SQL predicate to filter rows for deletion
          type: string
      required:
      - predicate
    DeleteFromTableResponse:
      example:
        transaction_id: transaction_id
        version: 0
      properties:
        transaction_id:
          description: Optional transaction identifier
          type: string
        version:
          description: The commit version associated with the operation
          format: int64
          minimum: 0
          type: integer
    QueryTableRequest:
      example:
        ef: 0
        offset: 0
        columns:
          column_aliases:
            key: column_aliases
          column_names:
          - column_names
          - column_names
        vector_column: vector_column
        fast_search: true
        k: 0
        upper_bound: 1.2315135
        version: 0
        with_row_id: true
        prefilter: true
        filter: filter
        refine_factor: 0
        full_text_query:
          string_query:
            columns:
            - columns
            - columns
            query: query
          structured_query:
            query:
              boolean:
                must_not:
                - null
                - null
                should:
                - null
                - null
                must:
                - null
                - null
              phrase:
                terms: terms
                column: column
                slop: 0
              match:
                fuzziness: 0
                terms: terms
                column: column
                boost: 6.0274563
                prefix_length: 0
                operator: operator
                max_expansions: 0
              boost:
                negative: null
                negative_boost: 7.0614014
                positive: null
              multi_match:
                match_queries:
                - fuzziness: 0
                  terms: terms
                  column: column
                  boost: 6.0274563
                  prefix_length: 0
                  operator: operator
                  max_expansions: 0
                - fuzziness: 0
                  terms: terms
                  column: column
                  boost: 6.0274563
                  prefix_length: 0
                  operator: operator
                  max_expansions: 0
        distance_type: distance_type
        lower_bound: 3.6160767
        identity:
          api_key: api_key
          auth_token: auth_token
        bypass_vector_index: true
        nprobes: 0
        context:
          key: context
        vector:
          single_vector:
          - 1.0246457
          - 1.0246457
          multi_vector:
          - - 1.4894159
            - 1.4894159
          - - 1.4894159
            - 1.4894159
        id:
        - id
        - id
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          items:
            type: string
          type: array
        bypass_vector_index:
          description: Whether to bypass vector index
          type: boolean
        columns:
          $ref: '#/components/schemas/QueryTableRequest_columns'
        distance_type:
          description: Distance metric to use
          type: string
        ef:
          description: Search effort parameter for HNSW index
          minimum: 0
          type: integer
        fast_search:
          description: Whether to use fast search
          type: boolean
        filter:
          description: Optional SQL filter expression
          type: string
        full_text_query:
          $ref: '#/components/schemas/QueryTableRequest_full_text_query'
        k:
          description: Number of results to return
          minimum: 0
          type: integer
        lower_bound:
          description: Lower bound for search
          format: float
          type: number
        nprobes:
          description: Number of probes for IVF index
          minimum: 0
          type: integer
        offset:
          description: Number of results to skip
          minimum: 0
          type: integer
        prefilter:
          description: Whether to apply filtering before vector search
          type: boolean
        refine_factor:
          description: Refine factor for search
          format: int32
          minimum: 0
          type: integer
        upper_bound:
          description: Upper bound for search
          format: float
          type: number
        vector:
          $ref: '#/components/schemas/QueryTableRequest_vector'
        vector_column:
          description: Name of the vector column to search
          type: string
        version:
          description: Table version to query
          format: int64
          minimum: 0
          type: integer
        with_row_id:
          description: "If true, return the row id as a column called `_rowid`"
          type: boolean
      required:
      - k
      - vector
    CreateTableIndexRequest:
      example:
        base_tokenizer: base_tokenizer
        column: column
        max_token_length: 0
        language: language
        index_type: index_type
        with_position: true
        lower_case: true
        distance_type: distance_type
        identity:
          api_key: api_key
          auth_token: auth_token
        context:
          key: context
        name: name
        ascii_folding: true
        id:
        - id
        - id
        remove_stop_words: true
        stem: true
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          items:
            type: string
          type: array
        column:
          description: Name of the column to create index on
          type: string
        index_type:
          description: "Type of index to create (e.g., BTREE, BITMAP, LABEL_LIST,\
            \ IVF_FLAT, IVF_PQ, IVF_HNSW_SQ, FTS)"
          type: string
        name:
          description: "Optional name for the index. If not provided, a name will\
            \ be auto-generated."
          type: string
          nullable: true
        distance_type:
          description: "Distance metric type for vector indexes (e.g., l2, cosine,\
            \ dot)"
          type: string
        with_position:
          description: Optional FTS parameter for position tracking
          type: boolean
          nullable: true
        base_tokenizer:
          description: Optional FTS parameter for base tokenizer
          type: string
          nullable: true
        language:
          description: Optional FTS parameter for language
          type: string
          nullable: true
        max_token_length:
          description: Optional FTS parameter for maximum token length
          minimum: 0
          type: integer
          nullable: true
        lower_case:
          description: Optional FTS parameter for lowercase conversion
          type: boolean
          nullable: true
        stem:
          description: Optional FTS parameter for stemming
          type: boolean
          nullable: true
        remove_stop_words:
          description: Optional FTS parameter for stop word removal
          type: boolean
          nullable: true
        ascii_folding:
          description: Optional FTS parameter for ASCII folding
          type: boolean
          nullable: true
      required:
      - column
      - index_type
    CreateTableIndexResponse:
      description: Response for create index operation
      example:
        transaction_id: transaction_id
      properties:
        transaction_id:
          description: Optional transaction identifier
          type: string
    CreateTableScalarIndexResponse:
      description: Response for create scalar index operation
      example:
        transaction_id: transaction_id
      properties:
        transaction_id:
          description: Optional transaction identifier
          type: string
    ListTableIndicesRequest:
      example:
        identity:
          api_key: api_key
          auth_token: auth_token
        context:
          key: context
        page_token: page_token
        limit: 6
        id:
        - id
        - id
        version: 0
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          description: The namespace identifier
          items:
            type: string
          type: array
        version:
          description: Optional table version to list indexes from
          format: int64
          minimum: 0
          type: integer
          nullable: true
        page_token:
          description: "An opaque token that allows pagination for list operations\
            \ (e.g. ListNamespaces).\n\nFor an initial request of a list operation,\
            \ \nif the implementation cannot return all items in one response,\nor\
            \ if there are more items than the page limit specified in the request,\n\
            the implementation must return a page token in the response,\nindicating\
            \ there are more results available.\n\nAfter the initial request, \nthe\
            \ value of the page token from each response must be used\nas the page\
            \ token value for the next request.\n\nCaller must interpret either `null`,\
            \ \nmissing value or empty string value of the page token from\nthe implementation's\
            \ response as the end of the listing results.\n"
          type: string
          nullable: true
        limit:
          description: "An inclusive upper bound of the \nnumber of results that a\
            \ caller will receive.\n"
          type: integer
          nullable: true
    ListTableIndicesResponse:
      example:
        indexes:
        - index_uuid: index_uuid
          columns:
          - columns
          - columns
          index_name: index_name
          status: status
        - index_uuid: index_uuid
          columns:
          - columns
          - columns
          index_name: index_name
          status: status
        page_token: page_token
      properties:
        indexes:
          description: List of indexes on the table
          items:
            $ref: '#/components/schemas/IndexContent'
          type: array
        page_token:
          description: "An opaque token that allows pagination for list operations\
            \ (e.g. ListNamespaces).\n\nFor an initial request of a list operation,\
            \ \nif the implementation cannot return all items in one response,\nor\
            \ if there are more items than the page limit specified in the request,\n\
            the implementation must return a page token in the response,\nindicating\
            \ there are more results available.\n\nAfter the initial request, \nthe\
            \ value of the page token from each response must be used\nas the page\
            \ token value for the next request.\n\nCaller must interpret either `null`,\
            \ \nmissing value or empty string value of the page token from\nthe implementation's\
            \ response as the end of the listing results.\n"
          type: string
          nullable: true
      required:
      - indexes
    IndexContent:
      example:
        index_uuid: index_uuid
        columns:
        - columns
        - columns
        index_name: index_name
        status: status
      properties:
        index_name:
          description: Name of the index
          type: string
        index_uuid:
          description: Unique identifier for the index
          type: string
        columns:
          description: Columns covered by this index
          items:
            type: string
          type: array
        status:
          description: Current status of the index
          type: string
      required:
      - columns
      - index_name
      - index_uuid
      - status
    DescribeTableIndexStatsRequest:
      example:
        identity:
          api_key: api_key
          auth_token: auth_token
        context:
          key: context
        id:
        - id
        - id
        version: 0
        index_name: index_name
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          items:
            type: string
          type: array
        version:
          description: Optional table version to get stats for
          format: int64
          minimum: 0
          type: integer
          nullable: true
        index_name:
          description: Name of the index
          type: string
    DescribeTableIndexStatsResponse:
      example:
        num_indices: 0
        distance_type: distance_type
        num_unindexed_rows: 0
        num_indexed_rows: 0
        index_type: index_type
      properties:
        distance_type:
          description: Distance type for vector indexes
          type: string
          nullable: true
        index_type:
          description: Type of the index
          type: string
          nullable: true
        num_indexed_rows:
          description: Number of indexed rows
          format: int64
          minimum: 0
          type: integer
          nullable: true
        num_unindexed_rows:
          description: Number of unindexed rows
          format: int64
          minimum: 0
          type: integer
          nullable: true
        num_indices:
          description: Number of indices
          format: int32
          minimum: 0
          type: integer
          nullable: true
    JsonArrowSchema:
      description: |
        JSON representation of a Apache Arrow schema.
      example:
        metadata:
          key: metadata
        fields:
        - metadata:
            key: metadata
          nullable: true
          name: name
          type:
            length: 0
            fields:
            - null
            - null
            type: type
        - metadata:
            key: metadata
          nullable: true
          name: name
          type:
            length: 0
            fields:
            - null
            - null
            type: type
      properties:
        fields:
          items:
            $ref: '#/components/schemas/JsonArrowField'
          type: array
        metadata:
          additionalProperties:
            type: string
      required:
      - fields
    JsonArrowField:
      description: |
        JSON representation of an Apache Arrow field.
      example:
        metadata:
          key: metadata
        nullable: true
        name: name
        type:
          length: 0
          fields:
          - null
          - null
          type: type
      properties:
        metadata:
          additionalProperties:
            type: string
        name:
          type: string
        nullable:
          type: boolean
        type:
          $ref: '#/components/schemas/JsonArrowDataType'
      required:
      - name
      - nullable
      - type
    JsonArrowDataType:
      description: JSON representation of an Apache Arrow DataType
      example:
        length: 0
        fields:
        - null
        - null
        type: type
      properties:
        fields:
          description: "Fields for complex types like Struct, Union, etc."
          items:
            $ref: '#/components/schemas/JsonArrowField'
          type: array
        length:
          description: Length for fixed-size types
          format: int64
          minimum: 0
          type: integer
        type:
          description: The data type name
          type: string
      required:
      - type
    Binary:
      format: binary
      type: string
    CreateTableRequest:
      description: |
        Request for creating a table, excluding the Arrow IPC stream.
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          items:
            type: string
          type: array
        mode:
          description: |
            There are three modes when trying to create a table,
            to differentiate the behavior when a table of the same name already exists.
            Case insensitive, supports both PascalCase and snake_case. Valid values are:
              * Create: the operation fails with 409.
              * ExistOk: the operation succeeds and the existing table is kept.
              * Overwrite: the existing table is dropped and a new table with this name is created.
          type: string
    CreateTableResponse:
      example:
        transaction_id: transaction_id
        location: location
        version: 0
        storage_options:
          key: storage_options
      properties:
        transaction_id:
          description: Optional transaction identifier
          type: string
        location:
          type: string
        version:
          format: int64
          minimum: 0
          type: integer
        storage_options:
          additionalProperties:
            type: string
          description: |
            Configuration options to be used to access storage. The available
            options depend on the type of storage in use. These will be
            passed directly to Lance to initialize storage access.
    CreateEmptyTableRequest:
      deprecated: true
      description: |
        Request for creating an empty table.

        **Deprecated**: Use `DeclareTableRequest` instead.
      example:
        identity:
          api_key: api_key
          auth_token: auth_token
        context:
          key: context
        location: location
        id:
        - id
        - id
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          items:
            type: string
          type: array
        location:
          description: |
            Optional storage location for the table.
            If not provided, the namespace implementation should determine the table location.
          type: string
    CreateEmptyTableResponse:
      deprecated: true
      description: |
        Response for creating an empty table.

        **Deprecated**: Use `DeclareTableResponse` instead.
      example:
        transaction_id: transaction_id
        location: location
        storage_options:
          key: storage_options
      properties:
        transaction_id:
          description: Optional transaction identifier
          type: string
        location:
          type: string
        storage_options:
          additionalProperties:
            type: string
          description: |
            Configuration options to be used to access storage. The available
            options depend on the type of storage in use. These will be
            passed directly to Lance to initialize storage access.
    DeclareTableRequest:
      description: |
        Request for declaring a table.
      example:
        identity:
          api_key: api_key
          auth_token: auth_token
        context:
          key: context
        location: location
        id:
        - id
        - id
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          items:
            type: string
          type: array
        location:
          description: |
            Optional storage location for the table.
            If not provided, the namespace implementation should determine the table location.
          type: string
    DeclareTableResponse:
      description: |
        Response for declaring a table.
      example:
        transaction_id: transaction_id
        location: location
        storage_options:
          key: storage_options
      properties:
        transaction_id:
          description: Optional transaction identifier
          type: string
        location:
          type: string
        storage_options:
          additionalProperties:
            type: string
          description: |
            Configuration options to be used to access storage. The available
            options depend on the type of storage in use. These will be
            passed directly to Lance to initialize storage access.
    TableExistsRequest:
      example:
        identity:
          api_key: api_key
          auth_token: auth_token
        context:
          key: context
        id:
        - id
        - id
        version: 0
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          items:
            type: string
          type: array
        version:
          description: |
            Version of the table to check existence.
            If not specified, server should resolve it to the latest version.
          format: int64
          minimum: 0
          type: integer
    TransactionStatus:
      description: |
        The status of a transaction.
        Case insensitive, supports both PascalCase and snake_case. Valid values are:
        - Queued: the transaction is queued and not yet started
        - Running: the transaction is currently running
        - Succeeded: the transaction has completed successfully
        - Failed: the transaction has failed
        - Canceled: the transaction was canceled
      type: string
    DescribeTransactionRequest:
      example:
        identity:
          api_key: api_key
          auth_token: auth_token
        context:
          key: context
        id:
        - id
        - id
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          items:
            type: string
          type: array
    DescribeTransactionResponse:
      example:
        properties:
          key: properties
        status: status
      properties:
        status:
          description: |
            The status of a transaction.
            Case insensitive, supports both PascalCase and snake_case. Valid values are:
            - Queued: the transaction is queued and not yet started
            - Running: the transaction is currently running
            - Succeeded: the transaction has completed successfully
            - Failed: the transaction has failed
            - Canceled: the transaction was canceled
          type: string
        properties:
          additionalProperties:
            type: string
      required:
      - status
    AlterTransactionSetStatus:
      example:
        status: status
      properties:
        status:
          description: |
            The status of a transaction.
            Case insensitive, supports both PascalCase and snake_case. Valid values are:
            - Queued: the transaction is queued and not yet started
            - Running: the transaction is currently running
            - Succeeded: the transaction has completed successfully
            - Failed: the transaction has failed
            - Canceled: the transaction was canceled
          type: string
    AlterTransactionSetProperty:
      example:
        mode: mode
        value: value
        key: key
      properties:
        key:
          type: string
        value:
          type: string
        mode:
          description: |
            The behavior if the property key already exists.
            Case insensitive, supports both PascalCase and snake_case. Valid values are:
            - Overwrite (default): overwrite the existing value with the provided value
            - Fail: fail the entire operation
            - Skip: keep the existing value and skip setting the provided value
          type: string
    SetPropertyMode:
      description: |
        The behavior if the property key already exists.
        Case insensitive, supports both PascalCase and snake_case. Valid values are:
        - Overwrite (default): overwrite the existing value with the provided value
        - Fail: fail the entire operation
        - Skip: keep the existing value and skip setting the provided value
      type: string
    AlterTransactionUnsetProperty:
      example:
        mode: mode
        key: key
      properties:
        key:
          type: string
        mode:
          description: |
            The behavior if the property key to unset does not exist.
            Case insensitive, supports both PascalCase and snake_case. Valid values are:
            - Skip (default): skip the property to unset
            - Fail: fail the entire operation
          type: string
    UnsetPropertyMode:
      description: |
        The behavior if the property key to unset does not exist.
        Case insensitive, supports both PascalCase and snake_case. Valid values are:
        - Skip (default): skip the property to unset
        - Fail: fail the entire operation
      type: string
    AlterTransactionAction:
      description: |
        A single action that could be performed to alter a transaction.
        This action holds the model definition for all types of specific actions models,
        this is to minimize difference and compatibility issue across codegen in different languages.
        When used, only one of the actions should be non-null for each action.
        If you would like to perform multiple actions, set a list of actions in the AlterTransactionRequest.
      example:
        setStatusAction:
          status: status
        unsetPropertyAction:
          mode: mode
          key: key
        setPropertyAction:
          mode: mode
          value: value
          key: key
      properties:
        setStatusAction:
          $ref: '#/components/schemas/AlterTransactionSetStatus'
        setPropertyAction:
          $ref: '#/components/schemas/AlterTransactionSetProperty'
        unsetPropertyAction:
          $ref: '#/components/schemas/AlterTransactionUnsetProperty'
    AlterTransactionRequest:
      description: |
        Alter a transaction with a list of actions.
        The server should either succeed and apply all actions, or fail and apply no action.
      example:
        identity:
          api_key: api_key
          auth_token: auth_token
        context:
          key: context
        id:
        - id
        - id
        actions:
        - setStatusAction:
            status: status
          unsetPropertyAction:
            mode: mode
            key: key
          setPropertyAction:
            mode: mode
            value: value
            key: key
        - setStatusAction:
            status: status
          unsetPropertyAction:
            mode: mode
            key: key
          setPropertyAction:
            mode: mode
            value: value
            key: key
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          items:
            type: string
          type: array
        actions:
          items:
            $ref: '#/components/schemas/AlterTransactionAction'
          minItems: 1
          type: array
      required:
      - actions
    AlterTransactionResponse:
      example:
        properties:
          key: properties
        status: status
      properties:
        status:
          description: |
            The status of a transaction.
            Case insensitive, supports both PascalCase and snake_case. Valid values are:
            - Queued: the transaction is queued and not yet started
            - Running: the transaction is currently running
            - Succeeded: the transaction has completed successfully
            - Failed: the transaction has failed
            - Canceled: the transaction was canceled
          type: string
        properties:
          additionalProperties:
            type: string
      required:
      - status
    DropTableRequest:
      description: |
        If the table and its data can be immediately deleted, return information of the deleted table.
        Otherwise, return a transaction ID that client can use to track deletion progress.
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          items:
            type: string
          type: array
    DropTableResponse:
      example:
        transaction_id: transaction_id
        location: location
        id:
        - id
        - id
        properties:
          key: properties
      properties:
        transaction_id:
          description: Optional transaction identifier
          type: string
        id:
          items:
            type: string
          type: array
        location:
          type: string
        properties:
          additionalProperties:
            type: string
    DeregisterTableRequest:
      description: |
        The table content remains available in the storage.
      example:
        identity:
          api_key: api_key
          auth_token: auth_token
        context:
          key: context
        id:
        - id
        - id
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          items:
            type: string
          type: array
    DeregisterTableResponse:
      example:
        transaction_id: transaction_id
        location: location
        id:
        - id
        - id
        properties:
          key: properties
      properties:
        transaction_id:
          description: Optional transaction identifier
          type: string
        id:
          items:
            type: string
          type: array
        location:
          type: string
        properties:
          additionalProperties:
            type: string
    StringFtsQuery:
      example:
        columns:
        - columns
        - columns
        query: query
      properties:
        columns:
          items:
            type: string
          type: array
        query:
          type: string
      required:
      - query
    StructuredFtsQuery:
      example:
        query:
          boolean:
            must_not:
            - null
            - null
            should:
            - null
            - null
            must:
            - null
            - null
          phrase:
            terms: terms
            column: column
            slop: 0
          match:
            fuzziness: 0
            terms: terms
            column: column
            boost: 6.0274563
            prefix_length: 0
            operator: operator
            max_expansions: 0
          boost:
            negative: null
            negative_boost: 7.0614014
            positive: null
          multi_match:
            match_queries:
            - fuzziness: 0
              terms: terms
              column: column
              boost: 6.0274563
              prefix_length: 0
              operator: operator
              max_expansions: 0
            - fuzziness: 0
              terms: terms
              column: column
              boost: 6.0274563
              prefix_length: 0
              operator: operator
              max_expansions: 0
      properties:
        query:
          $ref: '#/components/schemas/FtsQuery'
      required:
      - query
    FtsQuery:
      description: |
        Full-text search query. Exactly one query type field must be provided.
        This structure follows the same pattern as AlterTransactionAction to minimize
        differences and compatibility issues across codegen in different languages.
      example:
        boolean:
          must_not:
          - null
          - null
          should:
          - null
          - null
          must:
          - null
          - null
        phrase:
          terms: terms
          column: column
          slop: 0
        match:
          fuzziness: 0
          terms: terms
          column: column
          boost: 6.0274563
          prefix_length: 0
          operator: operator
          max_expansions: 0
        boost:
          negative: null
          negative_boost: 7.0614014
          positive: null
        multi_match:
          match_queries:
          - fuzziness: 0
            terms: terms
            column: column
            boost: 6.0274563
            prefix_length: 0
            operator: operator
            max_expansions: 0
          - fuzziness: 0
            terms: terms
            column: column
            boost: 6.0274563
            prefix_length: 0
            operator: operator
            max_expansions: 0
      properties:
        match:
          $ref: '#/components/schemas/MatchQuery'
        phrase:
          $ref: '#/components/schemas/PhraseQuery'
        boost:
          $ref: '#/components/schemas/BoostQuery'
        multi_match:
          $ref: '#/components/schemas/MultiMatchQuery'
        boolean:
          $ref: '#/components/schemas/BooleanQuery'
    MatchQuery:
      example:
        fuzziness: 0
        terms: terms
        column: column
        boost: 6.0274563
        prefix_length: 0
        operator: operator
        max_expansions: 0
      properties:
        boost:
          format: float
          type: number
        column:
          type: string
        fuzziness:
          format: int32
          minimum: 0
          type: integer
        max_expansions:
          description: |-
            The maximum number of terms to expand for fuzzy matching.
            Default to 50.
          minimum: 0
          type: integer
        operator:
          description: |
            The operator to use for combining terms.
            Case insensitive, supports both PascalCase and snake_case. Valid values are:
            - And: All terms must match.
            - Or: At least one term must match.
          type: string
        prefix_length:
          description: |-
            The number of beginning characters being unchanged for fuzzy matching.
            Default to 0.
          format: int32
          minimum: 0
          type: integer
        terms:
          type: string
      required:
      - terms
    PhraseQuery:
      example:
        terms: terms
        column: column
        slop: 0
      properties:
        column:
          type: string
        slop:
          format: int32
          minimum: 0
          type: integer
        terms:
          type: string
      required:
      - terms
    BoostQuery:
      description: Boost query that scores documents matching positive query higher
        and negative query lower
      example:
        negative: null
        negative_boost: 7.0614014
        positive: null
      properties:
        positive:
          $ref: '#/components/schemas/FtsQuery'
        negative:
          $ref: '#/components/schemas/FtsQuery'
        negative_boost:
          default: 0.5
          description: "Boost factor for negative query (default: 0.5)"
          format: float
          type: number
      required:
      - negative
      - positive
    MultiMatchQuery:
      example:
        match_queries:
        - fuzziness: 0
          terms: terms
          column: column
          boost: 6.0274563
          prefix_length: 0
          operator: operator
          max_expansions: 0
        - fuzziness: 0
          terms: terms
          column: column
          boost: 6.0274563
          prefix_length: 0
          operator: operator
          max_expansions: 0
      properties:
        match_queries:
          items:
            $ref: '#/components/schemas/MatchQuery'
          type: array
      required:
      - match_queries
    BooleanQuery:
      description: "Boolean query with must, should, and must_not clauses"
      example:
        must_not:
        - null
        - null
        should:
        - null
        - null
        must:
        - null
        - null
      properties:
        must:
          description: Queries that must match (AND)
          items:
            $ref: '#/components/schemas/FtsQuery'
          type: array
        must_not:
          description: Queries that must not match (NOT)
          items:
            $ref: '#/components/schemas/FtsQuery'
          type: array
        should:
          description: Queries that should match (OR)
          items:
            $ref: '#/components/schemas/FtsQuery'
          type: array
      required:
      - must
      - must_not
      - should
    Operator:
      description: |
        The operator to use for combining terms.
        Case insensitive, supports both PascalCase and snake_case. Valid values are:
        - And: All terms must match.
        - Or: At least one term must match.
      type: string
    GetTableTagVersionRequest:
      example:
        identity:
          api_key: api_key
          auth_token: auth_token
        context:
          key: context
        id:
        - id
        - id
        tag: tag
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          items:
            type: string
          type: array
        tag:
          description: Name of the tag to get version for
          type: string
      required:
      - tag
    GetTableTagVersionResponse:
      example:
        version: 0
      properties:
        version:
          description: version number that the tag points to
          format: int64
          minimum: 0
          type: integer
      required:
      - version
    CreateTableTagRequest:
      example:
        identity:
          api_key: api_key
          auth_token: auth_token
        context:
          key: context
        id:
        - id
        - id
        tag: tag
        version: 0
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          items:
            type: string
          type: array
        tag:
          description: Name of the tag to create
          type: string
        version:
          description: Version number for the tag to point to
          format: int64
          minimum: 0
          type: integer
      required:
      - tag
      - version
    CreateTableTagResponse:
      description: Response for create tag operation
      example:
        transaction_id: transaction_id
      properties:
        transaction_id:
          description: Optional transaction identifier
          type: string
    DeleteTableTagRequest:
      example:
        identity:
          api_key: api_key
          auth_token: auth_token
        context:
          key: context
        id:
        - id
        - id
        tag: tag
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          items:
            type: string
          type: array
        tag:
          description: Name of the tag to delete
          type: string
      required:
      - tag
    DeleteTableTagResponse:
      description: Response for delete tag operation
      example:
        transaction_id: transaction_id
      properties:
        transaction_id:
          description: Optional transaction identifier
          type: string
    UpdateTableTagRequest:
      example:
        identity:
          api_key: api_key
          auth_token: auth_token
        context:
          key: context
        id:
        - id
        - id
        tag: tag
        version: 0
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          items:
            type: string
          type: array
        tag:
          description: Name of the tag to update
          type: string
        version:
          description: New version number for the tag to point to
          format: int64
          minimum: 0
          type: integer
      required:
      - tag
      - version
    UpdateTableTagResponse:
      description: Response for update tag operation
      example:
        transaction_id: transaction_id
      properties:
        transaction_id:
          description: Optional transaction identifier
          type: string
    ListTableTagsRequest:
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          description: The table identifier
          items:
            type: string
          type: array
        page_token:
          description: "An opaque token that allows pagination for list operations\
            \ (e.g. ListNamespaces).\n\nFor an initial request of a list operation,\
            \ \nif the implementation cannot return all items in one response,\nor\
            \ if there are more items than the page limit specified in the request,\n\
            the implementation must return a page token in the response,\nindicating\
            \ there are more results available.\n\nAfter the initial request, \nthe\
            \ value of the page token from each response must be used\nas the page\
            \ token value for the next request.\n\nCaller must interpret either `null`,\
            \ \nmissing value or empty string value of the page token from\nthe implementation's\
            \ response as the end of the listing results.\n"
          type: string
          nullable: true
        limit:
          description: "An inclusive upper bound of the \nnumber of results that a\
            \ caller will receive.\n"
          type: integer
          nullable: true
    ListTableTagsResponse:
      description: Response containing table tags
      example:
        page_token: page_token
        tags:
          key:
            branch: branch
            version: 0
            manifestSize: 0
      properties:
        tags:
          additionalProperties:
            $ref: '#/components/schemas/TagContents'
          description: Map of tag names to their contents
        page_token:
          description: "An opaque token that allows pagination for list operations\
            \ (e.g. ListNamespaces).\n\nFor an initial request of a list operation,\
            \ \nif the implementation cannot return all items in one response,\nor\
            \ if there are more items than the page limit specified in the request,\n\
            the implementation must return a page token in the response,\nindicating\
            \ there are more results available.\n\nAfter the initial request, \nthe\
            \ value of the page token from each response must be used\nas the page\
            \ token value for the next request.\n\nCaller must interpret either `null`,\
            \ \nmissing value or empty string value of the page token from\nthe implementation's\
            \ response as the end of the listing results.\n"
          type: string
          nullable: true
      required:
      - tags
    TagContents:
      example:
        branch: branch
        version: 0
        manifestSize: 0
      properties:
        branch:
          description: Branch name that the tag was created on (if any)
          type: string
        version:
          description: Version number that the tag points to
          format: int64
          minimum: 0
          type: integer
        manifestSize:
          description: Size of the manifest file in bytes
          format: int64
          minimum: 0
          type: integer
      required:
      - manifestSize
      - version
    RestoreTableRequest:
      example:
        identity:
          api_key: api_key
          auth_token: auth_token
        context:
          key: context
        id:
        - id
        - id
        version: 0
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          items:
            type: string
          type: array
        version:
          description: Version to restore to
          format: int64
          minimum: 0
          type: integer
      required:
      - version
    RestoreTableResponse:
      description: Response for restore table operation
      example:
        transaction_id: transaction_id
      properties:
        transaction_id:
          description: Optional transaction identifier
          type: string
    RenameTableRequest:
      example:
        identity:
          api_key: api_key
          auth_token: auth_token
        context:
          key: context
        new_table_name: new_table_name
        id:
        - id
        - id
        new_namespace_id:
        - new_namespace_id
        - new_namespace_id
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          description: The table identifier
          items:
            type: string
          type: array
        new_table_name:
          description: New name for the table
          type: string
        new_namespace_id:
          description: "New namespace identifier to move the table to (optional, if\
            \ not specified the table stays in the same namespace)"
          items:
            type: string
          type: array
      required:
      - new_table_name
    RenameTableResponse:
      example:
        transaction_id: transaction_id
      properties:
        transaction_id:
          description: Optional transaction identifier
          type: string
    UpdateTableSchemaMetadataRequest:
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          description: The table identifier
          items:
            type: string
          type: array
        metadata:
          additionalProperties:
            type: string
          description: Schema metadata key-value pairs to set
    UpdateTableSchemaMetadataResponse:
      properties:
        metadata:
          additionalProperties:
            type: string
          description: The updated schema metadata
        transaction_id:
          description: Optional transaction identifier
          type: string
    ListTableVersionsRequest:
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          items:
            type: string
          type: array
        page_token:
          description: "An opaque token that allows pagination for list operations\
            \ (e.g. ListNamespaces).\n\nFor an initial request of a list operation,\
            \ \nif the implementation cannot return all items in one response,\nor\
            \ if there are more items than the page limit specified in the request,\n\
            the implementation must return a page token in the response,\nindicating\
            \ there are more results available.\n\nAfter the initial request, \nthe\
            \ value of the page token from each response must be used\nas the page\
            \ token value for the next request.\n\nCaller must interpret either `null`,\
            \ \nmissing value or empty string value of the page token from\nthe implementation's\
            \ response as the end of the listing results.\n"
          type: string
          nullable: true
        limit:
          description: "An inclusive upper bound of the \nnumber of results that a\
            \ caller will receive.\n"
          type: integer
          nullable: true
    ListTableVersionsResponse:
      example:
        versions:
        - metadata:
            key: metadata
          version: 0
          timestamp: 2000-01-23T04:56:07.000+00:00
        - metadata:
            key: metadata
          version: 0
          timestamp: 2000-01-23T04:56:07.000+00:00
        page_token: page_token
      properties:
        versions:
          description: List of table versions
          items:
            $ref: '#/components/schemas/TableVersion'
          type: array
        page_token:
          description: "An opaque token that allows pagination for list operations\
            \ (e.g. ListNamespaces).\n\nFor an initial request of a list operation,\
            \ \nif the implementation cannot return all items in one response,\nor\
            \ if there are more items than the page limit specified in the request,\n\
            the implementation must return a page token in the response,\nindicating\
            \ there are more results available.\n\nAfter the initial request, \nthe\
            \ value of the page token from each response must be used\nas the page\
            \ token value for the next request.\n\nCaller must interpret either `null`,\
            \ \nmissing value or empty string value of the page token from\nthe implementation's\
            \ response as the end of the listing results.\n"
          type: string
          nullable: true
      required:
      - versions
    TableVersion:
      example:
        metadata:
          key: metadata
        version: 0
        timestamp: 2000-01-23T04:56:07.000+00:00
      properties:
        version:
          description: Version number
          format: int64
          minimum: 0
          type: integer
        timestamp:
          description: Timestamp when the version was created
          format: date-time
          type: string
        metadata:
          additionalProperties:
            type: string
          description: Key-value pairs of metadata
      required:
      - metadata
      - timestamp
      - version
    ExplainTableQueryPlanRequest:
      example:
        identity:
          api_key: api_key
          auth_token: auth_token
        query:
          ef: 0
          offset: 0
          columns:
            column_aliases:
              key: column_aliases
            column_names:
            - column_names
            - column_names
          vector_column: vector_column
          fast_search: true
          k: 0
          upper_bound: 1.2315135
          version: 0
          with_row_id: true
          prefilter: true
          filter: filter
          refine_factor: 0
          full_text_query:
            string_query:
              columns:
              - columns
              - columns
              query: query
            structured_query:
              query:
                boolean:
                  must_not:
                  - null
                  - null
                  should:
                  - null
                  - null
                  must:
                  - null
                  - null
                phrase:
                  terms: terms
                  column: column
                  slop: 0
                match:
                  fuzziness: 0
                  terms: terms
                  column: column
                  boost: 6.0274563
                  prefix_length: 0
                  operator: operator
                  max_expansions: 0
                boost:
                  negative: null
                  negative_boost: 7.0614014
                  positive: null
                multi_match:
                  match_queries:
                  - fuzziness: 0
                    terms: terms
                    column: column
                    boost: 6.0274563
                    prefix_length: 0
                    operator: operator
                    max_expansions: 0
                  - fuzziness: 0
                    terms: terms
                    column: column
                    boost: 6.0274563
                    prefix_length: 0
                    operator: operator
                    max_expansions: 0
          distance_type: distance_type
          lower_bound: 3.6160767
          identity:
            api_key: api_key
            auth_token: auth_token
          bypass_vector_index: true
          nprobes: 0
          context:
            key: context
          vector:
            single_vector:
            - 1.0246457
            - 1.0246457
            multi_vector:
            - - 1.4894159
              - 1.4894159
            - - 1.4894159
              - 1.4894159
          id:
          - id
          - id
        context:
          key: context
        id:
        - id
        - id
        verbose: false
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          items:
            type: string
          type: array
        query:
          $ref: '#/components/schemas/QueryTableRequest'
        verbose:
          default: false
          description: Whether to return verbose explanation
          type: boolean
      required:
      - query
    ExplainTableQueryPlanResponse:
      properties:
        plan:
          description: Human-readable query execution plan
          type: string
      required:
      - plan
    AnalyzeTableQueryPlanRequest:
      example:
        ef: 0
        offset: 0
        columns:
          column_aliases:
            key: column_aliases
          column_names:
          - column_names
          - column_names
        vector_column: vector_column
        fast_search: true
        k: 0
        upper_bound: 1.2315135
        version: 0
        with_row_id: true
        prefilter: true
        filter: filter
        refine_factor: 0
        full_text_query:
          string_query:
            columns:
            - columns
            - columns
            query: query
          structured_query:
            query:
              boolean:
                must_not:
                - null
                - null
                should:
                - null
                - null
                must:
                - null
                - null
              phrase:
                terms: terms
                column: column
                slop: 0
              match:
                fuzziness: 0
                terms: terms
                column: column
                boost: 6.0274563
                prefix_length: 0
                operator: operator
                max_expansions: 0
              boost:
                negative: null
                negative_boost: 7.0614014
                positive: null
              multi_match:
                match_queries:
                - fuzziness: 0
                  terms: terms
                  column: column
                  boost: 6.0274563
                  prefix_length: 0
                  operator: operator
                  max_expansions: 0
                - fuzziness: 0
                  terms: terms
                  column: column
                  boost: 6.0274563
                  prefix_length: 0
                  operator: operator
                  max_expansions: 0
        distance_type: distance_type
        lower_bound: 3.6160767
        identity:
          api_key: api_key
          auth_token: auth_token
        bypass_vector_index: true
        nprobes: 0
        context:
          key: context
        vector:
          single_vector:
          - 1.0246457
          - 1.0246457
          multi_vector:
          - - 1.4894159
            - 1.4894159
          - - 1.4894159
            - 1.4894159
        id:
        - id
        - id
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          items:
            type: string
          type: array
        bypass_vector_index:
          description: Whether to bypass vector index
          type: boolean
        columns:
          $ref: '#/components/schemas/QueryTableRequest_columns'
        distance_type:
          description: Distance metric to use
          type: string
        ef:
          description: Search effort parameter for HNSW index
          minimum: 0
          type: integer
        fast_search:
          description: Whether to use fast search
          type: boolean
        filter:
          description: Optional SQL filter expression
          type: string
        full_text_query:
          $ref: '#/components/schemas/QueryTableRequest_full_text_query'
        k:
          description: Number of results to return
          minimum: 0
          type: integer
        lower_bound:
          description: Lower bound for search
          format: float
          type: number
        nprobes:
          description: Number of probes for IVF index
          minimum: 0
          type: integer
        offset:
          description: Number of results to skip
          minimum: 0
          type: integer
        prefilter:
          description: Whether to apply filtering before vector search
          type: boolean
        refine_factor:
          description: Refine factor for search
          format: int32
          minimum: 0
          type: integer
        upper_bound:
          description: Upper bound for search
          format: float
          type: number
        vector:
          $ref: '#/components/schemas/QueryTableRequest_vector'
        vector_column:
          description: Name of the vector column to search
          type: string
        version:
          description: Table version to query
          format: int64
          minimum: 0
          type: integer
        with_row_id:
          description: "If true, return the row id as a column called `_rowid`"
          type: boolean
      required:
      - k
      - vector
    AnalyzeTableQueryPlanResponse:
      properties:
        analysis:
          description: Detailed analysis of the query execution plan
          type: string
      required:
      - analysis
    AlterTableAddColumnsRequest:
      example:
        identity:
          api_key: api_key
          auth_token: auth_token
        new_columns:
        - expression: expression
          name: name
          virtual_column:
            image: image
            udf: udf
            udf_name: udf_name
            input_columns:
            - input_columns
            - input_columns
            data_type: "{}"
            udf_version: udf_version
        - expression: expression
          name: name
          virtual_column:
            image: image
            udf: udf
            udf_name: udf_name
            input_columns:
            - input_columns
            - input_columns
            data_type: "{}"
            udf_version: udf_version
        context:
          key: context
        id:
        - id
        - id
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          items:
            type: string
          type: array
        new_columns:
          description: List of new columns to add
          items:
            $ref: '#/components/schemas/NewColumnTransform'
          type: array
      required:
      - new_columns
    NewColumnTransform:
      example:
        expression: expression
        name: name
        virtual_column:
          image: image
          udf: udf
          udf_name: udf_name
          input_columns:
          - input_columns
          - input_columns
          data_type: "{}"
          udf_version: udf_version
      properties:
        name:
          description: Name of the new column
          type: string
        expression:
          description: SQL expression to compute the column value (optional if virtual_column
            is specified)
          type: string
          nullable: true
        virtual_column:
          $ref: '#/components/schemas/AddVirtualColumnEntry'
      required:
      - name
    AddVirtualColumnEntry:
      example:
        image: image
        udf: udf
        udf_name: udf_name
        input_columns:
        - input_columns
        - input_columns
        data_type: "{}"
        udf_version: udf_version
      properties:
        input_columns:
          description: List of input column names for the virtual column
          items:
            type: string
          type: array
        data_type:
          description: Data type of the virtual column using JSON representation
          type: object
        image:
          description: Docker image to use for the UDF
          type: string
        udf:
          description: Base64 encoded pickled UDF
          type: string
        udf_name:
          description: Name of the UDF
          type: string
        udf_version:
          description: Version of the UDF
          type: string
      required:
      - data_type
      - image
      - input_columns
      - udf
      - udf_name
      - udf_version
    AlterTableAddColumnsResponse:
      example:
        transaction_id: transaction_id
        version: 0
      properties:
        transaction_id:
          description: Optional transaction identifier
          type: string
        version:
          description: Version of the table after adding columns
          format: int64
          minimum: 0
          type: integer
      required:
      - version
    AlterTableAlterColumnsRequest:
      example:
        identity:
          api_key: api_key
          auth_token: auth_token
        context:
          key: context
        alterations:
        - path: path
          nullable: true
          rename: rename
          data_type: "{}"
          virtual_column:
            image: image
            udf: udf
            udf_name: udf_name
            input_columns:
            - input_columns
            - input_columns
            udf_version: udf_version
        - path: path
          nullable: true
          rename: rename
          data_type: "{}"
          virtual_column:
            image: image
            udf: udf
            udf_name: udf_name
            input_columns:
            - input_columns
            - input_columns
            udf_version: udf_version
        id:
        - id
        - id
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          items:
            type: string
          type: array
        alterations:
          description: List of column alterations to perform
          items:
            $ref: '#/components/schemas/AlterColumnsEntry'
          type: array
      required:
      - alterations
    AlterColumnsEntry:
      example:
        path: path
        nullable: true
        rename: rename
        data_type: "{}"
        virtual_column:
          image: image
          udf: udf
          udf_name: udf_name
          input_columns:
          - input_columns
          - input_columns
          udf_version: udf_version
      properties:
        path:
          description: Column path to alter
          type: string
        data_type:
          description: New data type for the column using JSON representation (optional)
          type: object
        rename:
          description: New name for the column (optional)
          type: string
          nullable: true
        nullable:
          description: Whether the column should be nullable (optional)
          type: boolean
          nullable: true
        virtual_column:
          $ref: '#/components/schemas/AlterVirtualColumnEntry'
      required:
      - data_type
      - path
    AlterVirtualColumnEntry:
      example:
        image: image
        udf: udf
        udf_name: udf_name
        input_columns:
        - input_columns
        - input_columns
        udf_version: udf_version
      properties:
        input_columns:
          description: List of input column names for the virtual column (optional)
          items:
            type: string
          type: array
          nullable: true
        image:
          description: Docker image to use for the UDF (optional)
          type: string
          nullable: true
        udf:
          description: Base64 encoded pickled UDF (optional)
          type: string
          nullable: true
        udf_name:
          description: Name of the UDF (optional)
          type: string
          nullable: true
        udf_version:
          description: Version of the UDF (optional)
          type: string
          nullable: true
    AlterTableAlterColumnsResponse:
      example:
        transaction_id: transaction_id
        version: 0
      properties:
        transaction_id:
          description: Optional transaction identifier
          type: string
        version:
          description: Version of the table after altering columns
          format: int64
          minimum: 0
          type: integer
      required:
      - version
    AlterTableDropColumnsRequest:
      example:
        identity:
          api_key: api_key
          auth_token: auth_token
        columns:
        - columns
        - columns
        context:
          key: context
        id:
        - id
        - id
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          items:
            type: string
          type: array
        columns:
          description: Names of columns to drop
          items:
            type: string
          type: array
      required:
      - columns
    AlterTableDropColumnsResponse:
      example:
        transaction_id: transaction_id
        version: 0
      properties:
        transaction_id:
          description: Optional transaction identifier
          type: string
        version:
          description: Version of the table after dropping columns
          format: int64
          minimum: 0
          type: integer
      required:
      - version
    GetTableStatsRequest:
      example:
        identity:
          api_key: api_key
          auth_token: auth_token
        context:
          key: context
        id:
        - id
        - id
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          items:
            type: string
          type: array
    GetTableStatsResponse:
      example:
        num_indices: 0
        total_bytes: 0
        num_rows: 0
        fragment_stats:
          num_small_fragments: 0
          lengths:
            p99: 0
            p25: 0
            min: 0
            max: 0
            mean: 0
            p50: 0
            p75: 0
          num_fragments: 0
      properties:
        total_bytes:
          description: The total number of bytes in the table
          format: int64
          minimum: 0
          type: integer
        num_rows:
          description: The number of rows in the table
          format: int64
          minimum: 0
          type: integer
        num_indices:
          description: The number of indices in the table
          format: int64
          minimum: 0
          type: integer
        fragment_stats:
          $ref: '#/components/schemas/FragmentStats'
      required:
      - fragment_stats
      - num_indices
      - num_rows
      - total_bytes
    FragmentStats:
      example:
        num_small_fragments: 0
        lengths:
          p99: 0
          p25: 0
          min: 0
          max: 0
          mean: 0
          p50: 0
          p75: 0
        num_fragments: 0
      properties:
        num_fragments:
          description: The number of fragments in the table
          format: int64
          minimum: 0
          type: integer
        num_small_fragments:
          description: The number of uncompacted fragments in the table
          format: int64
          minimum: 0
          type: integer
        lengths:
          $ref: '#/components/schemas/FragmentSummary'
      required:
      - lengths
      - num_fragments
      - num_small_fragments
    FragmentSummary:
      example:
        p99: 0
        p25: 0
        min: 0
        max: 0
        mean: 0
        p50: 0
        p75: 0
      properties:
        min:
          format: int64
          minimum: 0
          type: integer
        max:
          format: int64
          minimum: 0
          type: integer
        mean:
          format: int64
          minimum: 0
          type: integer
        p25:
          format: int64
          minimum: 0
          type: integer
        p50:
          format: int64
          minimum: 0
          type: integer
        p75:
          format: int64
          minimum: 0
          type: integer
        p99:
          format: int64
          minimum: 0
          type: integer
      required:
      - max
      - mean
      - min
      - p25
      - p50
      - p75
      - p99
    DropTableIndexRequest:
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        context:
          additionalProperties:
            type: string
          description: |
            Arbitrary context for a request as key-value pairs.
            How to use the context is custom to the specific implementation.

            REST NAMESPACE ONLY
            Context entries are passed via HTTP headers using the naming convention
            `x-lance-ctx-<key>: <value>`. For example, a context entry
            `{"trace_id": "abc123"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
        id:
          items:
            type: string
          type: array
        index_name:
          description: Name of the index to drop
          type: string
    DropTableIndexResponse:
      description: Response for drop index operation
      example:
        transaction_id: transaction_id
      properties:
        transaction_id:
          description: Optional transaction identifier
          type: string
    QueryTableRequest_columns:
      description: |
        Optional columns to return. Provide either column_names or column_aliases, not both.
      example:
        column_aliases:
          key: column_aliases
        column_names:
        - column_names
        - column_names
      properties:
        column_names:
          description: List of column names to return
          items:
            type: string
          type: array
        column_aliases:
          additionalProperties:
            type: string
          description: Object mapping output aliases to source column names
      nullable: true
    QueryTableRequest_full_text_query:
      description: "Optional full-text search query. Provide either string_query or\
        \ structured_query, not both."
      example:
        string_query:
          columns:
          - columns
          - columns
          query: query
        structured_query:
          query:
            boolean:
              must_not:
              - null
              - null
              should:
              - null
              - null
              must:
              - null
              - null
            phrase:
              terms: terms
              column: column
              slop: 0
            match:
              fuzziness: 0
              terms: terms
              column: column
              boost: 6.0274563
              prefix_length: 0
              operator: operator
              max_expansions: 0
            boost:
              negative: null
              negative_boost: 7.0614014
              positive: null
            multi_match:
              match_queries:
              - fuzziness: 0
                terms: terms
                column: column
                boost: 6.0274563
                prefix_length: 0
                operator: operator
                max_expansions: 0
              - fuzziness: 0
                terms: terms
                column: column
                boost: 6.0274563
                prefix_length: 0
                operator: operator
                max_expansions: 0
      properties:
        string_query:
          $ref: '#/components/schemas/StringFtsQuery'
        structured_query:
          $ref: '#/components/schemas/StructuredFtsQuery'
      nullable: true
    QueryTableRequest_vector:
      description: "Query vector(s) for similarity search. Provide either single_vector\
        \ or multi_vector, not both."
      example:
        single_vector:
        - 1.0246457
        - 1.0246457
        multi_vector:
        - - 1.4894159
          - 1.4894159
        - - 1.4894159
          - 1.4894159
      properties:
        single_vector:
          description: Single query vector
          items:
            format: float
            type: number
          type: array
        multi_vector:
          description: Multiple query vectors for batch search
          items:
            items:
              format: float
              type: number
            type: array
          type: array
      nullable: true
  securitySchemes:
    OAuth2:
      flows:
        clientCredentials:
          scopes: {}
          tokenUrl: /oauth/token
      type: oauth2
    BearerAuth:
      scheme: bearer
      type: http
    ApiKeyAuth:
      in: header
      name: x-api-key
      type: apiKey