Ardent v1-operations API

openapi: 3.2.0
info:
  title: Fast V1 Operations API
  version: 0.1.0
tags:
- name: v1-operations
paths:
  /v1/operations/{operation_id}:
    get:
      tags:
      - v1-operations
      summary: Get Operation Endpoint
      description: 'Return the current state of an async operation.


        Polled or long-polled by clients to drive operation progress.

        RLS scopes visibility to operations whose resource (connector) the

        caller can read; an operation belonging to another tenant looks

        like a 404 to a non-member rather than leaking existence.


        Returns the AsyncOperationResponse shape — see models.py.'
      operationId: get_operation_endpoint_v1_operations__operation_id__get
      parameters:
      - name: operation_id
        in: path
        required: true
        schema:
          type: string
          title: Operation Id
      - name: wait
        in: query
        required: false
        schema:
          anyOf:
          - type: number
            maximum: 10.0
            minimum: 0
          - type: 'null'
          description: Optionally wait up to this many seconds for a terminal operation state. Omit for the existing immediate poll response.
          title: Wait
        description: Optionally wait up to this many seconds for a terminal operation state. Omit for the existing immediate poll response.
      responses:
        '200':
          description: Current operation state. On `completed`, `result` holds the outcome — for `branch_create`, the full branch details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncOperationResponse'
        '404':
          description: Operation not found (or not visible to the caller).
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    OperationType:
      type: string
      enum:
      - connector_engine_setup
      - connector_reset
      - connector_deep_reset
      - connector_discovery
      - connector_delete
      - connector_secret_purge
      - connector_rollout
      - connector_replication_rollback
      - connector_debezium_cutover
      - connector_debezium_shadow_cleanup
      - environment_deploy
      - environment_destroy
      - branch_create
      - branch_delete
      title: OperationType
      description: 'Discriminator for an async operation. Must match the

        async_operations_type_valid CHECK constraint in the migration —

        extending the set requires a migration to widen the constraint

        AND a worker registered in the dispatcher.'
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    AsyncOperationResponse:
      properties:
        id:
          type: string
          title: Id
          description: Operation ID.
        org_id:
          type: string
          title: Org Id
          description: Organization the operation belongs to.
        type:
          $ref: '#/components/schemas/OperationType'
          description: The kind of work this operation tracks, for example `branch_create`.
        resource_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Resource Id
          description: ID of the resource the operation acts on (the branch ID for branch create).
        status:
          $ref: '#/components/schemas/OperationStatus'
          description: Current status. `completed` and `failed` are terminal.
        stage:
          anyOf:
          - type: string
          - type: 'null'
          title: Stage
          description: Raw progress token, kept for released CLIs. Read `stage_label` instead.
        stage_label:
          anyOf:
          - type: string
          - type: 'null'
          title: Stage Label
          description: Human-readable stage; null means the operation has not started yet.
        progress:
          anyOf:
          - type: integer
            maximum: 100.0
            minimum: 0.0
          - type: 'null'
          title: Progress
          description: Best-effort completion percentage. Null when no estimate is available.
        setup_status:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Setup Status
          description: Connector setup progress detail. Present only for connector engine setup.
        result:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Result
          description: Result payload on completion; for branch create, includes `branch_url`.
        error:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
          description: Error message when the operation failed.
        started_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Started At
          description: When work started. Null until then.
        completed_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Completed At
          description: When the operation finished. Null until then.
        created_at:
          type: string
          title: Created At
          description: When the operation was created.
        updated_at:
          type: string
          title: Updated At
          description: When the operation was last updated.
      type: object
      required:
      - id
      - org_id
      - type
      - resource_id
      - status
      - created_at
      - updated_at
      title: AsyncOperationResponse
      description: 'Response shape for GET /v1/operations/{id}.


        Field set is intentionally narrow: the CLI polls this endpoint and

        we only expose what the CLI / future UI needs. Audit fields stay

        out of the response.'
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    OperationStatus:
      type: string
      enum:
      - pending
      - running
      - completed
      - failed
      title: OperationStatus
      description: 'Lifecycle status of an async operation. Mirrors the

        async_operations_status_valid CHECK constraint.'
x-provenance:
  method: harvested
  publisher: Ardent
  source: https://api.tryardent.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)