API Reference — subpackage_flags

naftiko: 1.0.0-alpha2
info:
  label: API Reference — subpackage_flags
  description: 'API Reference — subpackage_flags. 6 operations. Lead operation: Create. Self-contained Naftiko capability
    covering one Flatfile business surface.'
  tags:
  - Flatfile
  - subpackage_flags
  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-flags
    baseUri: https://api.x.flatfile.com/v1
    description: API Reference — subpackage_flags business capability. Self-contained, no shared references.
    resources:
    - name: v1-workbooks-workbookId-flags
      path: /v1/workbooks/{workbookId}/flags
      operations:
      - name: create
        method: POST
        description: Create
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workbookId
          in: path
          type: string
          description: The workbook ID to manage flags for
          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
      - name: list
        method: GET
        description: List
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workbookId
          in: path
          type: string
          description: The workbook ID to manage flags for
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
        - name: X-Disable-Hooks
          in: header
          type: string
          required: true
    - name: v1-workbooks-workbookId-flags-bulk-mutate
      path: /v1/workbooks/{workbookId}/flags/bulk-mutate
      operations:
      - name: bulkmutate
        method: POST
        description: Bulk Mutate
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workbookId
          in: path
          type: string
          description: The workbook ID to manage flags for
          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
    - name: v1-workbooks-workbookId-flags-slug
      path: /v1/workbooks/{workbookId}/flags/{slug}
      operations:
      - name: get
        method: GET
        description: Get
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workbookId
          in: path
          type: string
          description: The workbook ID to manage flags for
          required: true
        - name: slug
          in: path
          type: string
          description: The flag slug to retrieve
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
        - name: X-Disable-Hooks
          in: header
          type: string
          required: true
      - name: update
        method: PATCH
        description: Update
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workbookId
          in: path
          type: string
          description: The workbook ID to manage flags for
          required: true
        - name: slug
          in: path
          type: string
          description: The flag slug to update
          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
      - name: delete
        method: DELETE
        description: Delete
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workbookId
          in: path
          type: string
          description: The workbook ID to manage flags for
          required: true
        - name: slug
          in: path
          type: string
          description: The flag slug to delete
          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-flags-rest
    port: 8080
    description: REST adapter for API Reference — subpackage_flags. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v1/workbooks/{workbookid}/flags
      name: v1-workbooks-workbookid-flags
      description: REST surface for v1-workbooks-workbookId-flags.
      operations:
      - method: POST
        name: create
        description: Create
        call: flatfile-subpackage-flags.create
        with:
          workbookId: rest.workbookId
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: list
        description: List
        call: flatfile-subpackage-flags.list
        with:
          workbookId: rest.workbookId
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/workbooks/{workbookid}/flags/bulk-mutate
      name: v1-workbooks-workbookid-flags-bulk-mutate
      description: REST surface for v1-workbooks-workbookId-flags-bulk-mutate.
      operations:
      - method: POST
        name: bulkmutate
        description: Bulk Mutate
        call: flatfile-subpackage-flags.bulkmutate
        with:
          workbookId: rest.workbookId
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/workbooks/{workbookid}/flags/{slug}
      name: v1-workbooks-workbookid-flags-slug
      description: REST surface for v1-workbooks-workbookId-flags-slug.
      operations:
      - method: GET
        name: get
        description: Get
        call: flatfile-subpackage-flags.get
        with:
          workbookId: rest.workbookId
          slug: rest.slug
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: update
        description: Update
        call: flatfile-subpackage-flags.update
        with:
          workbookId: rest.workbookId
          slug: rest.slug
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: Delete
        call: flatfile-subpackage-flags.delete
        with:
          workbookId: rest.workbookId
          slug: rest.slug
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: flatfile-subpackage-flags-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — subpackage_flags. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: create
      description: Create
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: flatfile-subpackage-flags.create
      with:
        workbookId: tools.workbookId
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list
      description: List
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: flatfile-subpackage-flags.list
      with:
        workbookId: tools.workbookId
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
      outputParameters:
      - type: object
        mapping: $.
    - name: bulk-mutate
      description: Bulk Mutate
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: flatfile-subpackage-flags.bulkmutate
      with:
        workbookId: tools.workbookId
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get
      description: Get
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: flatfile-subpackage-flags.get
      with:
        workbookId: tools.workbookId
        slug: tools.slug
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
      outputParameters:
      - type: object
        mapping: $.
    - name: update
      description: Update
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: flatfile-subpackage-flags.update
      with:
        workbookId: tools.workbookId
        slug: tools.slug
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete
      description: Delete
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: flatfile-subpackage-flags.delete
      with:
        workbookId: tools.workbookId
        slug: tools.slug
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
      outputParameters:
      - type: object
        mapping: $.