Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ATS Subpackage Offers API

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

$.info
$.paths['/ats/v1/offers'].get
$.paths['/ats/v1/offers/{id}'].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 Offers API
  version: 1.0.0
extends: openapi/merge-subpackage-offers-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/v1/offers'].get
  update:
    x-apievangelist-phrasing:
      intent: List job offers
      effect: read
      questions:
      - Can I see all offers extended for a particular job application?
      - Which offers are still pending or were rejected?
      instructions:
      - text: List offers for application {application_id}.
        slots:
          application_id: query.application_id
      - text: Show offers with status {status}.
        slots:
          status: query.status
      - text: List offers created by {creator_id}.
        slots:
          creator_id: query.creator_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/offers/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a job offer
      effect: read
      questions:
      - When was a specific offer sent and what's its current status?
      - Can I expand the application on a single offer?
      instructions:
      - text: Get offer {id}.
        slots:
          id: path.id
      - text: Fetch offer {id} with {expand} expanded.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-09-26'