naftiko: 1.0.0-alpha2
info:
  label: API Reference — subpackage_canvas-areas
  description: 'API Reference — subpackage_canvas-areas. 5 operations. Lead operation: List canvas areas. Self-contained Naftiko
    capability covering one Flatfile business surface.'
  tags:
  - Flatfile
  - subpackage_canvas-areas
  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-canvas-areas
    baseUri: https://api.x.flatfile.com/v1
    description: API Reference — subpackage_canvas-areas business capability. Self-contained, no shared references.
    resources:
    - name: canvas-areas
      path: /canvas-areas
      operations:
      - name: list
        method: GET
        description: List canvas areas
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: canvasId
          in: query
          type: string
          description: ID of the canvas to filter areas by
        - name: parentId
          in: query
          type: string
          description: ID of the parent canvas area to filter by
        - name: spaceId
          in: query
          type: string
          description: ID of the space to filter areas by
        - name: environmentId
          in: query
          type: string
          description: ID of the environment to filter areas by
        - name: pageSize
          in: query
          type: integer
          description: Number of areas to return in a page (default 20)
        - name: pageNumber
          in: query
          type: integer
          description: Based on pageSize, which page of areas to return
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
        - name: X-Disable-Hooks
          in: header
          type: string
          required: true
      - name: create
        method: POST
        description: Create a canvas area
        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: canvas-areas-canvasAreaId
      path: /canvas-areas/{canvasAreaId}
      operations:
      - name: get
        method: GET
        description: Get a canvas area
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: canvasAreaId
          in: path
          type: string
          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 a canvas area
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: canvasAreaId
          in: path
          type: string
          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 a canvas area
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: canvasAreaId
          in: path
          type: string
          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-canvas-areas-rest
    port: 8080
    description: REST adapter for API Reference — subpackage_canvas-areas. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/canvas-areas
      name: canvas-areas
      description: REST surface for canvas-areas.
      operations:
      - method: GET
        name: list
        description: List canvas areas
        call: flatfile-subpackage-canvas-areas.list
        with:
          canvasId: rest.canvasId
          parentId: rest.parentId
          spaceId: rest.spaceId
          environmentId: rest.environmentId
          pageSize: rest.pageSize
          pageNumber: rest.pageNumber
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: create
        description: Create a canvas area
        call: flatfile-subpackage-canvas-areas.create
        with:
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/canvas-areas/{canvasareaid}
      name: canvas-areas-canvasareaid
      description: REST surface for canvas-areas-canvasAreaId.
      operations:
      - method: GET
        name: get
        description: Get a canvas area
        call: flatfile-subpackage-canvas-areas.get
        with:
          canvasAreaId: rest.canvasAreaId
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: update
        description: Update a canvas area
        call: flatfile-subpackage-canvas-areas.update
        with:
          canvasAreaId: rest.canvasAreaId
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: Delete a canvas area
        call: flatfile-subpackage-canvas-areas.delete
        with:
          canvasAreaId: rest.canvasAreaId
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: flatfile-subpackage-canvas-areas-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — subpackage_canvas-areas. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-canvas-areas
      description: List canvas areas
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: flatfile-subpackage-canvas-areas.list
      with:
        canvasId: tools.canvasId
        parentId: tools.parentId
        spaceId: tools.spaceId
        environmentId: tools.environmentId
        pageSize: tools.pageSize
        pageNumber: tools.pageNumber
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
      outputParameters:
      - type: object
        mapping: $.
    - name: create-canvas-area
      description: Create a canvas area
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: flatfile-subpackage-canvas-areas.create
      with:
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-canvas-area
      description: Get a canvas area
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: flatfile-subpackage-canvas-areas.get
      with:
        canvasAreaId: tools.canvasAreaId
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
      outputParameters:
      - type: object
        mapping: $.
    - name: update-canvas-area
      description: Update a canvas area
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: flatfile-subpackage-canvas-areas.update
      with:
        canvasAreaId: tools.canvasAreaId
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-canvas-area
      description: Delete a canvas area
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: flatfile-subpackage-canvas-areas.delete
      with:
        canvasAreaId: tools.canvasAreaId
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
      outputParameters:
      - type: object
        mapping: $.