Bubble Thing API

openapi: 3.2.0
info:
  title: Bubble Plugin Thing API
  description: 'The Bubble Plugin API is a JavaScript SDK surface (not an HTTP API) that plugin

    authors use to extend Bubble apps. It exposes server-side actions, client-side

    actions, and visual elements that read configured properties and interact with

    the runtime via a `context` object. Plugin API v4 replaces Fibers with

    Promises and adds first-class type checks (`isBubbleThing`, `isBubbleList`),

    by-id lookups (`getThingById`, `getThingsById`), and async iteration on

    `BubbleList`.


    This OpenAPI document describes the SDK surface as a virtual REST API for

    catalog and discovery purposes. Each "endpoint" represents a callable

    JavaScript function in the plugin runtime; `paths` carry the function name

    and `requestBody`/`responses` describe its parameters and return value.

    '
  version: '4.0'
  contact:
    name: Bubble Support
    url: https://bubble.io/contact
  license:
    name: Bubble Plugin Marketplace Terms
    url: https://bubble.io/legal/plugins
servers:
- url: virtual://plugin-runtime
  description: 'Virtual server. Plugin actions and elements execute inside the Bubble

    runtime; there is no public HTTP endpoint.

    '
tags:
- name: Thing
  description: Database object accessors exposed to plugin code.
paths:
  /thing/{id}:
    get:
      tags:
      - Thing
      summary: Get Thing By Id
      description: 'Look up a single database object by id. Maps to

        `context.getThingById(id)` on the server context. Returns a

        `BubbleThing` whose `get(field)` returns a Promise.

        '
      operationId: getThingById
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A BubbleThing wrapper.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BubbleThing'
  /things:
    get:
      tags:
      - Thing
      summary: Get Things By Id
      description: 'Bulk lookup. Maps to `context.getThingsById(ids)`. Returns a

        `BubbleList`.

        '
      operationId: getThingsById
      parameters:
      - name: ids
        in: query
        required: true
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: A BubbleList wrapper.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BubbleList'
components:
  schemas:
    BubbleList:
      type: object
      description: Wrapper around a database query result.
      properties:
        length:
          type: string
          description: '`() => Promise<number>` — number of items in the list.'
        get:
          type: string
          description: '`(start, length) => Promise<Array>` — fetch a slice of the list.'
        '[Symbol.asyncIterator]':
          type: string
          description: Async iteration support (added in v4) for `for await...of`.
    BubbleThing:
      type: object
      description: Wrapper around a single database record.
      properties:
        id:
          type: string
          description: Read-only unique id (added in v4).
        listProperties:
          type: string
          description: Returns an array of field names defined on the record.
        get:
          type: string
          description: '`(propertyName) => Promise<any>` — returns a Promise resolving to the field value.'
        getAll:
          type: string
          description: '`() => Promise<object>` — returns all fields as an object (added in v4).'