Birdeye · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Birdeye Employee API

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

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/v1/employee/{businessId}'].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 Birdeye Employee API
  version: 1.0.0
extends: openapi/birdeye-employee-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: 1
- target: $.paths['/v1/employee/{businessId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List a business's employees
      effect: read
      questions:
      - Which employees are set up for a business?
      - Can I pull the employee roster for one location?
      instructions:
      - text: Get employee details for business {businessId}.
        slots:
          businessId: path.businessId
      - text: List the employees of location {businessId}.
        slots:
          businessId: path.businessId
      method: generated
      generated: '2026-09-26'