Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Accounting Subpackage Items API

7 actions 7 updates phrasing extends openapi/merge-subpackage-items-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 7

$.info
$.paths['/accounting/v1/items'].get
$.paths['/accounting/v1/items'].post
$.paths['/accounting/v1/items/{id}'].get
$.paths['/accounting/v1/items/{id}'].patch
$.paths['/accounting/v1/items/meta/patch/{id}'].get
$.paths['/accounting/v1/items/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 Items API
  version: 1.0.0
extends: openapi/merge-subpackage-items-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: 6
- target: $.paths['/accounting/v1/items'].get
  update:
    x-apievangelist-phrasing:
      intent: List accounting items
      effect: read
      questions:
      - Can I pull the products and services list from a customer's accounting system?
      - Is there a way to find accounting items by name?
      instructions:
      - text: List items named {name}.
        slots:
          name: query.name
      - text: Show accounting items for company {company_id}.
        slots:
          company_id: query.company_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/items'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an accounting item
      effect: write
      questions:
      - How do I add a new product or service item to the ledger?
      - Can I create an item asynchronously in the accounting system?
      instructions:
      - text: Create item {item}.
        slots:
          item: requestBody.model
      - text: Add product item {item} asynchronously {run_async}.
        slots:
          item: requestBody.model
          run_async: query.run_async
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/items/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an accounting item
      effect: read
      questions:
      - Can I look up one product or service item by ID?
      - What pricing and account details are on a single item?
      instructions:
      - text: Get item {id}.
        slots:
          id: path.id
      - text: Show me accounting item {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/items/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an accounting item
      effect: write
      questions:
      - Can I change the price or name of an existing item?
      - How do I edit a product item that's already in the ledger?
      instructions:
      - text: Update item {id} with {changes}.
        slots:
          id: path.id
          changes: requestBody.model
      - text: Patch accounting item {id} to {changes} with debug mode {is_debug_mode}.
        slots:
          id: path.id
          changes: requestBody.model
          is_debug_mode: query.is_debug_mode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/items/meta/patch/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get fields allowed when updating an item
      effect: read
      questions:
      - Which fields can I change on a specific accounting item?
      - What does the ledger let me edit on an existing item?
      instructions:
      - text: Show editable fields for item {id}.
        slots:
          id: path.id
      - text: Get update metadata for accounting item {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/items/meta/post'].get
  update:
    x-apievangelist-phrasing:
      intent: Get fields required to create an item
      effect: read
      questions:
      - Which fields must I send to create a new item?
      - What does the accounting system accept when posting an item?
      instructions:
      - text: Show item creation fields for account token {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Get the create metadata for accounting items.
      method: generated
      generated: '2026-09-26'