Ardent v1-branching API

openapi: 3.2.0
info:
  title: Fast V1 Branching API
  version: 0.1.0
tags:
- name: v1-branching
paths:
  /v1/branch/create:
    post:
      tags:
      - v1-branching
      summary: Create Service Branch
      description: CLI endpoint to create a new branch for a connector.
      operationId: create_service_branch_v1_branch_create_post
      responses:
        '202':
          description: 'Create accepted. Poll `GET /v1/operations/{operation_id}` for the branch details. Idempotent replays carry an `X-Idempotency-Replay: true` response header.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationHandle'
        '400':
          description: A required field is missing, or the branch name or idempotency key is invalid.
        '409':
          description: A branch with this name already exists on the connector, this create is already in flight, or the idempotency key was reused for a different request.
        '422':
          description: The connector's engine isn't ready to branch.
        '503':
          description: Ardent could not start the work — safe to retry.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              description: 'Body of POST /v1/branch/create.


                Spec-only today: the handler parses the raw body by hand so a missing

                field keeps returning the documented 400, not Pydantic''s 422. Keep the

                fields in sync with the hand parsing below.'
              properties:
                connector_id:
                  description: Connector to branch from.
                  title: Connector Id
                  type: string
                service_type:
                  description: Service to branch; `postgres`, not the connector type `postgresql`.
                  title: Service Type
                  type: string
                name:
                  description: Branch name, unique per connector.
                  title: Name
                  type: string
              required:
              - connector_id
              - service_type
              - name
              title: BranchCreateRequest
              type: object
      parameters:
      - in: header
        name: X-Idempotency-Key
        required: false
        schema:
          type: string
        description: 'Makes retries safe: re-sending the same connector, service type, and name resumes the original request instead of creating a duplicate.'
  /v1/branch/route:
    post:
      tags:
      - v1-branching
      summary: Route Proxy Connection
      description: Internal endpoint for the proxy to route a connection to the correct branch.
      operationId: route_proxy_connection_v1_branch_route_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /v1/branches/{connector_id}:
    get:
      tags:
      - v1-branching
      summary: Get Branches
      description: 'Get branch metadata for a connector.


        Authorization: User must be authenticated and the connector must belong to

        an org the user has access to. RLS on branches checks

        current_user_accessible_connectors.'
      operationId: get_branches_v1_branches__connector_id__get
      parameters:
      - name: connector_id
        in: path
        required: true
        schema:
          type: string
          title: Connector Id
      responses:
        '200':
          description: Up to 100 branch rows for the connector. Rows may carry additional columns beyond the documented core.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BranchRow'
                title: Response 200 Get Branches V1 Branches  Connector Id  Get
        '404':
          description: Connector 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.'
    OperationHandle:
      properties:
        operation_id:
          type: string
          title: Operation Id
          description: Operation to poll at `GET /v1/operations/{operation_id}`.
        status:
          $ref: '#/components/schemas/OperationStatus'
          description: Status at acceptance time.
        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 being created or acted on (the branch ID for branch create).
      type: object
      required:
      - operation_id
      - status
      - type
      - resource_id
      title: OperationHandle
      description: '202 acceptance body for async endpoints (branch create today).


        Declared on routes so the OpenAPI spec documents the handle shape.

        Handlers keep building the dict by hand; declaring this model on a

        route is spec-only and never changes a live response.'
    BranchRow:
      properties:
        id:
          type: string
          title: Id
          description: Branch ID.
        name:
          type: string
          title: Name
          description: Branch name, as given at create.
        connector_id:
          type: string
          title: Connector Id
          description: Connector this branch was created from.
        service_type:
          type: string
          title: Service Type
          description: Branched service. `postgres` for Postgres branches.
        status:
          type: string
          title: Status
          description: Current branch status.
        created_at:
          type: string
          title: Created At
          description: When the branch was created.
        last_branch_activity:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Branch Activity
          description: Most recent activity on the branch. Null when none has been recorded.
        read_ready_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Read Ready At
          description: When the branch became ready for reads. Null until then.
        write_ready_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Write Ready At
          description: When the branch became ready for writes. Null until then.
        masked_ready_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Masked Ready At
          description: When masked data became ready. Null until then.
        branch_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Branch Url
          description: Direct connection URL for the branch; sensitive — use exactly as returned.
        pooled_branch_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Pooled Branch Url
          description: Pooled connection URL. Null when the provider has no pooled endpoint.
        pooled_branch_prisma_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Pooled Branch Prisma Url
          description: Prisma-formatted pooled URL; null when the provider has no pooled endpoint.
      additionalProperties: true
      type: object
      required:
      - id
      - name
      - connector_id
      - service_type
      - status
      - created_at
      title: BranchRow
      description: 'One row of GET /v1/branches/{connector_id}.


        Spec-only: the handler returns raw table rows (select *) enriched with

        URL fields, so this model documents the stable core without filtering.

        extra="allow" is the contract — rows carry additional columns, and

        clients must tolerate fields not listed here.'
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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)