AI Applyd · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Aiapplyd Locations API

5 actions 5 updates phrasing extends openapi/aiapplyd-locations-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for AI Applyd's API. It is a proposal applied on top of the contract, not a document AI Applyd publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/locations/search'].get

$.paths['/locations/popular'].get

$.paths['/locations/countries'].get

$.paths['/locations/initial-suggestions'].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 Aiapplyd Locations API
  version: 1.0.0
extends: openapi/aiapplyd-locations-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: 4
- target: $.paths['/locations/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search cities and places by name
      effect: read
      questions:
      - Which cities match what I type into the location box?
      - Can I search for a city like Lisbon to add as a preferred location?
      instructions:
      - text: Search locations named {q}.
        slots:
          q: query.q
      - text: Find up to {limit} places matching {q}.
        slots:
          limit: query.limit
          q: query.q
      method: generated
      generated: '2026-09-26'
- target: $.paths['/locations/popular'].get
  update:
    x-apievangelist-phrasing:
      intent: Browse popular cities by population
      effect: read
      questions:
      - What are the biggest cities I can browse when picking locations?
      - Can I list the most populous cities within a single country?
      instructions:
      - text: List the most popular cities in country {countryCode}.
        slots:
          countryCode: query.countryCode
      - text: Show the next {limit} popular cities after {cursor}.
        slots:
          limit: query.limit
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/locations/countries'].get
  update:
    x-apievangelist-phrasing:
      intent: Browse countries ranked by population
      effect: read
      questions:
      - Which countries can I pick from before drilling into cities?
      - How are countries ordered in the location browser?
      instructions:
      - text: List countries by total city population.
      - text: Show the next {limit} countries after {cursor}.
        slots:
          limit: query.limit
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/locations/initial-suggestions'].get
  update:
    x-apievangelist-phrasing:
      intent: Get starter location suggestions
      effect: read
      questions:
      - Can the location picker guess my country before I type anything?
      - What locations are suggested by default in an empty location field?
      instructions:
      - text: Give me initial location suggestions based on my country.
      - text: Show the default location picks for an empty search box.
      method: generated
      generated: '2026-09-26'