# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Platform REST Business Locations API
  version: 1.0.0
extends: openapi/vendasta-business-locations-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: 6
- target: $.paths['/businessLocations'].get
  update:
    x-apievangelist-phrasing:
      intent: List business locations
      effect: read
      questions:
      - Which business locations belong to my partner account?
      - Can I search locations by name or return only certain fields?
      instructions:
      - text: List business locations for partner {partner}.
        slots:
          partner: query.filter[businessPartner.id]
      - text: Search partner {partner}'s locations for {term}.
        slots:
          partner: query.filter[businessPartner.id]
          term: query.filter[searchTerm]
      - text: List locations for {partner} sorted by {sort}.
        slots:
          partner: query.filter[businessPartner.id]
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/businessLocations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a business location
      effect: write
      questions:
      - How do I add a new business location under my partner?
      - What must be filled in to create a business location?
      instructions:
      - text: Create a business location from {data}.
        slots:
          data: requestBody.data
      - text: Add a new business location with the name and partner I provide.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/businessLocations'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods on the locations list
      effect: read
      questions:
      - Which HTTP verbs does the business locations collection accept for CORS?
      - What does a preflight on the location list endpoint return?
      instructions:
      - text: Send a CORS preflight to the business locations list.
      - text: Show allowed methods for the business location collection endpoint.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/businessLocations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a business location
      effect: read
      questions:
      - What basic data is stored for one business location?
      - Can I get a location using the newer category format?
      instructions:
      - text: Get business location {id}.
        slots:
          id: path.id
      - text: Show business location {id} with only fields {fields}.
        slots:
          id: path.id
          fields: query.fields[businessLocations]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/businessLocations/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a business location
      effect: write
      questions:
      - Can I change a location's details without resending every field?
      - What happens to location fields I leave out of an update?
      instructions:
      - text: Update business location {id} with {data}.
        slots:
          id: path.id
          data: requestBody.data
      - text: Edit the details of location {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/businessLocations/{id}'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods on a single location
      effect: read
      questions:
      - Which HTTP verbs are allowed on one business location resource?
      - What does a CORS preflight on a specific location return?
      instructions:
      - text: Run a CORS preflight against business location {id}.
        slots:
          id: path.id
      - text: Show which methods location endpoint {id} allows.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'