Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ATS Subpackage Jobs API

4 actions 4 updates phrasing extends openapi/merge-subpackage-jobs-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 4

$.info
$.paths['/ats/v1/jobs'].get
$.paths['/ats/v1/jobs/{id}'].get
$.paths['/ats/v1/jobs/{job_id}/screening-questions'].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 Jobs API
  version: 1.0.0
extends: openapi/merge-subpackage-jobs-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: 3
- target: $.paths['/ats/v1/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List jobs
      effect: read
      questions:
      - Which job openings are currently open in the ATS?
      - Can I list jobs for a particular office?
      - How do I find a job by its requisition code?
      instructions:
      - text: List jobs with status {status}.
        slots:
          status: query.status
      - text: Show jobs at offices {offices}.
        slots:
          offices: query.offices
      - text: Find the job with code {code}.
        slots:
          code: query.code
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/jobs/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a job
      effect: read
      questions:
      - What departments, offices and hiring managers are on a given job?
      - Can I retrieve one requisition with related objects expanded?
      instructions:
      - text: Get job {id}.
        slots:
          id: path.id
      - text: Fetch job {id} expanding {expand}.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/jobs/{job_id}/screening-questions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a job's screening questions
      effect: read
      questions:
      - What screening questions do applicants to a job have to answer?
      - Can I get the application questions attached to one opening?
      instructions:
      - text: List screening questions for job {job_id}.
        slots:
          job_id: path.job_id
      - text: Show the applicant questions on opening {job_id}.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-09-26'