openapi: 3.0.0
info:
  title: Lightdash AiAgents Organization Warehouse Credentials API
  version: 0.3156.1
  description: 'Open API documentation for all public Lightdash API endpoints. # Authentication Before you get started, you might need to create a Personal Access Token to authenticate via the API. You can create a token by following this guide: https://docs.lightdash.com/references/personal_tokens

    '
  license:
    name: MIT
  contact:
    name: Lightdash Support
    email: support@lightdash.com
    url: https://docs.lightdash.com/help-and-contact/contact/contact_info/
servers:
- url: /
tags:
- name: Organization Warehouse Credentials
paths:
  /api/v1/org/warehouse-credentials:
    get:
      operationId: ListOrganizationWarehouseCredentials
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/ApiOrganizationWarehouseCredentialsListResponse'
                - $ref: '#/components/schemas/ApiOrganizationWarehouseCredentialsSummaryListResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Get all warehouse credentials for the current organization
      summary: List warehouse credentials
      tags:
      - Organization Warehouse Credentials
      security: []
      parameters:
      - description: If true, returns only summaries (name, type) accessible to all members. If false/undefined, returns full credentials requiring manage permission.
        in: query
        name: summary
        required: false
        schema:
          type: boolean
    post:
      operationId: CreateOrganizationWarehouseCredentials
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiOrganizationWarehouseCredentialsResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Create new warehouse credentials for the organization
      summary: Create warehouse credentials
      tags:
      - Organization Warehouse Credentials
      security: []
      parameters: []
      requestBody:
        description: the warehouse credentials to create
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOrganizationWarehouseCredentials'
              description: the warehouse credentials to create
  /api/v1/org/warehouse-credentials/{credentialsUuid}:
    get:
      operationId: GetOrganizationWarehouseCredentials
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiOrganizationWarehouseCredentialsResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Get a specific warehouse credential by UUID
      summary: Get warehouse credential
      tags:
      - Organization Warehouse Credentials
      security: []
      parameters:
      - description: the UUID of the warehouse credentials
        in: path
        name: credentialsUuid
        required: true
        schema:
          type: string
    patch:
      operationId: UpdateOrganizationWarehouseCredentials
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiOrganizationWarehouseCredentialsResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Update existing warehouse credentials
      summary: Update warehouse credentials
      tags:
      - Organization Warehouse Credentials
      security: []
      parameters:
      - description: the UUID of the warehouse credentials to update
        in: path
        name: credentialsUuid
        required: true
        schema:
          type: string
      requestBody:
        description: the updated warehouse credentials
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOrganizationWarehouseCredentials'
              description: the updated warehouse credentials
    delete:
      operationId: DeleteOrganizationWarehouseCredentials
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSuccessEmpty'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Delete warehouse credentials
      summary: Delete warehouse credentials
      tags:
      - Organization Warehouse Credentials
      security: []
      parameters:
      - description: the UUID of the warehouse credentials to delete
        in: path
        name: credentialsUuid
        required: true
        schema:
          type: string
