openapi.yaml

openapi: 3.0.3
info:
  title: lowcode-database API
  description: |
    Postgres-backed low-code table service: dynamic tables, columns, rows, indexes,
    relations, and saved queries.

    Optional HTTP webhooks: `/v1/admin/webhooks`. Out of scope (schema bundle import,
    plugins, graph expand, ENUM, RBAC): see docs/roadmap.md.

    **Multi-tenant:** send `X-Tenant-Id` on every request when `TENANT_MODE=multi`.
    In single-tenant mode the header is optional (default tenant from env).

    **Playground:** [lowcode-database-playground](https://github.com/monoposer/lowcode-database-playground) — AG Grid UI (separate repo).

    Errors are returned as plain text (`http.Error`), not JSON envelopes.
  version: 1.0.0
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT

servers:
  - url: http://localhost:8080
    description: Local dev (see HTTP_ADDR in .env)

tags:
  - name: Platform
  - name: Types
  - name: Tables
  - name: Columns
  - name: Indexes
  - name: Schema
  - name: Relations
  - name: Queries

paths:
  /v1/admin/database/connection:
    get:
      tags: [Platform]
      summary: Get tenant database connection info (no password)
      operationId: getDatabaseConnection
      parameters:
        - $ref: "#/components/parameters/TenantIdHeader"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GetDatabaseConnectionResponse"
        "400":
          $ref: "#/components/responses/Error"
        "404":
          $ref: "#/components/responses/Error"

  /v1/admin/tenants:
    post:
      tags: [Platform]
      summary: Provision a tenant (multi-tenant mode)
      operationId: createTenant
      parameters:
        - $ref: "#/components/parameters/TenantIdHeader"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateTenantRequest"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CreateTenantResponse"
        "400":
          $ref: "#/components/responses/Error"

  /v1/admin/types:
    get:
      tags: [Types]
      summary: List built-in column types
      operationId: listTypes
      parameters:
        - $ref: "#/components/parameters/TenantIdHeader"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListTypesResponse"
        "400":
          $ref: "#/components/responses/Error"

  /v1/admin/pg-stat-statements:
    get:
      tags: [Platform]
      summary: List pg_stat_statements for the tenant data database
      description: |
        Requires `PG_STAT_STATEMENTS=true`. When disabled, returns `{ "enabled": false, "statements": [] }`.
        Postgres must load `shared_preload_libraries=pg_stat_statements` and the data migration must create the extension.
      operationId: listPGStatStatements
      parameters:
        - $ref: "#/components/parameters/TenantIdHeader"
        - name: limit
          in: query
          schema:
            type: integer
            default: 100
            maximum: 500
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListPGStatStatementsResponse"
        "400":
          $ref: "#/components/responses/Error"

  /v1/admin/tables:
    get:
      tags: [Tables]
      summary: List tables
      operationId: listTables
      parameters:
        - $ref: "#/components/parameters/TenantIdHeader"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListTablesResponse"
        "400":
          $ref: "#/components/responses/Error"
    post:
      tags: [Tables]
      summary: Create table
      operationId: createTable
      parameters:
        - $ref: "#/components/parameters/TenantIdHeader"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateTableRequest"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CreateTableResponse"
        "400":
          $ref: "#/components/responses/Error"

  /v1/admin/tables/{id}:
    delete:
      tags: [Tables]
      summary: Delete table
      operationId: deleteTable
      parameters:
        - $ref: "#/components/parameters/TenantIdHeader"
        - $ref: "#/components/parameters/IdPath"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DeleteTableResponse"
        "400":
          $ref: "#/components/responses/Error"
        "404":
          $ref: "#/components/responses/Error"

  /v1/admin/tables/{id}:rename:
    post:
      tags: [Tables]
      summary: Rename table
      operationId: renameTable
      parameters:
        - $ref: "#/components/parameters/TenantIdHeader"
        - $ref: "#/components/parameters/IdPath"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/RenameTableBody"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/RenameTableResponse"
        "400":
          $ref: "#/components/responses/Error"
        "404":
          $ref: "#/components/responses/Error"

  /v1/admin/tables/{tableName}/schema:
    get:
      tags: [Tables]
      summary: Get table schema (columns + indexes)
      operationId: getTableSchema
      parameters:
        - $ref: "#/components/parameters/TenantIdHeader"
        - $ref: "#/components/parameters/TableNamePath"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GetTableSchemaResponse"
        "400":
          $ref: "#/components/responses/Error"
        "404":
          $ref: "#/components/responses/Error"

  /v1/data/tables/{tableName}/rows:
    get:
      tags: [Tables]
      summary: List rows (paginated)
      operationId: listRows
      parameters:
        - $ref: "#/components/parameters/TenantIdHeader"
        - $ref: "#/components/parameters/TableNamePath"
        - name: pageSize
          in: query
          schema:
            type: integer
            format: int32
          description: Also accepted as `page_size`.
        - name: pageToken
          in: query
          schema:
            type: string
          description: Also accepted as `page_token`.
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListRowsResponse"
        "400":
          $ref: "#/components/responses/Error"
        "404":
          $ref: "#/components/responses/Error"
    post:
      tags: [Tables]
      summary: Create row
      operationId: createRow
      parameters:
        - $ref: "#/components/parameters/TenantIdHeader"
        - $ref: "#/components/parameters/TableNamePath"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateRowBody"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CreateRowResponse"
        "400":
          $ref: "#/components/responses/Error"
        "404":
          $ref: "#/components/responses/Error"

  /v1/data/tables/{tableName}/rows/{rowId}:
    patch:
      tags: [Tables]
      summary: Update row
      operationId: updateRow
      parameters:
        - $ref: "#/components/parameters/TenantIdHeader"
        - $ref: "#/components/parameters/TableNamePath"
        - $ref: "#/components/parameters/RowIdPath"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateRowBody"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/UpdateRowResponse"
        "400":
          $ref: "#/components/responses/Error"
        "404":
          $ref: "#/components/responses/Error"
    delete:
      tags: [Tables]
      summary: Delete row
      operationId: deleteRow
      parameters:
        - $ref: "#/components/parameters/TenantIdHeader"
        - $ref: "#/components/parameters/TableNamePath"
        - $ref: "#/components/parameters/RowIdPath"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DeleteRowResponse"
        "400":
          $ref: "#/components/responses/Error"
        "404":
          $ref: "#/components/responses/Error"

  /v1/data/tables/{tableName}/rows:query:
    post:
      tags: [Tables]
      summary: Query rows with filter, sort, and projection
      operationId: queryRows
      parameters:
        - $ref: "#/components/parameters/TenantIdHeader"
        - $ref: "#/components/parameters/TableNamePath"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/QueryRowsBody"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/QueryRowsResponse"
        "400":
          $ref: "#/components/responses/Error"
        "404":
          $ref: "#/components/responses/Error"

  /v1/data/tables/{tableName}/rows:bulkUpsert:
    post:
      tags: [Tables]
      summary: Bulk upsert rows
      operationId: bulkUpsertRows
      parameters:
        - $ref: "#/components/parameters/TenantIdHeader"
        - $ref: "#/components/parameters/TableNamePath"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BulkUpsertRowsBody"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/BulkUpsertRowsResponse"
        "400":
          $ref: "#/components/responses/Error"
        "404":
          $ref: "#/components/responses/Error"

  /v1/data/tables/{tableName}/rows:bulkDelete:
    post:
      tags: [Tables]
      summary: Bulk delete rows
      operationId: bulkDeleteRows
      parameters:
        - $ref: "#/components/parameters/TenantIdHeader"
        - $ref: "#/components/parameters/TableNamePath"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BulkDeleteRowsBody"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/BulkDeleteRowsResponse"
        "400":
          $ref: "#/components/responses/Error"
        "404":
          $ref: "#/components/responses/Error"

  /v1/admin/columns:
    get:
      tags: [Columns]
      summary: List columns for a table
      operationId: listColumns
      parameters:
        - $ref: "#/components/parameters/TenantIdHeader"
        - name: table_name
          in: query
          required: true
          schema:
            type: string
          description: Logical table id.
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListColumnsResponse"
        "400":
          $ref: "#/components/responses/Error"
    post:
      tags: [Columns]
      summary: Add column
      operationId: addColumn
      parameters:
        - $ref: "#/components/parameters/TenantIdHeader"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AddColumnRequest"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AddColumnResponse"
        "400":
          $ref: "#/components/responses/Error"

  /v1/admin/columns/{id}:
    patch:
      tags: [Columns]
      summary: Update column
      operationId: updateColumn
      parameters:
        - $ref: "#/components/parameters/TenantIdHeader"
        - $ref: "#/components/parameters/IdPath"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateColumnBody"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/UpdateColumnResponse"
        "400":
          $ref: "#/components/responses/Error"
        "404":
          $ref: "#/components/responses/Error"
    delete:
      tags: [Columns]
      summary: Delete column
      operationId: deleteColumn
      parameters:
        - $ref: "#/components/parameters/TenantIdHeader"
        - $ref: "#/components/parameters/IdPath"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DeleteColumnResponse"
        "400":
          $ref: "#/components/responses/Error"
        "404":
          $ref: "#/components/responses/Error"

  /v1/admin/indexes:
    get:
      tags: [Indexes]
      summary: List indexes for a table
      operationId: listIndexes
      parameters:
        - $ref: "#/components/parameters/TenantIdHeader"
        - name: table_name
          in: query
          required: true
          schema:
            type: string
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListIndexesResponse"
        "400":
          $ref: "#/components/responses/Error"
    post:
      tags: [Indexes]
      summary: Create index
      operationId: createIndex
      parameters:
        - $ref: "#/components/parameters/TenantIdHeader"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateIndexRequest"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CreateIndexResponse"
        "400":
          $ref: "#/components/responses/Error"

  /v1/admin/indexes/{id}:
    get:
      tags: [Indexes]
      summary: Get index by id
      operationId: getIndex
      parameters:
        - $ref: "#/components/parameters/TenantIdHeader"
        - $ref: "#/components/parameters/IdPath"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GetIndexResponse"
        "400":
          $ref: "#/components/responses/Error"
        "404":
          $ref: "#/components/responses/Error"
    delete:
      tags: [Indexes]
      summary: Delete index
      operationId: deleteIndex
      parameters:
        - $ref: "#/components/parameters/TenantIdHeader"
        - $ref: "#/components/parameters/IdPath"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DeleteIndexResponse"
        "400":
          $ref: "#/components/responses/Error"
        "404":
          $ref: "#/components/responses/Error"

  /v1/admin/schema/er:
    get:
      tags: [Schema]
      summary: Get ER diagram (tables, columns, relations)
      operationId: getERDiagram
      parameters:
        - $ref: "#/components/parameters/TenantIdHeader"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GetERDiagramResponse"
        "400":
          $ref: "#/components/responses/Error"

  /v1/admin/relations:
    get:
      tags: [Relations]
      summary: List relations
      operationId: listRelations
      parameters:
        - $ref: "#/components/parameters/TenantIdHeader"
        - name: table_name
          in: query
          schema:
            type: string
          description: Filter by table id (optional).
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListRelationsResponse"
        "400":
          $ref: "#/components/responses/Error"
    post:
      tags: [Relations]
      summary: Create relation
      operationId: createRelation
      parameters:
        - $ref: "#/components/parameters/TenantIdHeader"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateRelationRequest"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CreateRelationResponse"
        "400":
          $ref: "#/components/responses/Error"

  /v1/admin/relations/{id}:
    delete:
      tags: [Relations]
      summary: Delete relation
      operationId: deleteRelation
      parameters:
        - $ref: "#/components/parameters/TenantIdHeader"
        - $ref: "#/components/parameters/IdPath"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DeleteRelationResponse"
        "400":
          $ref: "#/components/responses/Error"
        "404":
          $ref: "#/components/responses/Error"

  /v1/admin/queries:
    get:
      tags: [Queries]
      summary: List saved queries
      operationId: listQueries
      parameters:
        - $ref: "#/components/parameters/TenantIdHeader"
        - name: table_name
          in: query
          schema:
            type: string
          description: Filter by table id (optional).
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListQueriesResponse"
        "400":
          $ref: "#/components/responses/Error"
    post:
      tags: [Queries]
      summary: Create a saved query
      operationId: createQuery
      parameters:
        - $ref: "#/components/parameters/TenantIdHeader"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateQueryRequest"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CreateQueryResponse"
        "400":
          $ref: "#/components/responses/Error"

  /v1/admin/queries/{id}:
    get:
      tags: [Queries]
      summary: Get a saved query
      operationId: getQuery
      parameters:
        - $ref: "#/components/parameters/TenantIdHeader"
        - $ref: "#/components/parameters/IdPath"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GetQueryResponse"
        "400":
          $ref: "#/components/responses/Error"
        "404":
          $ref: "#/components/responses/Error"
    patch:
      tags: [Queries]
      summary: Update a saved query
      operationId: updateQuery
      parameters:
        - $ref: "#/components/parameters/TenantIdHeader"
        - $ref: "#/components/parameters/IdPath"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateQueryBody"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/UpdateQueryResponse"
        "400":
          $ref: "#/components/responses/Error"
        "404":
          $ref: "#/components/responses/Error"
    delete:
      tags: [Queries]
      summary: Delete a saved query
      operationId: deleteQuery
      parameters:
        - $ref: "#/components/parameters/TenantIdHeader"
        - $ref: "#/components/parameters/IdPath"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DeleteQueryResponse"
        "400":
          $ref: "#/components/responses/Error"
        "404":
          $ref: "#/components/responses/Error"

  /v1/data/queries/{id}:
    post:
      tags: [Queries]
      summary: Execute a saved query
      operationId: executeQuery
      parameters:
        - $ref: "#/components/parameters/TenantIdHeader"
        - $ref: "#/components/parameters/IdPath"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ExecuteQueryBody"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ExecuteQueryResponse"
        "400":
          $ref: "#/components/responses/Error"
        "404":
          $ref: "#/components/responses/Error"

components:
  parameters:
    TenantIdHeader:
      name: X-Tenant-Id
      in: header
      required: false
      description: |
        Tenant identifier. Required in multi-tenant mode (`TENANT_MODE=multi`) to route
        to the tenant's Postgres database. Also accepted as `X-Tenant-ID`.
      schema:
        type: string
        example: default
    IdPath:
      name: id
      in: path
      required: true
      schema:
        type: string
    TableNamePath:
      name: tableName
      in: path
      required: true
      schema:
        type: string
    RowIdPath:
      name: rowId
      in: path
      required: true
      schema:
        type: string

  responses:
    Error:
      description: Error message (plain text from http.Error)
      content:
        text/plain:
          schema:
            type: string
            example: table_name query parameter is required

  schemas:
    Value:
      type: object
      description: Cell value union (one field set per value).
      properties:
        stringValue:
          type: string
        numberValue:
          type: number
          format: double
        boolValue:
          type: boolean
        timestampValue:
          type: string
          format: date-time
        bytesValue:
          type: string
          format: byte
        jsonValue: {}

    Row:
      type: object
      properties:
        id:
          type: string
        cells:
          type: object
          additionalProperties:
            $ref: "#/components/schemas/Value"

    Type:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        pgType:
          type: string
        config:
          type: object
          additionalProperties: true
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time

    Table:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        schemaName:
          type: string
        tableName:
          type: string
        idType:
          type: string
          description: Logical type id of the physical row id column (from PG catalog).
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time

    Column:
      type: object
      properties:
        id:
          type: string
        tableName:
          type: string
        name:
          type: string
        typeId:
          type: string
        pgColumn:
          type: string
        isNullable:
          type: boolean
        position:
          type: integer
          format: int32
        config:
          type: object
          additionalProperties: true
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time

    Index:
      type: object
      properties:
        id:
          type: string
        tableName:
          type: string
        name:
          type: string
        pgIndex:
          type: string
        columnIds:
          type: array
          items:
            type: string
        isUnique:
          type: boolean
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time

    CreateTenantRequest:
      type: object
      properties:
        id:
          type: string
        displayName:
          type: string
        dataDsn:
          type: string
          description: Write DSN (alias of dataDsnWrite)
        dataDsnWrite:
          type: string
        dataDsnReads:
          type: array
          items:
            type: string
          description: Read-replica DSNs (row query / export / saved-query)
        poolMaxConns:
          type: integer
        createDatabase:
          type: boolean
        recordStore:
          type: string
          enum: [shared, dedicated]
          description: >
            shared = public.record on the tenant data DSN (default).
            dedicated = {tenant_id}_record (and matching link_ref / calc_queue) on the same DSN.
            Physical database isolation is dataDsn / dataDsnWrite, not this field.

    CreateTenantResponse:
      type: object
      properties:
        id:
          type: string
        recordStore:
          type: string
          enum: [shared, dedicated]

    ListTypesResponse:
      type: object
      properties:
        types:
          type: array
          items:
            $ref: "#/components/schemas/Type"

    GetDatabaseConnectionResponse:
      type: object
      properties:
        host:
          type: string
        port:
          type: integer
          format: int32
        database:
          type: string
        user:
          type: string
        urlWithoutPassword:
          type: string
        psqlCommand:
          type: string
        passwordSourceHint:
          type: string

    ListPGStatStatementsResponse:
      type: object
      properties:
        enabled:
          type: boolean
        statements:
          type: array
          items:
            $ref: "#/components/schemas/PGStatStatement"

    PGStatStatement:
      type: object
      properties:
        queryId:
          type: string
        query:
          type: string
        calls:
          type: integer
          format: int64
        totalExecTimeMs:
          type: number
        meanExecTimeMs:
          type: number
        minExecTimeMs:
          type: number
        maxExecTimeMs:
          type: number
        rows:
          type: integer
          format: int64
        sharedBlksHit:
          type: integer
          format: int64
        sharedBlksRead:
          type: integer
          format: int64

    CreateTableRequest:
      type: object
      properties:
        name:
          type: string
        schemaName:
          type: string
        idType:
          type: string
          description: Built-in column type id for the physical row id column (default uuid).

    CreateTableResponse:
      type: object
      properties:
        table:
          $ref: "#/components/schemas/Table"

    DeleteTableResponse:
      type: object

    ListTablesResponse:
      type: object
      properties:
        tables:
          type: array
          items:
            $ref: "#/components/schemas/Table"

    RenameTableBody:
      type: object
      properties:
        newName:
          type: string
      description: Table id is taken from the path (`/v1/admin/tables/{id}:rename`).

    RenameTableResponse:
      type: object
      properties:
        table:
          $ref: "#/components/schemas/Table"

    GetTableSchemaResponse:
      type: object
      properties:
        table:
          $ref: "#/components/schemas/Table"
        columns:
          type: array
          items:
            $ref: "#/components/schemas/Column"
        indexes:
          type: array
          items:
            $ref: "#/components/schemas/Index"

    CreateRowBody:
      type: object
      properties:
        cells:
          type: object
          additionalProperties:
            $ref: "#/components/schemas/Value"
      description: Table id is taken from the path.

    CreateRowResponse:
      type: object
      properties:
        row:
          $ref: "#/components/schemas/Row"

    UpdateRowBody:
      type: object
      properties:
        cells:
          type: object
          additionalProperties:
            $ref: "#/components/schemas/Value"
      description: Table id and row id are taken from the path.

    UpdateRowResponse:
      type: object
      properties:
        row:
          $ref: "#/components/schemas/Row"

    DeleteRowResponse:
      type: object

    ListRowsResponse:
      type: object
      properties:
        rows:
          type: array
          items:
            $ref: "#/components/schemas/Row"
        nextPageToken:
          type: string

    SortOrder:
      type: object
      properties:
        attribute:
          type: string
        sortOrder:
          type: string
          enum: [ASC, DESC]

    QueryRowsBody:
      type: object
      properties:
        filter:
          type: object
          additionalProperties: true
        sort:
          type: array
          items:
            $ref: "#/components/schemas/SortOrder"
        columnIds:
          type: array
          items:
            type: string
        pageSize:
          type: integer
          format: int32
        pageToken:
          type: string
      description: Table id is taken from the path.

    QueryRowsResponse:
      type: object
      properties:
        rows:
          type: array
          items:
            $ref: "#/components/schemas/Row"
        nextPageToken:
          type: string
        count:
          type: integer
          format: int32

    BulkUpsertRowItem:
      type: object
      properties:
        rowId:
          type: string
        cells:
          type: object
          additionalProperties:
            $ref: "#/components/schemas/Value"

    BulkUpsertRowsBody:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: "#/components/schemas/BulkUpsertRowItem"
      description: Table id is taken from the path.

    BulkUpsertRowsResponse:
      type: object
      properties:
        rows:
          type: array
          items:
            $ref: "#/components/schemas/Row"

    BulkDeleteRowsBody:
      type: object
      properties:
        rowIds:
          type: array
          items:
            type: string
      description: Table id is taken from the path.

    BulkDeleteRowsResponse:
      type: object

    AddColumnRequest:
      type: object
      required: [tableName]
      properties:
        tableName:
          type: string
        name:
          type: string
        typeId:
          type: string
        isNullable:
          type: boolean
        position:
          type: integer
          format: int32
        config:
          type: object
          additionalProperties: true

    AddColumnResponse:
      type: object
      properties:
        column:
          $ref: "#/components/schemas/Column"

    UpdateColumnBody:
      type: object
      properties:
        name:
          type: string
        isNullable:
          type: boolean
          nullable: true
        position:
          type: integer
          format: int32
        config:
          type: object
          additionalProperties: true
      description: Column id is taken from the path.

    UpdateColumnResponse:
      type: object
      properties:
        column:
          $ref: "#/components/schemas/Column"

    DeleteColumnResponse:
      type: object

    ListColumnsResponse:
      type: object
      properties:
        columns:
          type: array
          items:
            $ref: "#/components/schemas/Column"

    CreateIndexRequest:
      type: object
      properties:
        tableName:
          type: string
        name:
          type: string
        columnIds:
          type: array
          items:
            type: string
        isUnique:
          type: boolean

    CreateIndexResponse:
      type: object
      properties:
        index:
          $ref: "#/components/schemas/Index"

    GetIndexResponse:
      type: object
      properties:
        index:
          $ref: "#/components/schemas/Index"

    DeleteIndexResponse:
      type: object

    ListIndexesResponse:
      type: object
      properties:
        indexes:
          type: array
          items:
            $ref: "#/components/schemas/Index"

    Relation:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        kind:
          type: string
          description: ONE_TO_ONE | ONE_TO_MANY | MANY_TO_ONE
        sourceTableName:
          type: string
        sourceColumnId:
          type: string
        targetTableName:
          type: string
        targetColumnId:
          type: string
        config:
          type: object
          additionalProperties: true
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time

    CreateRelationRequest:
      type: object
      properties:
        name:
          type: string
        kind:
          type: string
        sourceTableName:
          type: string
        sourceColumnId:
          type: string
        targetTableName:
          type: string
        targetColumnId:
          type: string
        config:
          type: object
          additionalProperties: true

    CreateRelationResponse:
      type: object
      properties:
        relation:
          $ref: "#/components/schemas/Relation"

    ListRelationsResponse:
      type: object
      properties:
        relations:
          type: array
          items:
            $ref: "#/components/schemas/Relation"

    DeleteRelationResponse:
      type: object

    Query:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        label:
          type: string
        tableName:
          type: string
        filter:
          type: object
          additionalProperties: true
        sort:
          type: array
          items:
            $ref: "#/components/schemas/SortOrder"
        columnIds:
          type: array
          items:
            type: string
        config:
          type: object
          additionalProperties: true
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time

    CreateQueryRequest:
      type: object
      properties:
        name:
          type: string
        label:
          type: string
        tableName:
          type: string
        filter:
          type: object
          additionalProperties: true
        sort:
          type: array
          items:
            $ref: "#/components/schemas/SortOrder"
        columnIds:
          type: array
          items:
            type: string
        config:
          type: object
          additionalProperties: true

    CreateQueryResponse:
      type: object
      properties:
        query:
          $ref: "#/components/schemas/Query"

    ListQueriesResponse:
      type: object
      properties:
        queries:
          type: array
          items:
            $ref: "#/components/schemas/Query"

    GetQueryResponse:
      type: object
      properties:
        query:
          $ref: "#/components/schemas/Query"

    UpdateQueryBody:
      type: object
      properties:
        label:
          type: string
        filter:
          type: object
          additionalProperties: true
        sort:
          type: array
          items:
            $ref: "#/components/schemas/SortOrder"
        columnIds:
          type: array
          items:
            type: string
        config:
          type: object
          additionalProperties: true
      description: Query name is taken from the path.

    UpdateQueryResponse:
      type: object
      properties:
        query:
          $ref: "#/components/schemas/Query"

    DeleteQueryResponse:
      type: object

    ExecuteQueryBody:
      type: object
      properties:
        pageSize:
          type: integer
          format: int32
        pageToken:
          type: string
        filter:
          type: object
          additionalProperties: true
        params:
          type: object
          additionalProperties: true
          description: Replaces `{param}` placeholders in the saved query filter.
        columnIds:
          type: array
          items:
            type: string
          description: Optional subset of the query view projection (column_names). Omitted = return all columns defined on the query (empty column_names = SELECT *).
      description: Query name is taken from the path.

    ExecuteQueryResponse:
      type: object
      properties:
        rows:
          type: array
          items:
            $ref: "#/components/schemas/Row"
        nextPageToken:
          type: string
        count:
          type: integer
          format: int32

    ERNode:
      type: object
      properties:
        tableName:
          type: string
        tableName:
          type: string
        label:
          type: string
        columns:
          type: array
          items:
            $ref: "#/components/schemas/Column"

    EREdge:
      type: object
      properties:
        id:
          type: string
        kind:
          type: string
        sourceTableName:
          type: string
        sourceColumnId:
          type: string
        targetTableName:
          type: string
        targetColumnId:
          type: string
        label:
          type: string

    ERDiagram:
      type: object
      properties:
        nodes:
          type: array
          items:
            $ref: "#/components/schemas/ERNode"
        edges:
          type: array
          items:
            $ref: "#/components/schemas/EREdge"

    GetERDiagramResponse:
      type: object
      properties:
        diagram:
          $ref: "#/components/schemas/ERDiagram"