API Reference — subpackage_commits

naftiko: 1.0.0-alpha2
info:
  label: API Reference — subpackage_commits
  description: 'API Reference — subpackage_commits. 3 operations. Lead operation: Get a commit version. Self-contained Naftiko
    capability covering one Flatfile business surface.'
  tags:
  - Flatfile
  - subpackage_commits
  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-commits
    baseUri: https://api.x.flatfile.com/v1
    description: API Reference — subpackage_commits business capability. Self-contained, no shared references.
    resources:
    - name: commits-commitId
      path: /commits/{commitId}
      operations:
      - name: get
        method: GET
        description: Get a commit version
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: commitId
          in: path
          type: string
          description: ID of the commit version to return
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
        - name: X-Disable-Hooks
          in: header
          type: string
          required: true
    - name: commits-commitId-complete
      path: /commits/{commitId}/complete
      operations:
      - name: complete
        method: POST
        description: Complete a commit version
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: commitId
          in: path
          type: string
          description: ID of the commit version to complete
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
        - name: X-Disable-Hooks
          in: header
          type: string
          required: true
    - name: commits-commitId-replay
      path: /commits/{commitId}/replay
      operations:
      - name: replay
        method: POST
        description: Replay a commit version
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: commitId
          in: path
          type: string
          description: ID of the commit version to re-emit a commit:created event for
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
        - name: X-Disable-Hooks
          in: header
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.FLATFILE_API_KEY}}'
  exposes:
  - type: rest
    namespace: flatfile-subpackage-commits-rest
    port: 8080
    description: REST adapter for API Reference — subpackage_commits. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/commits/{commitid}
      name: commits-commitid
      description: REST surface for commits-commitId.
      operations:
      - method: GET
        name: get
        description: Get a commit version
        call: flatfile-subpackage-commits.get
        with:
          commitId: rest.commitId
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/commits/{commitid}/complete
      name: commits-commitid-complete
      description: REST surface for commits-commitId-complete.
      operations:
      - method: POST
        name: complete
        description: Complete a commit version
        call: flatfile-subpackage-commits.complete
        with:
          commitId: rest.commitId
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/commits/{commitid}/replay
      name: commits-commitid-replay
      description: REST surface for commits-commitId-replay.
      operations:
      - method: POST
        name: replay
        description: Replay a commit version
        call: flatfile-subpackage-commits.replay
        with:
          commitId: rest.commitId
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: flatfile-subpackage-commits-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — subpackage_commits. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: get-commit-version
      description: Get a commit version
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: flatfile-subpackage-commits.get
      with:
        commitId: tools.commitId
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
      outputParameters:
      - type: object
        mapping: $.
    - name: complete-commit-version
      description: Complete a commit version
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: flatfile-subpackage-commits.complete
      with:
        commitId: tools.commitId
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
      outputParameters:
      - type: object
        mapping: $.
    - name: replay-commit-version
      description: Replay a commit version
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: flatfile-subpackage-commits.replay
      with:
        commitId: tools.commitId
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
      outputParameters:
      - type: object
        mapping: $.