components:
  schemas:
    DucklakeDataPathGcs:
      $ref: '#/components/schemas/Omit_CreateDucklakeDataPathGcs.hmacKeyId-or-hmacSecret_'
    CreateDucklakeDataPath:
      anyOf:
      - $ref: '#/components/schemas/CreateDucklakeDataPathS3'
      - $ref: '#/components/schemas/CreateDucklakeDataPathGcs'
      - $ref: '#/components/schemas/CreateDucklakeDataPathAzure'
      - $ref: '#/components/schemas/CreateDucklakeDataPathLocal'
    TrinoCredentials:
      $ref: '#/components/schemas/Omit_CreateTrinoCredentials.SensitiveCredentialsFieldNames_'
    Pick_CreateDucklakeDataPathS3.Exclude_keyofCreateDucklakeDataPathS3.accessKeyId-or-secretAccessKey__:
      properties:
        type:
          $ref: '#/components/schemas/DucklakeDataPathType.S3'
        region:
          type: string
        url:
          type: string
        endpoint:
          type: string
        forcePathStyle:
          type: boolean
        useSsl:
          type: boolean
      required:
      - type
      - url
      type: object
      description: From T, pick a set of properties whose keys are in the union K
    DucklakeCatalogSqlite:
      $ref: '#/components/schemas/CreateDucklakeCatalogSqlite'
    DuckdbDucklakeCredentials:
      allOf:
      - $ref: '#/components/schemas/Omit_CreateDuckdbDucklakeCredentials.catalog-or-dataPath_'
      - properties:
          dataPath:
            $ref: '#/components/schemas/DucklakeDataPath'
          catalog:
            $ref: '#/components/schemas/DucklakeCatalog'
        required:
        - dataPath
        - catalog
        type: object
    Omit_CreateDatabricksCredentials.SensitiveCredentialsFieldNames_:
      $ref: '#/components/schemas/Pick_CreateDatabricksCredentials.Exclude_keyofCreateDatabricksCredentials.SensitiveCredentialsFieldNames__'
      description: Construct a type with the properties of T except for those in type K.
    DucklakeCatalogType.POSTGRES:
      enum:
      - postgres
      type: string
    ApiErrorPayload:
      properties:
        error:
          properties:
            data:
              $ref: '#/components/schemas/AnyType'
              description: Optional data containing details of the error
            message:
              type: string
              description: A friendly message summarising the error
            name:
              type: string
              description: Unique name for the type of error
            statusCode:
              type: number
              format: integer
              description: HTTP status code
          required:
          - name
          - statusCode
          type: object
        status:
          type: string
          enum:
          - error
          nullable: false
      required:
      - error
      - status
      type: object
      description: 'The Error object is returned from the api any time there is an error.

        The message contains'
    Omit_CreateDucklakeDataPathAzure.connectionString-or-accountKey_:
      $ref: '#/components/schemas/Pick_CreateDucklakeDataPathAzure.Exclude_keyofCreateDucklakeDataPathAzure.connectionString-or-accountKey__'
      description: Construct a type with the properties of T except for those in type K.
    WarehouseTypes.BIGQUERY:
      enum:
      - bigquery
      type: string
    OrganizationWarehouseCredentialsSummary:
      $ref: '#/components/schemas/Pick_OrganizationWarehouseCredentials.organizationWarehouseCredentialsUuid-or-name-or-description-or-warehouseType_'
    DucklakeDataPathType.AZURE:
      enum:
      - azure
      type: string
    WarehouseTypes.REDSHIFT:
      enum:
      - redshift
      type: string
    DucklakeDataPathAzure:
      $ref: '#/components/schemas/Omit_CreateDucklakeDataPathAzure.connectionString-or-accountKey_'
    SnowflakeAuthenticationType:
      enum:
      - password
      - private_key
      - sso
      - external_browser
      - none
      type: string
    Omit_CreateDucklakeCatalogPostgres.user-or-password_:
      $ref: '#/components/schemas/Pick_CreateDucklakeCatalogPostgres.Exclude_keyofCreateDucklakeCatalogPostgres.user-or-password__'
      description: Construct a type with the properties of T except for those in type K.
    BigqueryAuthenticationType:
      enum:
      - sso
      - private_key
      - adc
      type: string
    DucklakeDataPathS3:
      $ref: '#/components/schemas/Omit_CreateDucklakeDataPathS3.accessKeyId-or-secretAccessKey_'
    CreateDuckdbCredentials:
      anyOf:
      - $ref: '#/components/schemas/CreateDuckdbMotherduckCredentials'
      - $ref: '#/components/schemas/CreateDuckdbDucklakeCredentials'
    Pick_CreateClickhouseCredentials.Exclude_keyofCreateClickhouseCredentials.SensitiveCredentialsFieldNames__:
      properties:
        type:
          $ref: '#/components/schemas/WarehouseTypes.CLICKHOUSE'
        requireUserCredentials:
          type: boolean
        schema:
          type: string
        startOfWeek:
          allOf:
          - $ref: '#/components/schemas/WeekDay'
          nullable: true
        dataTimezone:
          type: string
        timeoutSeconds:
          type: number
          format: double
        host:
          type: string
        port:
          type: number
          format: double
        secure:
          type: boolean
      required:
      - type
      - schema
      - host
      - port
      type: object
      description: From T, pick a set of properties whose keys are in the union K
    WarehouseTypes.ATHENA:
      enum:
      - athena
      type: string
    DucklakeCatalogType.SQLITE:
      enum:
      - sqlite
      type: string
    RedshiftCredentials:
      $ref: '#/components/schemas/Omit_CreateRedshiftCredentials.SensitiveCredentialsFieldNames_'
    Omit_CreateDuckdbMotherduckCredentials.SensitiveCredentialsFieldNames_:
      $ref: '#/components/schemas/Pick_CreateDuckdbMotherduckCredentials.Exclude_keyofCreateDuckdbMotherduckCredentials.SensitiveCredentialsFieldNames__'
      description: Construct a type with the properties of T except for those in type K.
    SslConfiguration:
      properties:
        sslrootcert:
          type: string
          nullable: true
        sslrootcertFileName:
          type: string
        sslkey:
          type: string
          nullable: true
        sslkeyFileName:
          type: string
        sslcert:
          type: string
          nullable: true
        sslcertFileName:
          type: string
        sslmode:
          type: string
      type: object
    CreateDatabricksCredentials:
      properties:
        compute:
          items:
            properties:
              httpPath:
                type: string
              name:
                type: string
            required:
            - httpPath
            - name
            type: object
          type: array
        dataTimezone:
          type: string
        startOfWeek:
          allOf:
          - $ref: '#/components/schemas/WeekDay'
          nullable: true
        requireUserCredentials:
          type: boolean
        oauthClientSecret:
          type: string
        oauthClientId:
          type: string
        token:
          type: string
        refreshToken:
          type: string
        personalAccessToken:
          type: string
        authenticationType:
          $ref: '#/components/schemas/DatabricksAuthenticationType'
        httpPath:
          type: string
        serverHostName:
          type: string
        database:
          type: string
        catalog:
          type: string
        type:
          $ref: '#/components/schemas/WarehouseTypes.DATABRICKS'
      required:
      - httpPath
      - serverHostName
      - database
      - type
      type: object
    DucklakeDataPathType.GCS:
      enum:
      - gcs
      type: string
    AthenaCredentials:
      $ref: '#/components/schemas/Omit_CreateAthenaCredentials.SensitiveCredentialsFieldNames_'
    ClickhouseCredentials:
      $ref: '#/components/schemas/Omit_CreateClickhouseCredentials.SensitiveCredentialsFieldNames_'
    CreateOrganizationWarehouseCredentials:
      properties:
        credentials:
          $ref: '#/components/schemas/CreateWarehouseCredentials'
        description:
          type: string
          nullable: true
        name:
          type: string
      required:
      - credentials
      - name
      type: object
    Omit_CreateRedshiftCredentials.SensitiveCredentialsFieldNames_:
      $ref: '#/components/schemas/Pick_CreateRedshiftCredentials.Exclude_keyofCreateRedshiftCredentials.SensitiveCredentialsFieldNames__'
      description: Construct a type with the properties of T except for those in type K.
    DucklakeCatalogDuckdb:
      $ref: '#/components/schemas/CreateDucklakeCatalogDuckdb'
    CreateDucklakeDataPathAzure:
      properties:
        accountKey:
          type: string
        accountName:
          type: string
        connectionString:
          type: string
        url:
          type: string
        type:
          $ref: '#/components/schemas/DucklakeDataPathType.AZURE'
      required:
      - url
      - type
      type: object
    Omit_CreateSnowflakeCredentials.SensitiveCredentialsFieldNames_:
      $ref: '#/components/schemas/Pick_CreateSnowflakeCredentials.Exclude_keyofCreateSnowflakeCredentials.SensitiveCredentialsFieldNames__'
      description: Construct a type with the properties of T except for those in type K.
    Pick_OrganizationWarehouseCredentials.organizationWarehouseCredentialsUuid-or-name-or-description-or-warehouseType_:
      properties:
        description:
          type: string
          nullable: true
        name:
          type: string
        organizationWarehouseCredentialsUuid:
          type: string
        warehouseType:
          $ref: '#/components/schemas/WarehouseTypes'
      required:
      - description
      - name
      - organizationWarehouseCredentialsUuid
      - warehouseType
      type: object
      description: From T, pick a set of properties whose keys are in the union K
    WarehouseTypes.DATABRICKS:
      enum:
      - databricks
      type: string
    Pick_CreateDuckdbMotherduckCredentials.Exclude_keyofCreateDuckdbMotherduckCredentials.SensitiveCredentialsFieldNames__:
      properties:
        type:
          $ref: '#/components/schemas/WarehouseTypes.DUCKDB'
        requireUserCredentials:
          type: boolean
        database:
          type: string
        schema:
          type: string
        threads:
          type: number
          format: double
        startOfWeek:
          allOf:
          - $ref: '#/components/schemas/WeekDay'
          nullable: true
        dataTimezone:
          type: string
        connectionType:
          $ref: '#/components/schemas/DuckdbConnectionType.MOTHERDUCK'
      required:
      - type
      - database
      - schema
      - connectionType
      type: object
      description: From T, pick a set of properties whose keys are in the union K
    Omit_CreateBigqueryCredentials.SensitiveCredentialsFieldNames_:
      $ref: '#/components/schemas/Pick_CreateBigqueryCredentials.Exclude_keyofCreateBigqueryCredentials.SensitiveCredentialsFieldNames__'
      description: Construct a type with the properties of T except for those in type K.
    AthenaAuthenticationType:
      enum:
      - access_key
      - iam_role
      type: string
    Omit_CreateDuckdbDucklakeCredentials.catalog-or-dataPath_:
      $ref: '#/components/schemas/Pick_CreateDuckdbDucklakeCredentials.Exclude_keyofCreateDuckdbDucklakeCredentials.catalog-or-dataPath__'
      description: Construct a type with the properties of T except for those in type K.
    Omit_CreateClickhouseCredentials.SensitiveCredentialsFieldNames_:
      $ref: '#/components/schemas/Pick_CreateClickhouseCredentials.Exclude_keyofCreateClickhouseCredentials.SensitiveCredentialsFieldNames__'
      description: Construct a type with the properties of T except for those in type K.
    Omit_CreateAthenaCredentials.SensitiveCredentialsFieldNames_:
      $ref: '#/components/schemas/Pick_CreateAthenaCredentials.Exclude_keyofCreateAthenaCredentials.SensitiveCredentialsFieldNames__'
      description: Construct a type with the properties of T except for those in type K.
    CreateAthenaCredentials:
      properties:
        dataTimezone:
          type: string
        startOfWeek:
          allOf:
          - $ref: '#/components/schemas/WeekDay'
          nullable: true
        requireUserCredentials:
          type: boolean
        numRetries:
          type: number
          format: double
        threads:
          type: number
          format: double
        workGroup:
          type: string
        assumeRoleExternalId:
          type: string
        assumeRoleArn:
          type: string
        secretAccessKey:
          type: string
        accessKeyId:
          type: string
        authenticationType:
          $ref: '#/components/schemas/AthenaAuthenticationType'
        s3DataDir:
          type: string
        s3StagingDir:
          type: string
        schema:
          type: string
        database:
          type: string
        region:
          type: string
        type:
          $ref: '#/components/schemas/WarehouseTypes.ATHENA'
      required:
      - s3StagingDir
      - schema
      - database
      - region
      - type
      type: object
    CreateTrinoCredentials:
      properties:
        dataTimezone:
          type: string
        startOfWeek:
          allOf:
          - $ref: '#/components/schemas/WeekDay'
          nullable: true
        source:
          type: string
        http_scheme:
          type: string
        schema:
          type: string
        dbname:
          type: string
        port:
          type: number
          format: double
        requireUserCredentials:
          type: boolean
        password:
          type: string
        user:
          type: string
        host:
          type: string
        type:
          $ref: '#/components/schemas/WarehouseTypes.TRINO'
      required:
      - http_scheme
      - schema
      - dbname
      - port
      - password
      - user
      - host
      - type
      type: object
    DatabricksAuthenticationType:
      enum:
      - personal_access_token
      - oauth_m2m
      - oauth_u2m
      type: string
    CreateDucklakeCatalogSqlite:
      properties:
        path:
          type: string
        type:
          $ref: '#/components/schemas/DucklakeCatalogType.SQLITE'
      required:
      - path
      - type
      type: object
    CreateWarehouseCredentials:
      anyOf:
      - $ref: '#/components/schemas/CreateRedshiftCredentials'
      - $ref: '#/components/schemas/CreateBigqueryCredentials'
      - $ref: '#/components/schemas/CreatePostgresCredentials'
      - $ref: '#/components/schemas/CreateSnowflakeCredentials'
      - $ref: '#/components/schemas/CreateDatabricksCredentials'
      - $ref: '#/components/schemas/CreateTrinoCredentials'
      - $ref: '#/components/schemas/CreateClickhouseCredentials'
      - $ref: '#/components/schemas/CreateAthenaCredentials'
      - $ref: '#/components/schemas/CreateDuckdbCredentials'
    CreateDucklakeCatalogPostgres:
      properties:
        password:
          type: string
        user:
          type: string
        database:
          type: string
        port:
          type: number
          format: double
        host:
          type: string
        type:
          $ref: '#/components/schemas/DucklakeCatalogType.POSTGRES'
      required:
      - password
      - user
      - database
      - port
      - host
      - type
      type: object
    Pick_CreateDucklakeDataPathAzure.Exclude_keyofCreateDucklakeDataPathAzure.connectionString-or-accountKey__:
      properties:
        type:
          $ref: '#/components/schemas/DucklakeDataPathType.AZURE'
        url:
          type: string
        accountName:
          type: string
      required:
      - type
      - url
      type: object
      description: From T, pick a set of properties whose keys are in the union K
    Pick_CreateDuckdbDucklakeCredentials.Exclude_keyofCreateDuckdbDucklakeCredentials.catalog-or-dataPath__:
      properties:
        type:
          $ref: '#/components/schemas/WarehouseTypes.DUCKDB'
        requireUserCredentials:
          type: boolean
        schema:
          type: string
        threads:
          type: number
          format: double
        startOfWeek:
          allOf:
          - $ref: '#/components/schemas/WeekDay'
          nullable: true
        dataTimezone:
          type: string
        connectionType:
          $ref: '#/components/schemas/DuckdbConnectionType.DUCKLAKE'
        catalogAlias:
          type: string
      required:
      - type
      - schema
      - connectionType
      type: object
      description: From T, pick a set of properties whose keys are in the union K
    DucklakeDataPathLocal:
      $ref: '#/components/schemas/CreateDucklakeDataPathLocal'
    CreateSnowflakeCredentials:
      properties:
        organizationWarehouseCredentialsUuid:
          type: string
        override:
          type: boolean
        timeoutSeconds:
          type: number
          format: double
        disableTimestampConversion:
          type: boolean
        quotedIdentifiersIgnoreCase:
          type: boolean
        dataTimezone:
          type: string
        startOfWeek:
          allOf:
          - $ref: '#/components/schemas/WeekDay'
          nullable: true
        accessUrl:
          type: string
        queryTag:
          type: string
        clientSessionKeepAlive:
          type: boolean
        threads:
          type: number
          format: double
        schema:
          type: string
        warehouse:
          type: string
        database:
          type: string
        role:
          type: string
        token:
          type: string
        refreshToken:
          type: string
        authenticationType:
          $ref: '#/components/schemas/SnowflakeAuthenticationType'
        privateKeyPass:
          type: string
        privateKey:
          type: string
        requireUserCredentials:
          type: boolean
        password:
          type: string
        user:
          type: string
        account:
          type: string
        type:
          $ref: '#/components/schemas/WarehouseTypes.SNOWFLAKE'
      required:
      - schema
      - warehouse
      - database
      - user
      - account
      - type
      type: object
    ApiOrganizationWarehouseCredentialsSummaryListResponse:
      properties:
        results:
          items:
            $ref: '#/components/schemas/OrganizationWarehouseCredentialsSummary'
          type: array
        status:
          type: string
          enum:
          - ok
          nullable: false
      required:
      - results
      - status
      type: object
    WarehouseTypes.TRINO:
      enum:
      - trino
      type: string
    Pick_CreateSnowflakeCredentials.Exclude_keyofCreateSnowflakeCredentials.SensitiveCredentialsFieldNames__:
      properties:
        type:
          $ref: '#/components/schemas/WarehouseTypes.SNOWFLAKE'
        account:
          type: string
        requireUserCredentials:
          type: boolean
        authenticationType:
          $ref: '#/components/schemas/SnowflakeAuthenticationType'
        role:
          type: string
        database:
          type: string
        warehouse:
          type: string
        schema:
          type: string
        threads:
          type: number
          format: double
        clientSessionKeepAlive:
          type: boolean
        queryTag:
          type: string
        accessUrl:
          type: string
        startOfWeek:
          allOf:
          - $ref: '#/components/schemas/WeekDay'
          nullable: true
        dataTimezone:
          type: string
        quotedIdentifiersIgnoreCase:
          type: boolean
        disableTimestampConversion:
          type: boolean
        timeoutSeconds:
          type: number
          format: double
        override:
          type: boolean
        organizationWarehouseCredentialsUuid:
          type: string
      required:
      - type
      - account
      - database
      - warehouse
      - schema
      type: object
      description: From T, pick a set of properties whose keys are in the union K
    CreateDucklakeCatalogDuckdb:
      properties:
        path:
          type: string
        type:
          $ref: '#/components/schemas/DucklakeCatalogType.DUCKDB'
      required:
      - path
      - type
      type: object
    AnyType:
      description: 'This AnyType is an alias for any

        The goal is to make it easier to identify any type in the codebase

        without having to eslint-disable all the time

        These are only used on legacy `any` types, don''t use it for new types.

        This is added on a separate file to avoid circular dependencies.'
    Pick_CreateBigqueryCredentials.Exclude_keyofCreateBigqueryCredentials.SensitiveCredentialsFieldNames__:
      properties:
        type:
          $ref: '#/components/schemas/WarehouseTypes.BIGQUERY'
        requireUserCredentials:
          type: boolean
        authenticationType:
          $ref: '#/components/schemas/BigqueryAuthenticationType'
        threads:
          type: number
          format: double
        accessUrl:
          type: string
        startOfWeek:
          allOf:
          - $ref: '#/components/schemas/WeekDay'
          nullable: true
        dataTimezone:
          type: string
        timeoutSeconds:
          type: number
          format: double
        project:
          type: string
        dataset:
          type: string
        priority:
          type: string
          enum:
          - interactive
          - batch
        retries:
          type: number
          format: double
        location:
          type: string
        maximumBytesBilled:
          type: number
          format: double
        executionProject:
          type: string
      required:
      - type
      - project
      - dataset
      type: object
      description: From T, pick a set of properties whose keys are in the union K
    CreateDucklakeDataPathS3:
      properties:
        useSsl:
          type: boolean
        forcePathStyle:
          type: boolean
        secretAccessKey:
          type: string
        accessKeyId:
          type: string
        region:
          type: string
        endpoint:
          type: string
        url:
          type: string
        type:
          $ref: '#/components/schemas/DucklakeDataPathType.S3'
      required:
      - url
      - type
      type: object
    ApiSuccessEmpty:
      properties:
        results: {}
        status:
          type: string
          enum:
          - ok
          nullable: false
      required:
      - status
      type: object
    Omit_CreateTrinoCredentials.SensitiveCredentialsFieldNames_:
      $ref: '#/components/schemas/Pick_CreateTrinoCredentials.Exclude_keyofCreateTrinoCredentials.SensitiveCredentialsFieldNames__'
      description: Construct a type with the properties of T except for those in type K.
    DucklakeDataPathType.S3:
      enum:
      - s3
      type: string
    CreateDucklakeCatalog:
      anyOf:
      - $ref: '#/components/schemas/CreateDucklakeCatalogPostgres'
      - $ref: '#/components/schemas/CreateDucklakeCatalogSqlite'
      - $ref: '#/components/schemas/CreateDucklakeCatalogDuckdb'
    DuckdbMotherduckCredentials:
      $ref: '#/components/schemas/Omit_CreateDuckdbMotherduckCredentials.SensitiveCredentialsFieldNames_'
    Pick_CreateDucklakeDataPathGcs.Exclude_keyofCreateDucklakeDataPathGcs.hmacKeyId-or-hmacSecret__:
      properties:
        type:
          $ref: '#/components/schemas/DucklakeDataPathType.GCS'
        url:
          type: string
      required:
      - type
      - url
      type: object
      description: From T, pick a set of properties whose keys are in the union K
    UpdateOrganizationWarehouseCredentials:
      properties:
        credentials:
          $ref: '#/components/schemas/CreateWarehouseCredentials'
        description:
          type: string
          nullable: true
        name:
          type: string
      type: object
    Omit_CreateDucklakeDataPathS3.accessKeyId-or-secretAccessKey_:
      $ref: '#/components/schemas/Pick_CreateDucklakeDataPathS3.Exclude_keyofCreateDucklakeDataPathS3.accessKeyId-or-secretAccessKey__'
      description: Construct a type with the properties of T except for those in type K.
    DucklakeCatalog:
      anyOf:
      - $ref: '#/components/schemas/DucklakeCatalogPostgres'
      - $ref: '#/components/schemas/DucklakeCatalogSqlite'
      - $ref: '#/components/schemas/DucklakeCatalogDuckdb'
    CreatePostgresCredentials:
      allOf:
      - $ref: '#/components/schemas/SshTunnelConfiguration'
      - $ref: '#/components/schemas/SslConfiguration'
      - properties:
          timeoutSeconds:
            type: number
            format: double
          dataTimezone:
            type: string
          startOfWeek:
            allOf:
            - $ref: '#/components/schemas/WeekDay'
            nullable: true
          role:
            type: string
          searchPath:
            type: string
          keepalivesIdle:
            type: number
            format: double
          threads:
            type: number
            format: double
          schema:
            type: string
          dbname:
            type: string
          port:
            type: number
            format: double
          requireUserCredentials:
            type: boolean
          password:
            type: string
          user:
            type: string
          host:
            type: string
          type:
            $ref: '#/components/schemas/WarehouseTypes.POSTGRES'
        required:
        - schema
        - dbname
        - port
        - password
        - user
        - host
        - type
        type: object
    Pick_CreateTrinoCredentials.Exclude_keyofCreateTrinoCredentials.SensitiveCredentialsFieldNames__:
      properties:
        type:
          $ref: '#/components/schemas/WarehouseTypes.TRINO'
        requireUserCredentials:
          type: boolean
        schema:
          type: string
        startOfWeek:
          allOf:
          - $ref: '#/components/schemas/WeekDay'
          nullable: true
        dataTimezone:
          type: string
        host:
          type: string
        port:
          type: number
          format: double
        dbname:
          type: string
        http_scheme:
          type: string
        source:
          type: string
      required:
      - type
      - schema
      - host
      - port
      - dbname
      - http_scheme
      type: object
      description: From T, pick a set of properties whose keys are in the union K
    Pick_CreateRedshiftCredentials.Exclude_keyofCreateRedshiftCredentials.SensitiveCredentialsFieldNames__:
      properties:
        type:
          $ref: '#/components/schemas/WarehouseTypes.REDSHIFT'
        requireUserCredentials:
          type: boolean
        schema:
          type: string
        threads:
          type: number
          format: double
        startOfWeek:
          allOf:
          - $ref: '#/components/schemas/WeekDay'
          nullable: true
        dataTimezone:
          type: string
        timeoutSeconds:
          type: number
          format: double
        useSshTunnel:
          type: boolean
        sshTunnelHost:
          type: string
        sshTunnelPort:
          type: number
          format: double
        sshTunnelUser:
          type: string
        sshTunnelPublicKey:
          type: string
        host:
          type: string
        port:
          type: number
          format: double
        dbname:
          type: string
        keepalivesIdle:
          type: number
          format: double
        sslmode:
          type: string
        ra3Node:
          type: boolean
      required:
      - type
      - schema
      - host
      - port
      - dbname
      type: object
      description: From T, pick a set of properties whose keys are in the union K
    WarehouseTypes:
      enum:
      - bigquery
      - postgres
      - redshift
      - snowflake
      - databricks
      - trino
      - clickhouse
      - athena
      - duckdb
      type: string
    DucklakeDataPathType.LOCAL:
      enum:
      - local
      type: string
    DucklakeCatalogType.DUCKDB:
      enum:
      - duckdb
      type: string
    WarehouseTypes.SNOWFLAKE:
      enum:
      - snowflake
      type: string
    ApiOrganizationWarehouseCredentialsResponse:
      properties:
        results:
          $ref: '#/components/schemas/OrganizationWarehouseCredentials'
        status:
          type: string
          enum:
          - ok
          nullable: false
      required:
      - results
      - status
      type: object
    CreateDuckdbDucklakeCredentials:
      properties:
        dataTimezone:
          type: string
        startOfWeek:
          allOf:
          - $ref: '#/components/schemas/WeekDay'
          nullable: true
        requireUserCredentials:
          type: boolean
        threads:
          type: number
          format: double
        catalogAlias:
          type: string
        schema:
          type: string
        dataPath:
          $ref: '#/components/schemas/CreateDucklakeDataPath'
        catalog:
          $ref: '#/components/schemas/CreateDucklakeCatalog'
        connectionType:
          $ref: '#/components/schemas/DuckdbConnectionType.DUCKLAKE'
        type:
          $ref: '#/components/schemas/WarehouseTypes.DUCKDB'
      required:
      - schema
      - dataPath
      - catalog
      - connectionType
      - type
      type: object
    DucklakeCatalogPostgres:
      $ref: '#/components/schemas/Omit_CreateDucklakeCatalogPostgres.user-or-password_'
    CreateBigqueryCredentials:
      properties:
        accessUrl:
          type: string
        executionProject:
          type: string
        dataTimezone:
          type: string
        startOfWeek:
          allOf:
          - $ref: '#/components/schemas/WeekDay'
          nullable: true
        maximumBytesBilled:
          type: number
          format: double
        location:
          type: string
        retries:
          type: number
          format: double
        requireUserCredentials:
          type: boolean
        keyfileContents:
          $ref: '#/components/schemas/Record_string.string_'
        authenticationType:
          $ref: '#/components/schemas/BigqueryAuthenticationType'
        priority:
          type: string
          enum:
          - interactive
          - batch
        timeoutSeconds:
          type: number
          format: double
        threads:
          type: number
          format: double
        dataset:
          type: string
        project:
          type: string
        type:
          $ref: '#/components/schemas/WarehouseTypes.BIGQUERY'
      required:
      - keyfileContents
      - dataset
      - project
      - type
      type: object
    Omit_CreateDucklakeDataPathGcs.hmacKeyId-or-hmacSecret_:
      $ref: '#/components/schemas/Pick_CreateDucklakeDataPathGcs.Exclude_keyofCreateDucklakeDataPathGcs.hmacKeyId-or-hmacSecret__'
      description: Construct a type with the properties of T except for those in type K.
    DuckdbConnectionType.DUCKLAKE:
      enum:
      - ducklake
      type: string
    DuckdbCredentials:
      anyOf:
      - $ref: '#/components/schemas/DuckdbMotherduckCredentials'
      - $ref: '#/components/schemas/DuckdbDucklakeCredentials'
    CreateRedshiftCredentials:
      allOf:
      - $ref: '#/components/schemas/SshTunnelConfiguration'
      - properties:
          timeoutSeconds:
            type: number
            format: double
          dataTimezone:
            type: string
          startOfWeek:
            allOf:
            - $ref: '#/components/schemas/WeekDay'
            nullable: true
          ra3Node:
            type: boolean
          sslmode:
            type: string
          keepalivesIdle:
            type: number
            format: double
          threads:
            type: number
            format: double
          schema:
            type: string
          dbname:
            type: string
          port:
            type: number
            format: double
          requireUserCredentials:
            type: boolean
          password:
            type: string
          user:
            type: string
          host:
            type: string
          type:
            $ref: '#/components/schemas/WarehouseTypes.REDSHIFT'
        required:
        - schema
        - dbname
        - port
        - password
        - user
        - host
        - type
        type: object
    Omit_CreatePostgresCredentials.SensitiveCredentialsFieldNames_:
      $ref: '#/components/schemas/Pick_CreatePostgresCredentials.Exclude_keyofCreatePostgresCredentials.SensitiveCredentialsFieldNames__'
      description: Construct a type with the properties of T except for those in type K.
    WarehouseTypes.POSTGRES:
      enum:
      - postgres
      type: string
    CreateClickhouseCredentials:
      properties:
        timeoutSeconds:
          type: number
          format: double
        dataTimezone:
          type: string
        startOfWeek:
          allOf:
          - $ref: '#/components/schemas/WeekDay'
          nullable: true
        secure:
          type: boolean
        schema:
          type: string
        port:
          type: number
          format: double
        requireUserCredentials:
          type: boolean
        password:
          type: string
        user:
          type: string
        host:
          type: string
        type:
          $ref: '#/components/schemas/WarehouseTypes.CLICKHOUSE'
      required:
      - schema
      - port
      - password
      - user
      - host
      - type
      type: object
    Pick_CreateDatabricksCredentials.Exclude_keyofCreateDatabricksCredentials.SensitiveCredentialsFieldNames__:
      properties:
        type:
          $ref: '#/components/schemas/WarehouseTypes.DATABRICKS'
        catalog:
          type: string
        requireUserCredentials:
          type: boolean
        authenticationType:
          $ref: '#/components/schemas/DatabricksAuthenticationType'
        database:
          type: string
        startOfWeek:
          allOf:
          - $ref: '#/components/schemas/WeekDay'
          nullable: true
        dataTimezone:
          type: string
        serverHostName:
          type: string
        httpPath:
          type: string
        compute:
          items:
            properties:
              httpPath:
                type: string
              name:
                type: string
            required:
            - httpPath
            - name
            type: object
          type: array
      required:
      - type
      - database
      - serverHostName
      - httpPath
      type: object
      description: From T, pick a set of properties whose keys are in the union K
    WarehouseTypes.CLICKHOUSE:
      enum:
      - clickhouse
      type: string
    Pick_CreatePostgresCredentials.Exclude_keyofCreatePostgresCredentials.SensitiveCredentialsFieldNames__:
      properties:
        type:
          $ref: '#/components/schemas/WarehouseTypes.POSTGRES'
        requireUserCredentials:
          type: boolean
        role:
          type: string
        schema:
          type: string
        threads:
          type: number
          format: double
        startOfWeek:
          allOf:
          - $ref: '#/components/schemas/WeekDay'
          nullable: true
        dataTimezone:
          type: string
        timeoutSeconds:
          type: number
          format: double
        useSshTunnel:
          type: boolean
        sshTunnelHost:
          type: string
        sshTunnelPort:
          type: number
          format: double
        sshTunnelUser:
          type: string
        sshTunnelPublicKey:
          type: string
        host:
          type: string
        port:
          type: number
          format: double
        dbname:
          type: string
        keepalivesIdle:
          type: number
          format: double
        sslmode:
          type: string
        sslcertFileName:
          type: string
        sslkeyFileName:
          type: string
        sslrootcertFileName:
          type: string
        searchPath:
          type: string
      required:
      - type
      - schema
      - host
      - port
      - dbname
      type: object
      description: From T, pick a set of properties whose keys are in the union K
    WarehouseCredentials:
      anyOf:
      - $ref: '#/components/schemas/SnowflakeCredentials'
      - $ref: '#/components/schemas/RedshiftCredentials'
      - $ref: '#/components/schemas/PostgresCredentials'
      - $ref: '#/components/schemas/BigqueryCredentials'
      - $ref: '#/components/schemas/DatabricksCredentials'
      - $ref: '#/components/schemas/TrinoCredentials'
      - $ref: '#/components/schemas/ClickhouseCredentials'
      - $ref: '#/components/schemas/AthenaCredentials'
      - $ref: '#/components/schemas/DuckdbCredentials'
    CreateDuckdbMotherduckCredentials:
      properties:
        dataTimezone:
          type: string
        startOfWeek:
          allOf:
          - $ref: '#/components/schemas/WeekDay'
          nullable: true
        requireUserCredentials:
          type: boolean
        threads:
          type: number
          format: double
        token:
          type: string
        schema:
          type: string
        database:
          type: string
        connectionType:
          $ref: '#/components/schemas/DuckdbConnectionType.MOTHERDUCK'
        type:
          $ref: '#/components/schemas/WarehouseTypes.DUCKDB'
      required:
      - token
      - schema
      - database
      - connectionType
      - type
      type: object
    DuckdbConnectionType.MOTHERDUCK:
      enum:
      - motherduck
      type: string
    PostgresCredentials:
      $ref: '#/components/schemas/Omit_CreatePostgresCredentials.SensitiveCredentialsFieldNames_'
    Pick_CreateDucklakeCatalogPostgres.Exclude_keyofCreateDucklakeCatalogPostgres.user-or-password__:
      properties:
        type:
          $ref: '#/components/schemas/DucklakeCatalogType.POSTGRES'
        database:
          type: string
        host:
          type: string
        port:
          type: number
          format: double
      required:
      - type
      - database
      - host
      - port
      type: object
      description: From T, pick a set of properties whose keys are in the union K
    SnowflakeCredentials:
      $ref: '#/components/schemas/Omit_CreateSnowflakeCredentials.SensitiveCredentialsFieldNames_'
    WarehouseTypes.DUCKDB:
      enum:
      - duckdb
      type: string
    ApiOrganizationWarehouseCredentialsListResponse:
      properties:
        results:
          items:
            $ref: '#/components/schemas/OrganizationWarehouseCredentials'
          type: array
        status:
          type: string
          enum:
          - ok
          nullable: false
      required:
      - results
      - status
      type: object
    Record_string.string_:
      properties: {}
      additionalProperties:
        type: string
      type: object
      description: Construct a type with a set of properties K of type T
    BigqueryCredentials:
      $ref: '#/components/schemas/Omit_CreateBigqueryCredentials.SensitiveCredentialsFieldNames_'
    DatabricksCredentials:
      $ref: '#/components/schemas/Omit_CreateDatabricksCredentials.SensitiveCredentialsFieldNames_'
    CreateDucklakeDataPathGcs:
      properties:
        hmacSecret:
          type: string
        hmacKeyId:
          type: string
        url:
          type: string
        type:
          $ref: '#/components/schemas/DucklakeDataPathType.GCS'
      required:
      - url
      - type
      type: object
    OrganizationWarehouseCredentials:
      properties:
        credentials:
          $ref: '#/components/schemas/WarehouseCredentials'
        createdByUserUuid:
          type: string
          nullable: true
        createdAt:
          type: string
          format: date-time
        warehouseType:
          $ref: '#/components/schemas/WarehouseTypes'
        description:
          type: string
          nullable: true
        name:
          type: string
        organizationUuid:
          type: string
        organizationWarehouseCredentialsUuid:
          type: string
      required:
      - credentials
      - createdByUserUuid
      - createdAt
      - warehouseType
      - description
      - name
      - organizationUuid
      - organizationWarehouseCredentialsUuid
      type: object
      description: Organization-level warehouse credentials
    DucklakeDataPath:
      anyOf:
      - $ref: '#/components/schemas/DucklakeDataPathS3'
      - $ref: '#/components/schemas/DucklakeDataPathGcs'
      - $ref: '#/components/schemas/DucklakeDataPathAzure'
      - $ref: '#/components/schemas/DucklakeDataPathLocal'
    WeekDay:
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      type: number
    Pick_CreateAthenaCredentials.Exclude_keyofCreateAthenaCredentials.SensitiveCredentialsFieldNames__:
      properties:
        type:
          $ref: '#/components/schemas/WarehouseTypes.ATHENA'
        requireUserCredentials:
          type: boolean
        authenticationType:
          $ref: '#/components/schemas/AthenaAuthenticationType'
        database:
          type: string
        schema:
          type: string
        threads:
          type: number
          format: double
        startOfWeek:
          allOf:
          - $ref: '#/components/schemas/WeekDay'
          nullable: true
        dataTimezone:
          type: string
        region:
          type: string
        s3StagingDir:
          type: string
        s3DataDir:
          type: string
        assumeRoleArn:
          type: string
        assumeRoleExternalId:
          type: string
        workGroup:
          type: string
        numRetries:
          type: number
          format: double
      required:
      - type
      - database
      - schema
      - region
      - s3StagingDir
      type: object
      description: From T, pick a set of properties whose keys are in the union K
    SshTunnelConfiguration:
      properties:
        sshTunnelPrivateKey:
          type: string
        sshTunnelPublicKey:
          type: string
        sshTunnelUser:
          type: string
        sshTunnelPort:
          type: number
          format: double
        sshTunnelHost:
          type: string
        useSshTunnel:
          type: boolean
      type: object
    CreateDucklakeDataPathLocal:
      properties:
        path:
          type: string
        type:
          $ref: '#/components/schemas/DucklakeDataPathType.LOCAL'
      required:
      - path
      - type
      type: object
  securitySchemes:
    session_cookie:
      type: apiKey
      in: cookie
      name: connect.sid
    api_key:
      type: apiKey
      in: header
      name: Authorization
      description: Value should be 'ApiKey <your key>'