# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Reference Accounts API
  version: 1.0.0
extends: openapi/lightfield-accounts-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/v1/accounts/definitions'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the field schema for accounts
      effect: read
      questions:
      - What fields and custom fields can an account record have in Lightfield?
      - Which account fields are system-defined versus custom before I create a company record?
      instructions:
      - text: Show me every field and relationship definition available on accounts.
      - text: Fetch the account schema so I know which custom fields exist.
      - text: Get account field definitions using API version {version}.
        slots:
          version: header.Lightfield-Version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List accounts
      effect: read
      questions:
      - How do I page through all the companies stored as accounts?
      - Can I filter my accounts by a field value and cap how many come back per page?
      instructions:
      - text: List my accounts.
      - text: List {limit} accounts starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a company account
      effect: write
      questions:
      - How do I add a new company account, and does it get enriched if I give a website?
      - What is the minimum I need to create an account record?
      instructions:
      - text: 'Create an account with these fields: {fields}.'
        slots:
          fields: requestBody.fields
      - text: Add a new company account using {fields} and link it via {relationships}.
        slots:
          fields: requestBody.fields
          relationships: requestBody.relationships
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve one account by ID
      effect: read
      questions:
      - How do I look up a single account when I already have its ID?
      - Can I pull the full record for one specific company account?
      instructions:
      - text: Get account {id}.
        slots:
          id: path.id
      - text: Show me the details of account {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an existing account
      effect: write
      questions:
      - How do I change fields on a company account I already created?
      - Can I update only some of an existing account's fields without touching the rest?
      instructions:
      - text: Update account {id} with {fields}.
        slots:
          id: path.id
          fields: requestBody.fields
      - text: Change the relationships on existing account {id} to {relationships}.
        slots:
          id: path.id
          relationships: requestBody.relationships
      method: generated
      generated: '2026-10-01'