# 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 Countries API
  version: 1.0.0
extends: openapi/vendasta-countries-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: 8
- target: $.paths['/countries'].get
  update:
    x-apievangelist-phrasing:
      intent: List countries
      effect: read
      questions:
      - Which countries does Vendasta support for addresses?
      - Can I get country names in another language?
      instructions:
      - text: List all countries.
      - text: List countries in language {lang}, {limit} at a time.
        slots:
          lang: header.Accept-Language
          limit: query.page[limit]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/countries'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods on the countries list
      effect: read
      questions:
      - Which HTTP verbs does the countries collection allow for CORS?
      - What does a preflight on the country list endpoint return?
      instructions:
      - text: Send a CORS preflight to the countries list.
      - text: Show allowed methods for the country collection endpoint.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/countries/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a country
      effect: read
      questions:
      - How can I look up one country by its ID?
      - What details come back for a single country?
      instructions:
      - text: Get country {id}.
        slots:
          id: path.id
      - text: Show country {id} with its name in {lang}.
        slots:
          id: path.id
          lang: header.Accept-Language
      method: generated
      generated: '2026-10-01'
- target: $.paths['/countries/{id}'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods on a single country
      effect: read
      questions:
      - Which HTTP verbs are allowed on one country resource?
      - What does a CORS preflight on a specific country return?
      instructions:
      - text: Run a CORS preflight against country {id}.
        slots:
          id: path.id
      - text: Show which methods the single-country endpoint {id} allows.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/countryRegions'].get
  update:
    x-apievangelist-phrasing:
      intent: List states or provinces in a country
      effect: read
      questions:
      - What states or provinces are available for a given country?
      - Why does a country return no regions at all?
      instructions:
      - text: List the regions in country {code}.
        slots:
          code: query.filter[countryCode]
      - text: Show states and provinces for {code} in {lang}.
        slots:
          code: query.filter[countryCode]
          lang: header.Accept-Language
      method: generated
      generated: '2026-10-01'
- target: $.paths['/countryRegions'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods on country regions
      effect: read
      questions:
      - Which HTTP verbs does the country regions list accept for CORS?
      - What does a preflight on the regions collection return?
      instructions:
      - text: Send a CORS preflight to the country regions list.
      - text: Show allowed methods for the region collection endpoint.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/countryRegions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a state or province
      effect: read
      questions:
      - Can I get the name of one state or province by its ID?
      - What does a single country region record include?
      instructions:
      - text: Get country region {id}.
        slots:
          id: path.id
      - text: Show the name of region {id} in {lang}.
        slots:
          id: path.id
          lang: header.Accept-Language
      method: generated
      generated: '2026-10-01'
- target: $.paths['/countryRegions/{id}'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods on a single region
      effect: read
      questions:
      - Which HTTP verbs does a single state or province endpoint permit?
      - What does a CORS preflight on a specific state or province return?
      instructions:
      - text: Preflight the state-or-province endpoint for region {id}.
        slots:
          id: path.id
      - text: Show which methods region endpoint {id} allows.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'