Birdeye · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Birdeye User API

6 actions 6 updates phrasing extends openapi/birdeye-user-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 6

$.info

$.paths['/v1/user/signup/v2'].post

$.paths['/v1/user/updateUser'].put

$.paths['/v1/user/remove'].delete

$.paths['/v1/user/forgotpassword'].post

$.paths['/v1/user/details'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Birdeye User API
  version: 1.0.0
extends: openapi/birdeye-user-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: 5
- target: $.paths['/v1/user/signup/v2'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a user
      effect: write
      questions:
      - Can I add a new user with a role and send them an invite?
      - What's required to create a user account?
      instructions:
      - text: Create user {userEmailId} with role {userRole}.
        slots:
          userEmailId: requestBody.userEmailId
          userRole: requestBody.userRole
      - text: Invite {firstName} {lastName} at {userEmailId} as {userRole}.
        slots:
          firstName: requestBody.firstName
          lastName: requestBody.lastName
          userEmailId: requestBody.userEmailId
          userRole: requestBody.userRole
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/user/updateUser'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a user's role and access
      effect: write
      questions:
      - Can I change a user's role or which locations they can access?
      - Can I give a user enterprise-level access to all locations?
      instructions:
      - text: Update user {userEmailId} to role {userRole}, enterprise access {entUser}.
        slots:
          userEmailId: query.userEmailId
          userRole: requestBody.userRole
          entUser: query.entUser
      - text: Grant {userEmailId} access to locations {locationsNumberAccess}, entUser {entUser}.
        slots:
          userEmailId: query.userEmailId
          locationsNumberAccess: requestBody.locationsNumberAccess
          entUser: query.entUser
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/user/remove'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a user's access to a business
      effect: destructive
      questions:
      - Can I revoke a user's access to a business?
      - Is there a way to remove someone who left the team?
      instructions:
      - text: Remove user {email} from business {bid}.
        slots:
          email: query.email
          bid: query.bid
      - text: Revoke {email}'s access to {bid}.
        slots:
          email: query.email
          bid: query.bid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/user/forgotpassword'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a password reset
      effect: write
      questions:
      - Can I trigger a password reset for a user?
      - What do I need to start the forgot-password flow?
      instructions:
      - text: Start a password reset for {email}.
        slots:
          email: query.email
      - text: Trigger forgot-password for user {email}.
        slots:
          email: query.email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/user/details'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's details
      effect: read
      questions:
      - What role and access does a given user have?
      - Can I look up a user's details by email?
      instructions:
      - text: Get details of user {email}.
        slots:
          email: query.email
      - text: Look up the user account for {email}.
        slots:
          email: query.email
      method: generated
      generated: '2026-09-26'