Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ATS Subpackage Interviews API

5 actions 5 updates phrasing extends openapi/merge-subpackage-interviews-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Merge's API. It is a proposal applied on top of the contract, not a document Merge publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/ats/v1/interviews'].get
$.paths['/ats/v1/interviews'].post
$.paths['/ats/v1/interviews/{id}'].get
$.paths['/ats/v1/interviews/meta/post'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for ATS Subpackage Interviews API
  version: 1.0.0
extends: openapi/merge-subpackage-interviews-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/ats/v1/interviews'].get
  update:
    x-apievangelist-phrasing:
      intent: List scheduled interviews
      effect: read
      questions:
      - Can I see every interview scheduled for a particular job application?
      - Which interviews is a specific interviewer organizing?
      - Can I filter interviews by job or interview stage?
      instructions:
      - text: List interviews for application {application_id}.
        slots:
          application_id: query.application_id
      - text: Show interviews organized by {organizer_id}.
        slots:
          organizer_id: query.organizer_id
      - text: List interviews for job {job_id} in stage {job_interview_stage_id}.
        slots:
          job_id: query.job_id
          job_interview_stage_id: query.job_interview_stage_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/interviews'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule an interview
      effect: write
      questions:
      - How do I schedule a candidate interview in a customer's ATS?
      - When I schedule a new interview, which ATS user is recorded as its creator?
      instructions:
      - text: Schedule interview {model} as ATS user {remote_user_id}.
        slots:
          model: requestBody.model
          remote_user_id: requestBody.remote_user_id
      - text: Book a candidate interview with details {model} on behalf of {remote_user_id}.
        slots:
          model: requestBody.model
          remote_user_id: requestBody.remote_user_id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/ats/v1/interviews/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a scheduled interview
      effect: read
      questions:
      - When and where is a specific interview happening, and who's on the panel?
      - Can I expand the application and interviewers on one scheduled interview?
      instructions:
      - text: Get scheduled interview {id}.
        slots:
          id: path.id
      - text: Fetch interview {id} with {expand} expanded.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/interviews/meta/post'].get
  update:
    x-apievangelist-phrasing:
      intent: Get fields for scheduling interviews
      effect: read
      questions:
      - Which fields does an ATS require when scheduling an interview?
      - What can I set on a new scheduled interview?
      instructions:
      - text: Show interview POST metadata for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Describe the create fields for scheduled interviews.
      method: generated
      generated: '2026-09-26'