Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Accounting Subpackage Bank Feed Accounts API

5 actions 5 updates phrasing extends openapi/merge-subpackage-bankfeedaccounts-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Merge's API. It is a proposal applied on top of the contract, not a document Merge publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/accounting/v1/bank-feed-accounts'].get
$.paths['/accounting/v1/bank-feed-accounts'].post
$.paths['/accounting/v1/bank-feed-accounts/{id}'].get
$.paths['/accounting/v1/bank-feed-accounts/meta/post'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Accounting Subpackage Bank Feed Accounts API
  version: 1.0.0
extends: openapi/merge-subpackage-bankfeedaccounts-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/accounting/v1/bank-feed-accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List bank feed accounts
      effect: read
      questions:
      - Which bank feed accounts are set up in a customer's accounting system?
      - Can I include bank feed accounts deleted in the source system?
      instructions:
      - text: List bank feed accounts for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Show bank feed accounts, {page_size} per page.
        slots:
          page_size: query.page_size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/bank-feed-accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a bank feed account
      effect: write
      questions:
      - How do I set up a new bank feed account so I can push transactions into the books?
      - Can creating a bank feed account run asynchronously?
      instructions:
      - text: Create bank feed account {model} in linked account {account_token}.
        slots:
          model: requestBody.model
          account_token: header.X-Account-Token
      - text: Register a new bank feed with {model}.
        slots:
          model: requestBody.model
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/bank-feed-accounts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a bank feed account
      effect: read
      questions:
      - What details are stored for one specific bank feed account?
      - Can I see the remote data for one bank feed account?
      instructions:
      - text: Get bank feed account {id}.
        slots:
          id: path.id
      - text: Fetch bank feed account {id} with its remote data.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/bank-feed-accounts/meta/post'].get
  update:
    x-apievangelist-phrasing:
      intent: Get fields for creating bank feed accounts
      effect: read
      questions:
      - Which fields are required to create a bank feed account in an integration?
      - What does the accounting system accept for a new bank feed?
      instructions:
      - text: Show bank feed account POST metadata for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Describe the create fields for bank feed accounts.
      method: generated
      generated: '2026-09-26'