Skip to content

AlterTransaction

Description

      description: |
        Alter a transaction with a list of actions such as setting status or properties.
        The server should either succeed and apply all actions, or fail and apply no action.

Request Schema

    AlterTransactionRequest:
      type: object
      description: |
        Alter a transaction with a list of actions.
        The server should either succeed and apply all actions, or fail and apply no action.
      required:
        - actions
      properties:
        id:
          type: array
          items:
            type: string
        actions:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/AlterTransactionAction'
Supporting action schemas:

Set Status Action: 

      minimum: 0

    InsertIntoTableRequest:
      type: object
      description: |
        Request for inserting records into a table, excluding the Arrow IPC stream.
Set Property Action: 
      properties:
        id:
          type: array
          items:
            type: string
        mode:
          type: string
          enum:
            - append
            - overwrite
Unset Property Action: 
    MergeInsertIntoTableRequest:
      type: object
      description: |
        Request for merging or inserting records into a table, excluding the Arrow IPC stream.
      properties:
        id:
          type: array
          items:

Response Schema

    AlterTransactionResponse:
      type: object
      required:
        - status
      properties:
        status:
          $ref: '#/components/schemas/TransactionStatus'
        properties:
          type: object
          additionalProperties:
            type: string

Set Status Action

    AlterTransactionSetStatus:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/TransactionStatus'

Set Property Action

    AlterTransactionSetProperty:
      type: object
      properties:
        key:
          type: string
        value:
          type: string
        mode:
          $ref: '#/components/schemas/SetPropertyMode'

Unset Property Action

    AlterTransactionUnsetProperty:
      type: object
      properties:
        key:
          type: string
        mode:
          $ref: '#/components/schemas/UnsetPropertyMode'