Birdeye · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Birdeye Google Services API

7 actions 7 updates phrasing extends openapi/birdeye-google-services-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 7

$.info
$.paths['/v1/google-services/service/create'].post
$.paths['/v1/google-services/services'].post
$.paths['/v1/google-services/service/update'].post
$.paths['/v1/google-services/service/delete'].post
$.paths['/v1/google-services/service/location-mapping'].get
$.paths['/v1/google-services/services/location-mapping'].post

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 Google Services API
  version: 1.0.0
extends: openapi/birdeye-google-services-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['/v1/google-services/service/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a service offering
      effect: write
      questions:
      - Can I add a service with a price and duration to my Google profile?
      - Can new services be grouped and priced in a currency?
      instructions:
      - text: Create service {name} priced {price} for account {businessId}.
        slots:
          name: requestBody.name
          price: requestBody.price
          businessId: query.businessId
      - text: Add service {name} in group {group} lasting {duration} to {businessId}.
        slots:
          name: requestBody.name
          group: requestBody.group
          duration: requestBody.duration
          businessId: query.businessId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/google-services/services'].post
  update:
    x-apievangelist-phrasing:
      intent: List service offerings
      effect: read
      questions:
      - Which services are listed on my Google profile?
      - Can I sort services by name or price?
      instructions:
      - text: List services for {businessId} from {startIndex}, page {pageSize}, sorted by {sortBy} {sortOrder}.
        slots:
          businessId: query.businessId
          startIndex: query.startIndex
          pageSize: query.pageSize
          sortBy: query.sortBy
          sortOrder: query.sortOrder
      - text: Search services for {search} on {businessId}, starting {startIndex}, {pageSize} per page, by {sortBy} {sortOrder}.
        slots:
          search: requestBody.search
          businessId: query.businessId
          startIndex: query.startIndex
          pageSize: query.pageSize
          sortBy: query.sortBy
          sortOrder: query.sortOrder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/google-services/service/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a service offering
      effect: write
      questions:
      - Can I change the price or description of an existing service?
      - Can I rename a service I already created?
      instructions:
      - text: Update service {serviceId} name to {name} for {businessId}.
        slots:
          serviceId: requestBody.serviceId
          name: requestBody.name
          businessId: query.businessId
      - text: Set service {serviceId} ({name}) price to {price} on {businessId}.
        slots:
          serviceId: requestBody.serviceId
          name: requestBody.name
          price: requestBody.price
          businessId: query.businessId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/google-services/service/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete service offerings
      effect: destructive
      questions:
      - Can I delete several services at once?
      - Is there a way to remove services I no longer offer?
      instructions:
      - text: Delete services {serviceIds} from {businessId}.
        slots:
          serviceIds: requestBody.serviceIds
          businessId: query.businessId
      - text: Remove service entries {serviceIds} for account {businessId}.
        slots:
          serviceIds: requestBody.serviceIds
          businessId: query.businessId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/google-services/service/location-mapping'].get
  update:
    x-apievangelist-phrasing:
      intent: Get service-to-category location mapping
      effect: read
      questions:
      - Which services are mapped to which categories across my locations?
      - Can I see the current service location mapping?
      instructions:
      - text: Get the service location mapping for {businessId}.
        slots:
          businessId: query.businessId
      - text: Show how services map to categories for {businessId}.
        slots:
          businessId: query.businessId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/google-services/services/location-mapping'].post
  update:
    x-apievangelist-phrasing:
      intent: Map a service to a category
      effect: write
      questions:
      - Can I map a service to a category across all locations?
      - Will changing a service's category mapping affect every location?
      instructions:
      - text: Map service {service_id} to category {category_name} for {businessId}.
        slots:
          service_id: requestBody.service_id
          category_name: requestBody.category_name
          businessId: query.businessId
      - text: Update the category mapping of service {service_id} to {category_name} across locations of {businessId}.
        slots:
          service_id: requestBody.service_id
          category_name: requestBody.category_name
          businessId: query.businessId
      method: generated
      generated: '2026-09-26'