# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Vendasta Citations API
  version: 1.0.0
extends: openapi/vendasta-citations-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: 3
- target: $.paths['/v1/listings/get-citation-data'].post
  update:
    x-apievangelist-phrasing:
      intent: Get citation data for a business over a period
      effect: read
      questions:
      - Where is my business cited online between two dates?
      - Can I pull citation data for a business ID in a date range?
      instructions:
      - text: Get citation data for business {business} from {start} to {end}.
        slots:
          business: requestBody.businessId
          start: requestBody.startDate
          end: requestBody.endDate
      - text: Pull the citations found for {business} using the v1 listings service.
        slots:
          business: requestBody.businessId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/citations'].get
  update:
    x-apievangelist-phrasing:
      intent: List a location's citations, newest first
      effect: read
      questions:
      - Which citations have been found for my business location, most recent first?
      - Can I page through a location's citations?
      instructions:
      - text: List citations for business location {location}.
        slots:
          location: query.filter[businessLocation.id]
      - text: Show the latest {limit} citations found for location {location}.
        slots:
          limit: query.page[limit]
          location: query.filter[businessLocation.id]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/citations'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods on citations
      effect: read
      questions:
      - Which HTTP verbs does the citations endpoint allow for CORS?
      - What does a preflight on the citations list return?
      instructions:
      - text: Send a CORS preflight to the citations endpoint.
      - text: Show allowed methods for the citation collection.
      method: generated
      generated: '2026-10-01'