Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ATS Subpackage Applications API

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

$.info
$.paths['/ats/v1/applications'].get
$.paths['/ats/v1/applications'].post
$.paths['/ats/v1/applications/{id}'].get
$.paths['/ats/v1/applications/{id}/change-stage'].post
$.paths['/ats/v1/applications/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 Applications API
  version: 1.0.0
extends: openapi/merge-subpackage-applications-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: 5
- target: $.paths['/ats/v1/applications'].get
  update:
    x-apievangelist-phrasing:
      intent: List job applications
      effect: read
      questions:
      - Which applications has a given candidate submitted?
      - Can I list applications for one job that are at a particular stage?
      - What applications were rejected for a specific reason?
      instructions:
      - text: List applications for candidate {candidate_id}.
        slots:
          candidate_id: query.candidate_id
      - text: Show applications to job {job_id} currently at stage {current_stage_id}.
        slots:
          job_id: query.job_id
          current_stage_id: query.current_stage_id
      - text: Find applications from source {source}.
        slots:
          source: query.source
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/applications'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a job application
      effect: write
      questions:
      - How do I apply a candidate to a job in the ATS?
      - Does creating an application also create the candidate if they're new?
      instructions:
      - text: Create application {model} as recruiter {remote_user_id}.
        slots:
          model: requestBody.model
          remote_user_id: requestBody.remote_user_id
      - text: Submit a new job application with {model}, acting as {remote_user_id}.
        slots:
          model: requestBody.model
          remote_user_id: requestBody.remote_user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/applications/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a job application
      effect: read
      questions:
      - What stage is a particular application at?
      - Can I see one application with its candidate and job expanded?
      instructions:
      - text: Get application {id}.
        slots:
          id: path.id
      - text: Fetch application {id} expanding {expand}.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/applications/{id}/change-stage'].post
  update:
    x-apievangelist-phrasing:
      intent: Move an application to another interview stage
      effect: write
      questions:
      - How do I advance a candidate's application to the next interview stage?
      - Can I change an application's stage on behalf of a recruiter?
      instructions:
      - text: Move application {id} to stage {job_interview_stage}.
        slots:
          id: path.id
          job_interview_stage: requestBody.job_interview_stage
      - text: Advance application {id} to {job_interview_stage} as user {remote_user_id}.
        slots:
          id: path.id
          job_interview_stage: requestBody.job_interview_stage
          remote_user_id: requestBody.remote_user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/applications/meta/post'].get
  update:
    x-apievangelist-phrasing:
      intent: See which fields a new application needs
      effect: read
      questions:
      - What fields are required to create an application in this ATS?
      - Can I get application creation fields for a specific remote template?
      instructions:
      - text: Get application creation metadata for template {application_remote_template_id}.
        slots:
          application_remote_template_id: query.application_remote_template_id
      - text: Show the fields needed to submit an application.
      method: generated
      generated: '2026-09-26'