TileDB Storage Platform API (v1)

swagger: "2.0"
info:
  description: TileDB Storage Platform REST API
  title: TileDB Storage Platform API
  version: 2.17.51

produces:
  - application/json
consumes:
  - application/json

schemes:
  - http
  - https

basePath: /v1

securityDefinitions:
  BasicAuth:
    type: basic
  ApiKeyAuth:
    type: apiKey
    in: header
    name: X-TILEDB-REST-API-KEY
  OAuth2:
    type: oauth2
    flow: accessCode
    authorizationUrl: https://oauth2.tiledb.com/oauth2/authorize
    tokenUrl: https://oauth2.tiledb.com/oauth2/token
    scopes:
      read: Grants read access
      write: Grants write access
      admin: Grants read and write access to administrative information

security:
  - BasicAuth: []
  - ApiKeyAuth: []
  # Commented out beacause this breaks the python autogenerated client
  # It always sets the Bearer authorization header even when empty :/
  # - OAuth2: [read, write, admin]

definitions:
  ArrayType:
    description: TileDB array type
    type: string
    enum:
      # Dense array
      - dense
      # Sparse array
      - sparse

  Datatype:
    description: TileDB data type
    type: string
    enum:
      # 32-bit signed integer
      - INT32
      # 64-bit signed integer
      - INT64
      # 32-bit floating point value
      - FLOAT32
      # 64-bit floating point value
      - FLOAT64
      # Character
      - CHAR
      # 8-bit signed integer
      - INT8
      # 8-bit unsigned integer
      - UINT8
      # 16-bit signed integer
      - INT16
      # 16-bit unsigned integer
      - UINT16
      # 32-bit unsigned integer
      - UINT32
      # 64-bit unsigned integer
      - UINT64
      # ASCII string
      - STRING_ASCII
      # UTF-8 string
      - STRING_UTF8
      # UTF-16 string
      - STRING_UTF16
      # UTF-32 string
      - STRING_UTF32
      # UCS2 string
      - STRING_UCS2
      # UCS4 string
      - STRING_UCS4
      # This can be any datatype. Must store (type tag, value) pairs.
      - ANY
      # Datetime with year resolution
      - DATETIME_YEAR
      # Datetime with month resolution
      - DATETIME_MONTH
      # Datetime with week resolution
      - DATETIME_WEEK
      # Datetime with day resolution
      - DATETIME_DAY
      # Datetime with hour resolution
      - DATETIME_HR
      # Datetime with minute resolution
      - DATETIME_MIN
      # Datetime with second resolution
      - DATETIME_SEC
      # Datetime with millisecond resolution
      - DATETIME_MS
      # Datetime with microsecond resolution
      - DATETIME_US
      # Datetime with nanosecond resolution
      - DATETIME_NS
      # Datetime with picosecond resolution
      - DATETIME_PS
      # Datetime with femtosecond resolution
      - DATETIME_FS
      # Datetime with attosecond resolution
      - DATETIME_AS
      # Time with hour resolution
      - TIME_HR
      # Time with minute resolution
      - TIME_MIN
      # Time with second resolution
      - TIME_SEC
      # Time with millisecond resolution
      - TIME_MS
      # Time with microsecond resolution
      - TIME_US
      # Time with nanosecond resolution
      - TIME_NS
      # Time with picosecond resolution
      - TIME_PS
      # Time with femtosecond resolution
      - TIME_FS
      # Time with attosecond resolution
      - TIME_AS
      # 8-bit unsigned integer
      - BLOB
      # Boolean
      - BOOL

  ActivityEventType:
    description: Type of activity logged
    type: string
    enum:
      # read_schema operation
      - read_schema
      # max_buffer_sizes operation
      - max_buffer_sizes
      # non_empty_domain operation
      - non_empty_domain
      # query read operation
      - query_read
      # query write operation
      - query_write
      # query delete operation
      - query_delete
      # create operation
      - create
      # delete operation
      - delete
      # register operation
      - register
      # deregister operation
      - deregister
      # udf operations
      - udf
      # get array metadata operation
      - array_metadata_get
      # update array metadata operation
      - array_metadata_update
      # estimated_result_sizes
      - estimated_result_sizes
      # read_fragment_info
      - read_fragment_info
      # read_enumerations
      - read_enumerations

  UDFLanguage:
    description: UDF Type
    type: string
    enum:
      # python
      - python
      # r
      - r

  UDFType:
    description: UDF Type
    type: string
    enum:
      # multi_array
      - multi_array
      # single_array
      - single_array
      # generic
      - generic

  ResultFormat:
    description: "Data format of a result"
    type: string
    enum:
      - python_pickle
      - r_serialization
      - json
      - arrow
      - bytes
        # Raw binary data, not interpreted by the loader.
      - tiledb_json
        # The format used to encode argument values for a task graph: JSON
        # as deeply as possible, but any value that cannot be JSON-encoded
        # is replaced with a TGArgValue.
      - native # DEPRECATED. Use the language-specific values instead.

  Layout:
    description: Layout of array
    type: string
    enum:
      # Row-major layout
      - row-major
      # Column-major layout
      - col-major
      # Global-order layout
      - global-order
      # Unordered layout
      - unordered

  Querytype:
    description: Type of query
    type: string
    enum:
      # READ
      - READ
      # Write
      - WRITE
      # Delete
      - DELETE

  Querystatus:
    description: Status of query
    type: string
    enum:
      # FAILED
      - FAILED
      # COMPLETED
      - COMPLETED
      # INPROGRESS
      - INPROGRESS
      # INCOMPLETE
      - INCOMPLETE
      # UNINITIALIZED
      - UNINITIALIZED

  FilterType:
    description: TileDB filter types
    type: string
    enum:
      # No-op filter
      - FILTER_NONE
      # Gzip compressor
      - FILTER_GZIP
      # Zstandard compressor
      - FILTER_ZSTD
      # LZ4 compressor
      - FILTER_LZ4
      # Run-length encoding compressor
      - FILTER_RLE
      # Bzip2 compressor
      - FILTER_BZIP2
      # Double-delta compressor
      - FILTER_DOUBLE_DELTA
      # Bit width reduction filter.
      - FILTER_BIT_WIDTH_REDUCTION
      # Bitshuffle filter.
      - FILTER_BITSHUFFLE
      # Byteshuffle filter.
      - FILTER_BYTESHUFFLE
      # Positive-delta encoding filter.
      - FILTER_POSITIVE_DELTA

  FilterOption:
    description: TileDB filter option
    type: string
    enum:
      # Compression level. Type: `int32_t`
      - COMPRESSION_LEVEL
      # Max window length for bit width reduction. Type: `uint32_t`
      - BIT_WIDTH_MAX_WINDOW
      # Max window length for positive-delta encoding. Type: `uint32_t`.
      - POSITIVE_DELTA_MAX_WINDOW

  OrganizationRoles:
    description: role user has in organization
    type: string
    enum:
      # Owner/creator of group
      - owner
      # Admin almost all rights but can't delete organization
      - admin
      # Read, write, and delete User
      - read_write_delete
      # Read and write User
      - read_write
      # Read Only User
      - read_only

  ArrayActions:
    description: actions a user can take on an array
    type: string
    enum:
      # Read
      - read
      # Write
      - write
      # Edit metadata about array
      - edit
      # View logs for array
      - read_array_logs
      # Permission to get array info
      - read_array_info
      # Permission to fetch the array schema
      - read_array_schema

  UDFActions:
    description: actions a user can take on a UDF
    type: string
    enum:
      # Fetch UDF and run jobs
      - fetch_udf
      # Share UDF with others
      - share_udf

  NamespaceActions:
    description: actions a user can take on an organization
    type: string
    enum:
      # Fetch details about namespace and read arrays in namespace
      - read
      # Write to arrays inside namespace
      - write
      # Create arrays inside namespace
      - create
      # Delete/Deregister arrays in namespace
      - delete
      # Edit array metadata
      - edit
      # View logs for array
      - read_array_logs
      # View logs for job
      - read_job_logs
      # View change logs for namespace
      - read_object_logs
      # Run job
      - run_job
      # Delete an organization
      - delete_organization
      # Edit organization details
      - edit_organization
      # Edit billing details
      - edit_billing

  DomainArray:
    description: Domain object for an array of each type
    type: object
    properties:
      int8:
        type: array
        x-omitempty: true
        items:
          type: integer
          format: int8
      uint8:
        type: array
        x-omitempty: true
        items:
          type: integer
          format: uint8
      int16:
        type: array
        x-omitempty: true
        items:
          type: integer
          format: int16
      uint16:
        type: array
        x-omitempty: true
        items:
          type: integer
          format: uint16
      int32:
        type: array
        x-omitempty: true
        items:
          type: integer
          format: int32
      uint32:
        type: array
        x-omitempty: true
        items:
          type: integer
          format: uint32
      int64:
        type: array
        x-omitempty: true
        items:
          type: integer
          format: int64
      uint64:
        type: array
        x-omitempty: true
        items:
          type: integer
          format: uint64
      float32:
        type: array
        x-omitempty: true
        items:
          type: number
          format: float
      float64:
        type: array
        x-omitempty: true
        items:
          type: number
          format: double

  Array:
    description: Represents an open array
    type: object
    required:
      - timestamp
      - queryType
      - uri
    properties:
      timestamp:
        description: timestamp (epoch milliseconds) array is opened at
        type: number
        format: uint64
        example: 1540471791873
      queryType:
        description: Array opened for query type
        $ref: "#/definitions/Querytype"
      uri:
        description: Array uri
        type: string

  Attribute:
    description: Attribute of array
    type: object
    required:
      - name
      - type
      - filterPipeline
      - cellValNum
    properties:
      name:
        description: Attribute name
        type: string
        example: attribute1
      type:
        $ref: "#/definitions/Datatype"
      filterPipeline:
        $ref: "#/definitions/FilterPipeline"
      cellValNum:
        description: Attribute number of values per cell
        type: integer
        example: 1
      nullable:
        description: Is attribute nullable
        type: boolean
        example: true
      fillValue:
        description: The default fill value
        type: array
        items:
          type: integer
          format: uint8

  Dimension:
    description: Dimension of array
    type: object
    required:
      - type
      - domain
      - nullTileExtent
    properties:
      name:
        description: Dimension name
        type: string
        example: "row"
      type:
        $ref: "#/definitions/Datatype"
      domain:
        description: extent of domain
        $ref: "#/definitions/DomainArray"
      nullTileExtent:
        description: Is tile extent null
        type: boolean
        example: true
      tileExtent:
        description: Extent of tile
        type: object
        properties:
          int8:
            type: integer
            format: int8
          uint8:
            type: integer
            format: uint8
          int16:
            type: integer
            format: int16
          uint16:
            type: integer
            format: uint16
          int32:
            type: integer
            format: int32
          uint32:
            type: integer
            format: uint32
          int64:
            type: integer
            format: int64
          uint64:
            type: integer
            format: uint64
          float32:
            type: integer
            format: float
          float64:
            type: integer
            format: double
      filterPipeline:
        x-omit-empty: true
        $ref: "#/definitions/FilterPipeline"

  Domain:
    description: Domain of array
    type: object
    required:
      - type
      - tileOrder
      - cellOrder
      - dimensions
    properties:
      type:
        $ref: "#/definitions/Datatype"
        description: Domain Type
      tileOrder:
        $ref: "#/definitions/Layout"
        description: Tile Order
      cellOrder:
        $ref: "#/definitions/Layout"
        description: Cell Order
      dimensions:
        type: array
        description: Array of dimensions
        items:
          $ref: "#/definitions/Dimension"

  Filter:
    description: Filter
    type: object
    required:
      - type
    properties:
      type:
        description: Filter type
        $ref: "#/definitions/FilterType"
      data:
        description: Filter data
        type: object
        properties:
          int8:
            type: integer
            format: int8
          uint8:
            type: integer
            format: uint8
          int16:
            type: integer
            format: int16
          uint16:
            type: integer
            format: uint16
          int32:
            type: integer
            format: int32
          uint32:
            type: integer
            format: uint32
          int64:
            type: integer
            format: int64
          uint64:
            type: integer
            format: uint64
          float32:
            type: integer
            format: float
          float64:
            type: integer
            format: double

  FilterPipeline:
    description: One or more filters to apply
    type: object
    properties:
      filters:
        type: array
        x-omitempty: true
        items:
          $ref: "#/definitions/Filter"

  ArraySchema:
    description: ArraySchema during creation or retrieval
    type: object
    required:
      - version
      - arrayType
      - tileOrder
      - cellOrder
      - capacity
      - coordsFilterPipeline
      - offsetFilterPipeline
      - domain
      - attributes
    properties:
      uri:
        description: URI of schema
        type: string
        example: "s3://<bucket>/test_array"
      version:
        description: file format version
        type: array
        x-omitempty: true
        items:
          type: integer
        example: [1, 3, 0]
      arrayType:
        $ref: "#/definitions/ArrayType"
        description: Type of array
        example: sparse
      tileOrder:
        description: Tile order setting of array
        $ref: "#/definitions/Layout"
        example: row-major
      cellOrder:
        description: Order of cells
        $ref: "#/definitions/Layout"
        example: row-major
      capacity:
        description: Capacity of array
        type: integer
        format: uint64
        example: 100000
      coordsFilterPipeline:
        description: Filter pipeline used for coordinates (enum)
        $ref: "#/definitions/FilterPipeline"
      offsetFilterPipeline:
        description: Filter pipeline use for variable offsets (enum)
        $ref: "#/definitions/FilterPipeline"
      domain:
        description: Domain of array
        $ref: "#/definitions/Domain"
      attributes:
        description: Attributes of array
        type: array
        x-omitempty: true
        items:
          $ref: "#/definitions/Attribute"
      allowsDuplicates:
        description: True if the array allows coordinate duplicates. Applicable only to sparse arrays.
        type: boolean
    x-go-type:
      import:
        package: "github.com/TileDB-Inc/TileDB-Go"
        alias: "tiledb"
      type: "ArraySchema"
      embedded: true

  AttributeBufferHeader:
    description: Represents an attribute buffer header information
    type: object
    required:
      - name
      - fixedLenBufferSizeInBytes
      - varLenBufferSizeInBytes

    properties:
      name:
        description: Attribute name
        type: string
        example: "attribute1"
      fixedLenBufferSizeInBytes:
        description: Number of bytes in the fixed-length attribute data buffer (offsets for var-len attributes)
        type: integer
        format: uint64
      varLenBufferSizeInBytes:
        description: Number of bytes in the var-length attribute data buffer
        type: integer
        format: uint64

  Writer:
    type: object
    properties:
      checkCoordDups:
        type: boolean
      checkCoordOOB:
        type: boolean
      dedupCoords:
        type: boolean
      subarray:
        $ref: "#/definitions/DomainArray"

  SubarrayRanges:
    description: A set of 1D ranges for a subarray
    type: object
    properties:
      type:
        $ref: "#/definitions/Datatype"
      hasDefaultRange:
        description: True if the range is the default range
        type: boolean
      buffer:
        description: The bytes of the ranges
        type: array
        items:
          type: integer
          format: uint8

  Subarray:
    description: A Subarray
    type: object
    properties:
      layout:
        $ref: "#/definitions/Layout"
      ranges:
        description: List of 1D ranges, one per dimension
        type: array
        x-omitempty: true
        items:
          $ref: "#/definitions/SubarrayRanges"

  SubarrayPartitioner:
    description: The subarray partitioner
    type: object
    properties:
      subarray:
        $ref: "#/definitions/Subarray"
      budget:
        description: Result size budget (in bytes) for all attributes.
        type: array
        x-omitempty: true
        items:
          $ref: "#/definitions/AttributeBufferSize"
      current:
        description: The current partition info
        type: object
        properties:
          subarray:
            $ref: "#/definitions/Subarray"
          start:
            description: PartitionInfo start
            type: integer
            format: uint64
          end:
            description: PartitionInfo end
            type: integer
            format: uint64
          splitMultiRange:
            description: PartitionInfo splitMultiRange
            type: boolean
      state:
        description: The state information for the remaining partitions to be produced
        type: object
        properties:
          start:
            description: State start
            type: integer
            format: uint64
          end:
            description: State end
            type: integer
            format: uint64
          singleRange:
            description: State singleRange
            type: array
            x-omitempty: true
            items:
              $ref: "#/definitions/Subarray"
          multiRange:
            description: State multiRange
            type: array
            x-omitempty: true
            items:
              $ref: "#/definitions/Subarray"
      memoryBudget:
        description: The memory budget for the fixed-sized attributes and the offsets of the var-sized attributes
        type: integer
        format: uint64
      memoryBudgetVar:
        description: The memory budget for the var-sized attributes
        type: integer
        format: uint64

  ReadState:
    description: state for reads
    type: object
    properties:
      initialized:
        description: True if the reader has been initialized.
        type: boolean

      overflowed:
        description: True if the query produced results that could not fit in some buffer.
        type: boolean

      unsplittable:
        description: True if the current subarray partition is unsplittable.
        type: boolean

      subarrayPartitioner:
        $ref: "#/definitions/SubarrayPartitioner"

  QueryReader:
    description: Read struct (can't be called reader due to class name conflict)
    type: object
    properties:
      layout:
        $ref: "#/definitions/Layout"
      subarray:
        $ref: "#/definitions/Subarray"
      readState:
        description: To handle incomplete read queries.
        $ref: "#/definitions/ReadState"
      varOffsetsMode:
        description: The offsets format (bytes or elements) to be used.
        type: string
      varOffsetsAddExtraElement:
        description: True if an extra element will be added to the end of the offsets buffer.
        type: boolean
      varOffsetsBitsize:
        description: The offsets bitsize (32 or 64) to be used.
        type: integer
        format: uint32

  Query:
    type: object
    required:
      - type
      - attributeBufferHeaders
      - layout
      - status
      - array
      - totalFixedLengthBufferBytes
      - totalVarLenBufferBytes
    properties:
      type:
        $ref: "#/definitions/Querytype"
      layout:
        $ref: "#/definitions/Layout"
      status:
        $ref: "#/definitions/Querystatus"
      attributeBufferHeaders:
        description: List of attribute buffer headers
        type: array
        x-omitempty: true
        items:
          $ref: "#/definitions/AttributeBufferHeader"
      writer:
        description: writer contains data needed for continuation of global write order queries
        $ref: "#/definitions/Writer"
      reader:
        description: reader contains data needed for continuation of reads
        $ref: "#/definitions/QueryReader"
      array:
        description: Represents an open array
        $ref: "#/definitions/Array"
      totalFixedLengthBufferBytes:
        description: Total number of bytes in fixed size attribute buffers.
        type: integer
        format: uint64
      totalVarLenBufferBytes:
        description: Total number of bytes in variable size attribute buffers.
        type: integer
        format: uint64
    x-go-type:
      import:
        package: "github.com/TileDB-Inc/TileDB-Go"
        alias: "tiledb"
      type: "Query"

  NonEmptyDomain:
    type: object
    description: object representing a non-empty domain
    required:
      - nonEmptyDomain
      - isEmpty
    properties:
      nonEmptyDomain:
        description: Non Empty Domain of array
        $ref: "#/definitions/DomainArray"
      isEmpty:
        description: Is non-empty domain really empty?
        type: boolean
        example: False

  AttributeBufferSize:
    type: object
    description: object representing buffer size of an attribute
    required:
      - attribute
      - offsetBytes
      - dataBytes
    properties:
      attribute:
        description: name of attribute
        type: string
      offsetBytes:
        description: buffer size (in bytes) of offset buffer
        type: integer
        format: uint64
      dataBytes:
        description: buffer size (in bytes) of data buffer
        type: integer
        format: uint64

  MaxBufferSizes:
    type: object
    description: a list of max buffer sizes, one per attribute
    properties:
      maxBufferSizes:
        type: array
        x-omitempty: true
        items:
          $ref: "#/definitions/AttributeBufferSize"

  ArrayMetadataEntry:
    type: object
    description: key/value pair representing an array metadata map entry
    properties:
      key:
        type: string
      type:
        type: string
      valueNum:
        type: integer
        format: uint32
      value:
        type: array
        items:
          type: integer
          format: uint8
      del:
        type: boolean

  ArrayMetadata:
    type: object
    description: user's TileDB array metadata
    properties:
      entries:
        description: List of metadata entries
        type: array
        x-omitempty: true
        items:
          $ref: "#/definitions/ArrayMetadataEntry"

  MetadataStringifiedEntry:
    type: object
    description: key/value pair representing an asset metadata map entry
    properties:
      key:
        description: The metadata key
        type: string
        x-omitempty: false
      value:
        description: The metadata value
        type: string
        x-omitempty: false
      type:
        description: The metadata type
        type: string
        x-omitempty: false
        example: array_metadata

  TileDBConfig:
    description: TileDB config used for interaction with the embedded library
    type: object
    properties:
      entries:
        type: array
        items:
          type: object
          properties:
            key:
              type: string
            value:
              type: string


  ArrayActivityLog:
    description: Actvity of an Array
    type: object
    properties:
      event_at:
        description: time event took place (RFC3339)
        type: string
        format: date-time
      action:
        description: Type of the event
        $ref: "#/definitions/ActivityEventType"
      username:
        description: User who performed action
        type: string
        example: "user1"
      bytes_sent:
        description: Bytes sent to client
        type: integer
        format: uint64
        example: 1073741824
      bytes_received:
        description: Bytes recieved from client
        type: integer
        format: uint64
        example: 1073741824
      array_task_id:
        description: UUID of associated array task
        type: string
        example: "00000000-0000-0000-0000-000000000000"
      id:
        description: ID of the activity
        type: string
        example: "00000000-0000-0000-0000-000000000000"
      query_ranges:
        description: ranges for query
        x-omitempty: true
        type: string
        example: '{"rows":[{"start": 1, "end": 1},{"start": 3, "end": 4}],"cols":[{"start": 1, "end": 4}]}'
      query_stats:
        description: stats for query
        x-omitempty: true
        type: string
        example: '{"timers": {"Context.StorageManager.read_load_array_schema_from_uri.sum": 0.0255293, "...": "..."}, "counters": {"Context.StorageManager.read_unfiltered_byte_num": 191, "...": "..."}}'

  ArrayTaskType:
    description: Synchronous Task Type
    type: string
    enum:
      - SQL
      - UDF
      - QUERY
      - GENERIC_UDF
      - BATCH_UDF
      - CLIENT_COMPUTATION

  ArrayTaskStatus:
    description: Status of array task
    type: string
    enum:
      - QUEUED
      - FAILED
      - COMPLETED
      - RUNNING
      - RESOURCES_UNAVAILABLE
      - UNKNOWN
      - CANCELLED
      - DENIED # Deprecated; used to mean RESOURCES_UNAVAILABLE.

  ArrayTaskLog:
    description: Array task stderr/stdout logs
    type: object
    properties:
      array_task_id:
        description: ID of associated task
        type: string
      logs:
        description: logs from array task
        type: string

  ArrayTask:
    description: Synchronous Task to Run
    type: object
    properties:
      id:
        description: task ID
        type: string
      name:
        description: Optional task name
        type: string
        example: "subarray-multiplier"
      username:
        description: username that executed this task
        type: string
        example: "demo"
      description:
        description: Optional task description (Tasks purpose)
        type: string
        example: "Return attr a1 in the subarray bounded by coordinates and multiply attr1 by 2"
      array_metadata:
        description: Metadata of the array used in the context of this task
        $ref: "#/definitions/ArrayInfo"
      subarray:
        description: A subarray to run the array task on
        $ref: "#/definitions/DomainArray"
        example:
          - Dim1:
              Int64: 0
                10
            Dim2:
              Int64: 20
                22
            Dim3:
              Int64: 10000
                10100
      memory:
        description: memory allocated to task in bytes
        type: integer
        format: uint64
        example: 1073741824
      cpu:
        description: millicpu allocated to task
        type: integer
        format: uint64
        example: 4000
      namespace:
        type: string
        description: namespace task is tied to
        example: "organization1"
      status:
        description: The status of an individual task
        $ref: "#/definitions/ArrayTaskStatus"
      status_message:
        description: The reason the array task status is in the state
        type: string
        x-nullable: true
        x-omitempty: true
      start_time:
        description: Start time RFC3339 for job
        type: string
        format: date-time
        x-nullable: true
      finish_time:
        description: Finish time RFC3339 for job
        type: string
        format: date-time
        x-nullable: true
      cost:
        description: Total accumulated for task in USD, example is $0.12
        type: number
        format: double
        example: 0.12
      egress_cost:
        description: Total accumulated for egress task in USD, example is $0.12
        type: number
        format: double
        example: 0.12
      access_cost:
        description: Cost accumulated for access task in USD, example is $0.12
        type: number
        format: double
        example: 0.12
      query_type:
        description: If task type is query, whether it's a read or write query
        $ref: "#/definitions/Querytype"
      udf_code:
        description: Optional actual code that is going to be executed
        type: string
      udf_language:
        description: Optional actual language used to express udf_code
        type: string
      sql_query:
        description: Optional actual sql query that is going to be executed
        type: string
      type:
        description: Type of task
        $ref: "#/definitions/ArrayTaskType"
      activity:
        description: Array activity logs for task
        type: array
        x-omitempty: true
        items:
          $ref: "#/definitions/ArrayActivityLog"
      logs:
        description: logs from array task
        type: string
        x-omitempty: false
      duration:
        description: duration in nanoseconds of an array task
        type: number
        example: 341000000000
      sql_init_commands:
        description: SQL queries or commands to run before main sql query
        type: array
        items:
          type: string
          description: sql query or command to run before main sql query
      sql_parameters:
        description: SQL query parameters
        type: array
        items: {}
      result_format:
        $ref: "#/definitions/ResultFormat"
        description: type of results (native, i.e cloud pickle or json or arrow)
        x-omitempty: true
      task_graph_uuid:
        type: string
        x-omitempty: true
        description: >
          If set, the ID of the log for the task graph that this was part of.
      client_node_uuid:
        type: string
        x-omitempty: true
        description: >
          If set, the client-defined ID of the node within this task's graph.
      cloud_provider:
        type: string
        x-omitempty: true
        description: The name of the cloud provider where this task executed.
      cloud_region:
        type: string
        x-omitempty: true
        description: The region of the cloud provider where this task executed.

  PaginationMetadata:
    properties:
      page:
        description: pagination offset. Use it to skip the first ((page - 1) * per_page) items
        type: number
        format: uint64
        example: 1
      per_page:
        description: pagination limit (page size)
        type: number
        format: uint64
        example: 10
      total_pages:
        description: number of total pages with current limit
        type: number
        format: uint64
        example: 14
      total_items:
        description: number of total available items
        type: number
        format: uint64
        example: 138

  ArrayTaskData:
    description: Object including array tasks and metadata
    type: object
    properties:
      array_tasks:
        description: Array Tasks
        type: array
        x-omitempty: true
        items:
          $ref: "#/definitions/ArrayTask"
      pagination_metadata:
        $ref: "#/definitions/PaginationMetadata"

  ArrayTaskBrowserSidebar:
    description: Object for ui array tasks browser page
    type: object
    properties:
      organizations:
        description: list of all unique organizations the user is part of that have array tasks
        type: array
        x-omitempty: false
        items:
          ty

# --- truncated at 32 KB (304 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/tiledb/refs/heads/main/openapi/tiledb-cloud-v1-openapi.yaml