# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Bindbee Candidates API
  version: 1.0.0
extends: openapi/bindbee-candidates-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: 2
- target: $.paths['/ats/candidates'].get
  update:
    x-apievangelist-phrasing:
      intent: List candidates, optionally for one job
      effect: read
      questions:
      - Which candidates are in the connected ATS for a particular job?
      - Can I get a simple candidate list from the short /ats/candidates route?
      instructions:
      - text: List candidates for job {job_id}.
        slots:
          job_id: query.job_id
      - text: List all candidates from the connected ATS.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/candidates/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single candidate record
      effect: read
      questions:
      - What does one candidate record look like from the ATS?
      - Can I look up a candidate by id on the short candidates route?
      instructions:
      - text: Get candidate record {id}.
        slots:
          id: path.id
      - text: Look up candidate {id} in the connected ATS.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'