API Reference — subpackage_snapshots

naftiko: 1.0.0-alpha2
info:
  label: API Reference — subpackage_snapshots
  description: 'API Reference — subpackage_snapshots. 6 operations. Lead operation: Create a snapshot. Self-contained Naftiko
    capability covering one Flatfile business surface.'
  tags:
  - Flatfile
  - subpackage_snapshots
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FLATFILE_API_KEY: FLATFILE_API_KEY
capability:
  consumes:
  - type: http
    namespace: flatfile-subpackage-snapshots
    baseUri: https://api.x.flatfile.com/v1
    description: API Reference — subpackage_snapshots business capability. Self-contained, no shared references.
    resources:
    - name: snapshots
      path: /snapshots
      operations:
      - name: createsnapshot
        method: POST
        description: Create a snapshot
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
        - name: X-Disable-Hooks
          in: header
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: listsnapshots
        method: GET
        description: List snapshots
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sheetId
          in: query
          type: string
          description: ID of sheet
          required: true
        - name: threadId
          in: query
          type: string
          description: ID of thread to filter snapshots by
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
        - name: X-Disable-Hooks
          in: header
          type: string
          required: true
    - name: snapshots-snapshotId
      path: /snapshots/{snapshotId}
      operations:
      - name: getsnapshot
        method: GET
        description: Get a snapshot
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: snapshotId
          in: path
          type: string
          description: ID of snapshot
          required: true
        - name: includeSummary
          in: query
          type: boolean
          description: Whether to include a summary in the snapshot response
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
        - name: X-Disable-Hooks
          in: header
          type: string
          required: true
      - name: deletesnapshot
        method: DELETE
        description: Delete a snapshot
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: snapshotId
          in: path
          type: string
          description: ID of snapshot
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
        - name: X-Disable-Hooks
          in: header
          type: string
          required: true
    - name: snapshots-snapshotId-records
      path: /snapshots/{snapshotId}/records
      operations:
      - name: getsnapshotrecords
        method: GET
        description: Get records from a snapshot
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: snapshotId
          in: path
          type: string
          description: ID of snapshot
          required: true
        - name: pageSize
          in: query
          type: integer
          description: Number of records to return in a page
        - name: pageNumber
          in: query
          type: integer
          description: Based on pageSize, which page of records to return
        - name: changeType
          in: query
          type: string
          description: Filter records by change type
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
        - name: X-Disable-Hooks
          in: header
          type: string
          required: true
    - name: snapshots-snapshotId-restore
      path: /snapshots/{snapshotId}/restore
      operations:
      - name: restoresnapshot
        method: POST
        description: Restore a snapshot
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: snapshotId
          in: path
          type: string
          description: ID of snapshot
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
        - name: X-Disable-Hooks
          in: header
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: bearer
      token: '{{env.FLATFILE_API_KEY}}'
  exposes:
  - type: rest
    namespace: flatfile-subpackage-snapshots-rest
    port: 8080
    description: REST adapter for API Reference — subpackage_snapshots. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/snapshots
      name: snapshots
      description: REST surface for snapshots.
      operations:
      - method: POST
        name: createsnapshot
        description: Create a snapshot
        call: flatfile-subpackage-snapshots.createsnapshot
        with:
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: listsnapshots
        description: List snapshots
        call: flatfile-subpackage-snapshots.listsnapshots
        with:
          sheetId: rest.sheetId
          threadId: rest.threadId
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/snapshots/{snapshotid}
      name: snapshots-snapshotid
      description: REST surface for snapshots-snapshotId.
      operations:
      - method: GET
        name: getsnapshot
        description: Get a snapshot
        call: flatfile-subpackage-snapshots.getsnapshot
        with:
          snapshotId: rest.snapshotId
          includeSummary: rest.includeSummary
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletesnapshot
        description: Delete a snapshot
        call: flatfile-subpackage-snapshots.deletesnapshot
        with:
          snapshotId: rest.snapshotId
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/snapshots/{snapshotid}/records
      name: snapshots-snapshotid-records
      description: REST surface for snapshots-snapshotId-records.
      operations:
      - method: GET
        name: getsnapshotrecords
        description: Get records from a snapshot
        call: flatfile-subpackage-snapshots.getsnapshotrecords
        with:
          snapshotId: rest.snapshotId
          pageSize: rest.pageSize
          pageNumber: rest.pageNumber
          changeType: rest.changeType
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/snapshots/{snapshotid}/restore
      name: snapshots-snapshotid-restore
      description: REST surface for snapshots-snapshotId-restore.
      operations:
      - method: POST
        name: restoresnapshot
        description: Restore a snapshot
        call: flatfile-subpackage-snapshots.restoresnapshot
        with:
          snapshotId: rest.snapshotId
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: flatfile-subpackage-snapshots-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — subpackage_snapshots. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: create-snapshot
      description: Create a snapshot
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: flatfile-subpackage-snapshots.createsnapshot
      with:
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-snapshots
      description: List snapshots
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: flatfile-subpackage-snapshots.listsnapshots
      with:
        sheetId: tools.sheetId
        threadId: tools.threadId
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
      outputParameters:
      - type: object
        mapping: $.
    - name: get-snapshot
      description: Get a snapshot
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: flatfile-subpackage-snapshots.getsnapshot
      with:
        snapshotId: tools.snapshotId
        includeSummary: tools.includeSummary
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-snapshot
      description: Delete a snapshot
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: flatfile-subpackage-snapshots.deletesnapshot
      with:
        snapshotId: tools.snapshotId
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
      outputParameters:
      - type: object
        mapping: $.
    - name: get-records-snapshot
      description: Get records from a snapshot
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: flatfile-subpackage-snapshots.getsnapshotrecords
      with:
        snapshotId: tools.snapshotId
        pageSize: tools.pageSize
        pageNumber: tools.pageNumber
        changeType: tools.changeType
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
      outputParameters:
      - type: object
        mapping: $.
    - name: restore-snapshot
      description: Restore a snapshot
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: flatfile-subpackage-snapshots.restoresnapshot
      with:
        snapshotId: tools.snapshotId
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.