openapi: 3.0.1
info:
  title: Searchcraft Authentication Transactions API
  description: REST API for the Searchcraft developer search engine. Manage indexes and their schemas, ingest and delete documents, run fuzzy/exact full-text and federated search, and manage synonyms, stopwords, federations, access keys, and usage measurement. Available as the managed Searchcraft Cloud service and the self-hosted Searchcraft Core engine.
  termsOfService: https://www.searchcraft.io/
  contact:
    name: Searchcraft
    url: https://www.searchcraft.io/
  version: '1.0'
servers:
- url: https://your-cluster.searchcraft.io
  description: Searchcraft Cloud cluster endpoint. Each Searchcraft Cloud account is provisioned a unique cluster host; replace "your-cluster" with your cluster subdomain. Self-hosted Searchcraft Core instances use their own host.
security:
- SearchcraftKey: []
tags:
- name: Transactions
paths:
  /index/{index}/commit:
    parameters:
    - $ref: '#/components/parameters/IndexName'
    post:
      operationId: commitTransaction
      tags:
      - Transactions
      summary: Commits the open write transaction for an index.
      responses:
        '200':
          description: The transaction was committed.
  /index/{index}/rollback:
    parameters:
    - $ref: '#/components/parameters/IndexName'
    post:
      operationId: rollbackTransaction
      tags:
      - Transactions
      summary: Rolls back the open write transaction for an index.
      responses:
        '200':
          description: The transaction was rolled back.
components:
  parameters:
    IndexName:
      name: index
      in: path
      required: true
      description: The name of the index.
      schema:
        type: string
  securitySchemes:
    SearchcraftKey:
      type: apiKey
      in: header
      name: Authorization
      description: 'Searchcraft access key passed directly in the Authorization header (no "Bearer" prefix). Keys are tiered by permission: read (search), ingest (document, synonym, stopword, transaction, and measure writes), and admin (index, federation, and key management). Keys may be scoped to specific indexes via allowed_indexes.'